14.2.3 Creating a Breadcrumb Manually

Create a breadcrumb while creating a new page, as a Shared Component, using the Create Breadcrumb Wizard, adding a breadcrumb region in Page Designer. Add breadcrumb entries from Shared Components.

• About Creating a Breadcrumb Manually
  Create a breadcrumb manually by creating the breadcrumb, adding breadcrumb entries, and then adding the breadcrumb to a page by creating a region.
• Creating Breadcrumbs from Shared Components
  Create a breadcrumb on the Breadcrumbs page accessible from Shared Components.
• Creating a Breadcrumb Region in Page Designer
  Creating a breadcrumb region manually in Page Designer by running the Create Breadcrumb Wizard.
• Add a Breadcrumb to a Page by Creating a Region
  After you create a breadcrumb, you add it to a page by creating a breadcrumb region.
• Adding Entries to a Breadcrumb
  Add breadcrumb entries from Shared Components.
• About Creating Dynamic Breadcrumbs
  

14.2.3.1 About Creating a Breadcrumb Manually

Create a breadcrumb manually by creating the breadcrumb, adding breadcrumb entries, and then adding the breadcrumb to a page by creating a region.

To create breadcrumbs manually, you add a breadcrumb to each page in your application as follows:

1. Create the breadcrumb by running the Create Breadcrumb Wizard. You can access this wizard in two ways:
   • Go to the Shared Component page and select Create Breadcrumb.
   • In Page Designer, select the Create menu and then Breadcrumb Region.
2. Add entries to the breadcrumb.
3. Add the breadcrumb to a page by creating a region.

14.2.3.2 Creating Breadcrumbs from Shared Components

Create a breadcrumb on the Breadcrumbs page accessible from Shared Components.

To create breadcrumbs from the Shared Components page:

1. On the Workspace home page, click the App Builder icon.
2. Select an application.
3. On the Application home page, click Shared Components.
4. Under Navigation, click Breadcrumbs.
   The Breadcrumbs page appears.
5. Click Create Breadcrumb.
6. Enter a name and click Create.
7. Add breadcrumb entries.

See Also:

"Adding Entries to a Breadcrumb."

14.2.3.3 Creating a Breadcrumb Region in Page Designer

Creating a breadcrumb region manually in Page Designer by running the Create Breadcrumb Wizard.

The Create Breadcrumb Wizard creates the breadcrumb region and breadcrumb entry.

To create a breadcrumb region in Page Designer:

1. View the page in Page Designer.
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Select a page.
   Page Designer appears.
2. On Page Designer Toolbar at the top of the page, click the Create menu and select Breadcrumb Region.
   The Create Breadcrumb Wizard appears.
3. For Region Attributes:
   1. Region Title - Enter a title for the region.
   2. Region Template - Select a region template.
   3. Display Point - Identify the display point.
   4. Sequence - Specify the sequence for this component. The sequence determines the order of evaluation.
   5. Click Next.
4. For Breadcrumb:
   1. Breadcrumb - Select the Breadcrumb to be associated with this region.
   2. Breadcrumb Template - Identify breadcrumb template.
   3. Click Next.
5. For Breadcrumb Entry:
   1. Breadcrumb Entry Label - Specify the label for this breadcrumb entry.
   2. Parent Entry - Select this breadcrumb entry's hierarchical parent..
   3. Click Next.
6. Confirm your selections and click Finish.

14.2.3.4 Add a Breadcrumb to a Page by Creating a Region

After you create a breadcrumb, you add it to a page by creating a breadcrumb region.

To add a breadcrumb region to a page:

1. View the page in Page Designer:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Select a page.
   Page Designer appears.

   Note:

   Note the Gallery at the bottom of the page. Pass the cursor over a control or component to view a tooltip that describes it.

2. Create breadcrumb region from the Gallery:
   1. In the Gallery, click the Regions tab.
   2. Right-click Breadcrumb.
   3. Select Add To and then select the appropriate location such as Breadcrumb Bar.

   Tip:

   You can also select the Breadcrumb region in the Gallery and drag it to the appropriate location in the Layout tab.

   Page Designer indicates what actions are required next. If there is an error, a Messages icon displays next to the Save button. Click the Messages icon to view a dialog listing all the errors. Select an error to highlight the associated attribute in the Property Editor.

