A list is a shared collection of links. You control the appearance of a list through list templates. Each list element has a display condition which enables you to control when it displays. You can define a list element to be either current or non current for a specific page. You further specify what current looks like using template attributes. You add a list to a page by creating a region and specifying the region type as List.
Topics:
To add a list to a page in your application you must:
Add items to the list.
Add the list to a page by creating a List region.
To create a list from the Shared Components page:
Navigate to the Workspace home page.
Click the Application Builder icon.
Select an application.
On the Applications home page, click Shared Components.
Under Navigation, select Lists.
The Lists page appears.
To create a new list, click Create.
In the fields provided:
Enter a name for the list.
Select a list template.
If applicable, select a build option for this component. Build options are predefined settings that determine whether or not components within an application are enabled.
Click Create.
To create a list from a Page Definition:
Navigate to the appropriate Page Definition:
Navigate to the Workspace home page.
Click the Application Builder icon.
Select an application.
Select a page.
The Page Definition appears.
Under Shared Components, scroll down to Lists and click the Create icon.
In the fields provided:
Enter a name for the list.
Select a list template.
If applicable, select a build option for this component. Build options are predefined settings that determine whether or not components within an application are enabled.
Click Create.
Once your list has been created, you need to add entries to it.
You can create hierarchical lists that contain sublists. To create a hierarchical list, you must:
Select a list template that supports hierarchical lists. To determine which list templates support hierarchical lists, look for templates having the naming convention "with Sublist."
Select a Parent List Item when you create each list entry.
To add an entry to a list:
Navigate to the Lists page.
Select a list.
Click Create List Entry.
The Create / Edit List Entry page appears.
Under Label and Sequence:
Parent List Item - Identify the parent for this list entry. Use this attribute if you are creating a hierarchical list that will contain a sublist.
Sequence - Indicate the order in which list entries appear.
Image - Identify the file name for the image used to display this list entry. Control over this attribute is provided by list templates.
Image Attributes - Identify the image attributes (such as width="12" height="12") for the list element image.
Use the #LIST_LABEL#
substitution string to reference the list label text. This substitution string allows for the title image attribute to be automatically set based on the value of the list label text. For example:
title="#LIST_LABEL#"
List Entry Label (required) - Enter the label text for this link (required).
Specify a target location.
If the target location is a page:
From Target Type, select Page in this Application.
In Page, specify the target page ID.
To reset pagination for this page, select reset pagination for this page.
In Request, specify the request to be used.
In Clear Cache, specify the pages (that is, the page IDs) on which to clear cache. Specify multiple pages by listing the page IDs in a comma-delimited list.
You can set session state (that is, give a listed item a value) using the next two attributes:
To set session state:
In Set these items, enter a comma-delimited list of item names for which you would like to set session state.
In With these values, enter a comma-delimited list of values for the items specified in the previous step.
You can specify static values, or substitution syntax (for example, &APP_ITEM_NAME.
). Note that item values passed to f?p=
in the URL may not contain a colon (:). Additionally, item values may not contain commas unless you enclose the entire value in backslash characters (for example, \1234,56\
).
If the target location is a URL:
From Target type, select URL.
In URL Target, type a URL.
Under Current List Entry Identification:
List Entry Current for Pages Type - Specify when this list entry should be current based on the page type.
List items can be current or non-current. Current list items use the current template, non current list items use the non current list item template. The actual condition and templates are defined in subsequent attributes.
List Entry Current for Condition - Based on the selection above, define a condition to evaluate. When this condition is true then the list item becomes current.
To make the list entry conditional:
Make a selection from the Condition Type list.
Enter an expression in the fields provided.
When you are finished defining list attributes, click Create or Create and Create Another.
Once you created a list, the next step is to add it a page by creating a region and specifying the region type as List.
To add a list to a page:
Navigate to the appropriate Page Definition:
Navigate to the Workspace home page.
Click the Application Builder icon.
Select an application.
Select a page.
The Page Definition appears.
Under Regions, click the Create icon.
Select List as the region type.
Specify the following display attributes:
Title - Enter a title for the region. This title will display if the region template you choose displays the region title.
Region Template - Choose a template to control the look of the region.
Display Point - Identify a display point for this region.
Two types of display points exist: page template positions and page body positions. Page template positions are controlled by page template substitution strings (#REGION_POSITION_01#..#REGION_POSITION_08#). Page template positions allow for exact placement of a region within a page template. Page body positions are displayed where the #BODY# substitution string in the page template indicates.
Sequence - Specify the sequence for this component. The sequence determines the order of evaluation.
Column - Indicate the column in which this region is to be displayed. A page can have multiple regions, these regions can be displayed in different columns. Please note that this attribute only applies to regions that are displayed in a Page Template Body position.
From List, select the list you want to add.
Click Create List Region.
Repeat these procedures for each page on which you would like to add a list.
Once you create a list you can edit it on the Lists page.
To edit a list:
Navigate to the Lists page.
From the Page Definition:
Navigate to the Workspace home page.
Click the Application Builder icon.
Select an application.
Select a page.
Under Shared Components, select the title Lists.
From the Shared Components page:
Navigate to the Workspace home page.
Click the Application Builder icon.
Select an application.
On the Applications home page, click Shared Components.
Under Navigation, select Lists.
The Lists page appears.
You can change the appearance of the page by making a selection from the View list. Available options include:
Icons (the default) displays each list as a large icon. To edit a list, click the appropriate icon.
Details displays each list as a line in a report. To edit a list, click the list name.
You can edit multiple list entries at once by clicking Grid Edit on the List Entries page.
To edit multiple list entries at once:
Navigate to the Workspace home page.
Click the Application Builder icon.
Select an application.
On the Application Builder home page, click Shared Components.
Under Navigation, select Lists.
The Lists page appears.
Select a list name.
The List Entries page appears.
Click Grid Edit.
Edit the appropriate items and click Apply Changes.
You can view the List Utilization by Page, Unused Lists, and List History reports by clicking the appropriate tab at the top of the Lists page.
Note: The List Utilization, Unused Lists, and History buttons only appear after you create a list. |