1. App Builder User's Guide
  2. Adding Navigation
  3. Creating Breadcrumbs
  4. Creating a Breadcrumb Manually

14.3.3 Creating a Breadcrumb Manually

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

Parent topic: Creating Breadcrumbs

14.3.3.1 About Creating Breadcrumbs Manually

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

The following summarizes the steps needed to create breadcrumbs manually:

  1. Create the breadcrumb.
    1. You can create a breadcrumb in two ways:

      • From Shared Components.

      • From Page Designer.

    2. In the Create Breadcrumb dialog, enter a name for the new breadcrumb and click Create.
  2. Add entries to the breadcrumb.
  3. Add the breadcrumb to a page by creating a breadcrumb region.

Parent topic: Creating a Breadcrumb Manually

14.3.3.2 Creating Breadcrumbs from Page Designer

Create a breadcrumb and breadcrumb entries from Page Designer.

Once you create a named breadcrumb, you can then add breadcrumb entries. The breadcrumb name provides a way to name a collection of breadcrumb entries.

To manually create a breadcrumb from 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. Create the breadcrumb:
    1. In the left pane of Page Designer, click the Page Shared Components tab.
    2. Right-click Breadcrumb and select Create.
      The Create Breadcrumb dialog appears.
    3. Breadcrumb Name - Enter a name for this new breadcrumb. Once you create a named breadcrumb, you can then add breadcrumb entries.
    4. Click Create.
    The Edit Breadcrumb page appears displaying the breadcrumb in the left pane.
  3. Next, create a breadcrumb entry. Click Create Entry.
    Breadcrumb Entry appears.
  4. Under Breadcrumb Entry:
    1. Page - Select the page where this breadcrumb entry displays.
    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. Sequence - Indicate the order in which breadcrumb entries appear. The sequence determines the order of evaluation.
    4. Short Name - Identify the short name of this breadcrumb entry. Both the short and long names can be referenced from the breadcrumb template.
    5. Synchronize page name and title - Enable this option to update the corresponding Page Name and Title with breadcrumb short name.
    6. Long Name - Identify the long name of this breadcrumb entry. Both the short and long names can be referenced from the breadcrumb template.
  5. Under Target, specify the target location. For the Target is a attribute, select either:
    • Page in this Application
    • URL
    The UI changes depending upon what you select.
  6. If the target is a page in the application:
    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. If the target is a URL:
    1. Target is a - Select URL.
    2. URL Target - Identify URL to go to when the breadcrumb entry is clicked..
  8. 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 expressions in the fields provided.
  9. 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.
  10. For Configuration - Optionally select a build option for this component. Build options are predefined settings that determine whether or not components within an application are enabled.
  11. Click Create Entry.
    The Edit Breadcrumb page appears. A new entry appears under the breadcrumb in the left pane.
  12. Create another breadcrumb entry:
    1. Click New Entry.
      The Breadcrumb Entry appears under the breadcrumb in the left pane.
    2. Starting at step 4, repeat previous steps for each breadcrumb entry you want to create.

Next, add the breadcrumb to a page by creating a region.

Parent topic: Creating a Breadcrumb Manually

14.3.3.3 Creating Breadcrumbs from Shared Components

Create a breadcrumb and breadcrumb entries in Shared Components.

Once you create a named breadcrumb, you can then add breadcrumb entries. The breadcrumb name provides a way to name a collection of breadcrumb entries.

To manually create a breadcrumb from Shared Components:

  1. Navigate to the Breadcrumbs page:
    1. On the Workspace home page, click App Builder.
    2. Select the application.
    3. Click Shared Components.
    4. Under Navigation, click Breadcrumbs.
    The Breadcrumbs page appears.
  2. Create the breadcrumb:
    1. Click Create Breadcrumb.
    2. In the Create Breadcrumb dialog:
      The Create Breadcrumb dialog appears.
    3. Breadcrumb Name - Enter a name for this new breadcrumb. Once you create a named breadcrumb, you can then add breadcrumb entries.
    4. Click Create.
    The Edit Breadcrumb page appears displaying the breadcrumb in the left pane.
  3. Next, create a breadcrumb entry. Click New Entry.
    Breadcrumb Entry appears.
  4. Under Breadcrumb Entry:
    1. Page - Select the page where this breadcrumb entry displays.
    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. Sequence - Indicate the order in which breadcrumb entries appear. The sequence determines the order of evaluation.
    4. Short Name - Identify the short name of this breadcrumb entry. Both the short and long names can be referenced from the breadcrumb template.
    5. Synchronize page name and title - Enable this option to update the corresponding Page Name and Title with breadcrumb short name.
    6. Long Name - Identify the long name of this breadcrumb entry. Both the short and long names can be referenced from the breadcrumb template.
  5. Under Target, specify the target location. For the Target is a attribute, select either:
    • Page in this Application
    • URL
    The UI changes depending upon what you select.
  6. If the target is a page in the application:
    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. If the target is a URL:
    1. Target is a - Select URL.
    2. URL Target - Identify URL to go to when the breadcrumb entry is clicked..
  8. 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 expressions in the fields provided.
  9. 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.
  10. For Configuration - Optionally select a build option for this component. Build options are predefined settings that determine whether or not components within an application are enabled.
  11. Click Create Entry.
    The Edit Breadcrumb page appears. A new entry appears under the breadcrumb in the left pane.
  12. Create another breadcrumb entry:
    1. Click New Entry.
      The Breadcrumb Entry appears under the breadcrumb in the left pane.
    2. Starting at step 4, repeat previous steps for each breadcrumb entry you want to create.

Next, add the breadcrumb to a page by creating a region.

Parent topic: Creating a Breadcrumb Manually

14.3.3.4 Adding a Breadcrumb Region with a Wizard

Add a breadcrumb region from the Gallery.

Before creating a breadcrumb region, create the breadcrumb. The wizard will propmt you to create breadcrumb entry if one has not yet been defined.

To create a breadcrumb region with a wizard:

  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 such as Breadcrumb.
    2. Region Template - Select a region template.
      For the Universal Theme, the application breadcrumb has a special location for placement. Oracle recommends using Title Bar 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. If no Breadcrumb Entry has been created, the wizard prompts you to create one. 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.

Parent topic: Creating a Breadcrumb Manually

14.3.3.5 Adding a Breadcrumb Region from the Gallery

Add a breadcrumb region from the Gallery.

Before creating a breadcrumb region, Oracle recommends creating the breadcrumb and adding breadcrumb entries.

To create a breadcrumb region from the Gallery:

  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. From the Gallery at the bottom of the page:
    1. 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 to be added to the 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.
      For the Universal Theme, the application breadcrumb has a special location for placement. Oracle recommends using Title Bar region template.
    6. Appearance, Render Components - Select if the region components display above or below the main region content.
  4. Click Save.

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

Parent topic: Creating a Breadcrumb Manually

14.3.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 Oracle APEX 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.

Parent topic: Creating a Breadcrumb Manually