3. In the Property Editor, edit the following Region attributes:

   Tip:

   To learn more about an attribute, select the attribute in the Property Editor and click the Help tab in the center pane.

   1. Identification, Title - Enter a region title. The region title only displays when it is defined in the region template.
   2. Source, Breadcrumb - Select the breadcrumb list associated with this page.
   3. Layout, Sequence - Enter the display sequence for this item. The sequence and other layout settings determine where this item is displayed in relation to other items within the region.
   4. Layout, Position - Select the template position used to display this region. The selections available are derived from the appropriate template positions defined within the current theme, for the page's user interface.
   5. Appearance, Template - Select a region template to define the appearance and layout of this region. To learn more, click the Help tab in the central pane.
   6. Appearance, Item Display Position - Specify where page items display in relation to the main region content.
4. Click Save.

Repeat these procedures for each page where you would like to add breadcrumb navigation.

14.2.3.5 Adding Entries to a Breadcrumb

Add breadcrumb entries from Shared Components.

To add entries to a breadcrumb:

1. Navigate to the Breadcrumbs page:
   1. Navigate to the Workspace home page.
   2. Click the App Builder icon.
   3. Select an application.
   4. Click Shared Components.
   5. Under Navigation, click Breadcrumbs.

      The Breadcrumbs page appears.

2. Select a breadcrumb to which to add entries.
3. Click Create Breadcrumb Entry.
4. Under Breadcrumb, select the page where this breadcrumb entry displays.
5. Under Entry:
   1. Sequence - Indicate the order in which breadcrumb entries appear. The sequence determines the order of evaluation.
   2. Parent Entry - Identify the parent of this entry. Any given breadcrumb should have only one root node, identified as an item with no parent ID.
   3. Short Name - Identify the short name of this breadcrumb entry. Both the short and long names can be referenced from the breadcrumb template.
   4. Long Name - Identify the long name of this breadcrumb entry. Both the short and long names can be referenced from the breadcrumb template.
6. Under Target, specify the target location:
   1. Target is a - Select Page in this Application.
   2. Page - Specify the target page number.

      To reset pagination for that page, select reset pagination for this page.

   3. Request - Enter text for which you would like to set the built-in application item called REQUEST. This is also the item that is set with the name of a button that was clicked.
   4. Clear Cache - Enter the page numbers (separated by commas) for those pages for which you would like to clear the user's session state.
   5. To set session state (that is, give a listed item a value):

      • Set these items - Enter the list of application item names (separated by commas) for which you would like to set the session state (give the listed item a value).

      • With these values - Enter a comma delimited list of values for the items specified in Set these items. You can specify static values or substitution syntax (for example, &APP_ITEM_NAME.).

      You can specify static values or substitution syntax (for example, &APP_ITEM_NAME.). Note that item values passed to f?p= in the URL cannot contain a colon. Additionally, item values cannot contain commas unless you enclose the entire value in backslashes (for example, \1234,56\).

7. For Conditions:
   1. Condition Type - Select a condition type from the list. This condition must be met in order for this component to be rendered or processed.
   2. Enter an expression in the fields provided.
8. For Authorization, optionally select an authorization scheme. This authorization scheme must evaluate to TRUE in order for this component to be rendered or otherwise processed.
9. For Configuration, select a build option for this component. Build options are predefined settings that determine whether or not components within an application are enabled.
10. Click Create Breadcrumb Entry.

Repeat these procedures for each breadcrumb entry you create.

14.2.3.6 About Creating Dynamic Breadcrumbs

To give users more exact context, you can include session state in breadcrumbs, making your breadcrumbs dynamic. For example, suppose a page in your application displays a list of orders for a particular company and you want to include the following breadcrumb:

Home > Orders > Orders for ACME Inc

In this example, ACME Inc not only indicates the page a user is on but also the navigation path. The Application Express engine stores the value of ACME Inc. in session state.

To create this type of dynamic menu, you must include a reference to a session state item in the breadcrumb's short name or long name. For example:

&COMPANY_NAME.