Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

About Navigation rules

Updated on November 15, 2021
Applicable to Theme UI-Kit applications

Use a Navigation rule to construct a multi-level XML document to be used in navigation and context menus.

The following tabs are available on this form:

If the Pega-Mobile RuleSet is present in your application, the Type field appears on the New form. For an application that runs on a mobile device, specify Mobile in the Type field so that mobile-specific features and menu options are available during development of your navigation rule.

> Access

Use the Application Explorer to the access navigation rules that apply to the work types in your application. Use the Records Explorer to list all of the navigation rules available to you.

> Where referenced

Sections using the MenuBar control rule and Grid, Tree, or Tree-Grid layouts can reference navigation rules. See these Pega Community articles:

  • How to create context menus for grid layouts using navigation rules.
  • How to configure a menubar in a user portal using navigation rules

> Category

Navigation rules are part of the User Interface category. A navigation rule is an instance of the Rule-Navigation rule type.

You can view the generated Java code of a rule by clicking ActionsView Java. You can use this code to debug your application or to examine how rules are implemented.

  • Hierarchy rules

    A hierarchy rule defines relationships among text values. Each rule can define an entire hierarchy, or a branch (subtree) of a larger hierarchy.

  • Viewing test coverage reports

    View a report that contains the results of test coverage sessions to determine which rules in your application are not covered with tests. You can improve the quality of your application by creating tests for all uncovered rules that are indicated in the reports.

  • Navigation rules
  • Navigation form - Completing the Editor tab

    Use the Editor tab to specify the structure of the navigation defined for this navigation rule. Navigation is built as a hierarchy of nodes. Each node in the navigation rule represents an option that is presented within the user interfaces that include this navigation structure (for example, as a menu bar in an end user portal).

  • Navigation form - Completing the Pages and Classes tab

    Identify what is known about the class of each page that is referenced on the Node Editor tab. See How to Complete a Pages & Classes tab for basic instructions.

  • Navigation rule - Completing the Node Details Action tab

    On the Action tab, specify the action to be performed when the node is selected at run-time; for example, when a user clicks a menu item. This tab displays when Item, Item List or Selected Item are selected in the Type list on the Node Details dialog.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us