Skip to main content


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

Navigation rule — Completing the Node Details Action tab

Updated on April 5, 2022

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.

Click the Add an action icon to specify an action associated with the node. This opens the Behavior dialog, which contains a column for the Event, Action, and a diamond-shaped condition icon. Conditions do not apply to actions; they apply to the entire node.

To define the node's behavior, click the Add Row icon. Your choices populate the grid row. After you have completed the dialog, click OK to apply your edits and close the dialog.

Caution: If you define more than one click event for a node, the actions are executed from the top down as displayed in the list; the inherited actions (the ones in the rule) execute first. All processing effects of an action in the list will complete before the next action starts. For example, assume a Display > Set Value action is followed by a Launch > Local Action. When the user clicks the button, the Set Value action also triggers a Post Value action (set in a the Behavior field on a Cell Properties panel) and recalculation of an expression. After all processing is completed, the system starts Local Action.
Action CategoryMobile Action Name
Process Work Show Flow Location

Add New Work (from New or Create harness)

Finish Assignment (from Perform harness)

Cancel

Save

Get Work Create Work

Open Assignment

Open Work by Handle

DisplayRefresh section
Launch Harness- Target value of Pop-up Window or New Document is supported.

Local Action - Target value of Modal Dialog or Overlay are supported. Using Page is supported.

Advanced Run Activity

Run Data Transform

Run Script

Note: If the navigation rule is Type Mobile, a subset of the actions is available. Actions that appear for a Mobile application arn this table and indicated in the sections below.

Mobile applications support one action per node. Only the first action is executed. Any additional defined actions are ignored.

Certain actions (such as Create Work, Open Assignment, Launch Harness, and Run Script) that display user interface features do not run on a phone device when specified on a node with children. These actions require that the main navigation and content panels appear simultaneously which is not possible on a phone. Therefore, as a best practice, implement these actions on child nodes. If placed on a parent node, they should be optional actions, not critical to work item processing.

Run Activity and Run Data Transform can be run on a node that has children.

> Process Work

> Add New Work

FieldDescription
Action Add New Work. Adds a new work item using the primary page data. Saves the new work item on the deferred list. See Controls form Completing the Controls tab for a full description of this action.

> Perform Action

FieldDescription
Action Perform Action. Submits the flow action and completes the assignment if either is true:
  • The specified flow action and the current flow action have the same interface (reference the same named section).
  • The flow action does not use HTML to render the interface (an autogenerated action where No HTML is selected on form's HTML tab).
  • Otherwise, clicking the control renders the flow action form only.
  • Flow Action — Select the Name key part of a flow action.
Flow ActionSelect the Name key part of a flow action.

> Show Flow Location

FieldDescription
Action Show Flow Location. Appears only when the navigation rule is Type Mobile. Implements the Where-Am-I? feature, so users can view the work object location in a flow.

> View Attachments

FieldDescription
Action View Attachments. Presents a list of work item attachments, so users can view or add attachments. The button is visible only for users who hold the Work-.AccessAuditTrail privilege. See Controls form Completing the Controls tab for a full description of this action.

> View History

FieldDescription
Action View History. Displays the work item history, for users who hold the Work-.AccessAuditTrail privilege.

> Get Work

> Create Work

FieldDescription
Action Create Work. Appears when the navigation rule is Type Mobile or Standard. Creates a new covered or non-covered work item. Called with a primary page that inherits from the Work- base class. Commits the new work item if there is no flow execution to start; if it starts a flow execution, the commit operation typically occurs when that flow execution creates an assignment.
Class NameSelect the class that contains the flow you wish to start.
Flow NameSelect the flow to start when this node is selected.

> Get Next Work

FieldDescription
ActionGet Next Work. Returns the next assignment for the operator to work on. This assignment can either come from the operator's worklist or from one of the work queues they have access to.

> Open Assignment

FieldDescription
Action Open Assignment. Appears when the navigation rule is Type Mobile or Standard. Returns the next assignment for the operator to work on. This assignment can either come from the operator's worklist or from one of the work queues they have access to.
KeyEnter the key of the assignment you wish to open.

> Open Work by Handle

FieldDescription
Action Open Work by Handle. Appears when the navigation rule is Type Mobile or Standard. Opens work based upon the internal key that uniquely identifies the instance.
HandleSpecify the handle of a work item, beginning with the class name.

> Open Work Item

FieldDescription
ActionOpen Work Item. Opens work based upon the work item ID. Specify the full ID of the work item.
IDSpecify the full ID of the work item.

> Handle List Items

Use these actions only when acting upon repeating layouts.

> Add Child

FieldDescription
ActionAdd Child. Adds a child item beneath the selected row or branch or in a repeating grid or tree.

> Add Item

FieldDescription
ActionAdd Item. Adds (above or below) a row to a layout.
PositionSelect Above or Below.

> Delete Item

FieldDescription
ActionDelete Item. Deletes a row in a layout.

> Edit Item

FieldDescription
Action Enables edit of the selected item in the layout. Not available if the repeating layout Edit Mode is Read Only.

> Open Local Action

FieldDescription
ActionOpen Local Action. Displays the flow action you specify.
Flow ActionFlow Action — Select the flow action that will be invoked.
After Action Select Refresh Current Item (recommended ) to refresh only the current row after the flow action has ended. In most cases, leave this selection (default).

Select Refresh All Items to refresh the entire layout.

> Open Selected Item

FieldDescription
ActionOpen Selected Item. Opens the item selected in the layout.

> Refresh List

FieldDescription
ActionRefreshes the content of the repeating grid or tree based on data in the clipboard. Maintains the current page, filter, or sort.

> Set Focus

FieldDescription
Action Set Focus. Sets the cursor focus to the Current Item, Next Item, or Previous Item in the repeating layout.

If you want to set focus from within a row in a repeating grid to another grid or to an editable control outside of the current grid, select Set Focus in the Display category and provide the full path to the property, beginning with the parent page, and represent it on the Pages & Classes tab of the layout containing the repeating grid.

> Display

> Refresh Section

FieldDescription
ActionRefresh Section. Commits the contents of the section that contains the button or another section that you specify.
Target Select the section to be refreshed as a result of clicking the item. Select either This Section to refresh the current section or select Other Section to refresh a specified section.
Using Page Available when Other Section is selected for the Target field. Optional. Specify the page and class of the section to be refreshed.
Section Available when Other Section is selected for the Target field. Select the section to be refreshed.
Data Transform Optional. Enter a Name key part of a data transform. See Data Transforms.

Parameters listed on the Data Transform form's Parameters tab appear beneath this field. Optionally, enter the values you want pass to the data transform.

Activity Optional. Select an activity to run before refreshing the section. If the activity uses parameters, enter their values. This activity is processed after a data transform.

Parameters listed on the Activity rule form's Parameters tab appear beneath the field. Optionally, enter the values you want pass to the activity.

> Set Value

FieldDescription
ActionSet Value. Sets a target property to the source value. You can configure multiple properties and values. The source property can be editable or read-only.
Property Enter a property reference (target).

For Value List, Value Group, Page List, and Page Group properties, enter a literal, property reference or symbolic index value (subscripts):

.myList(15)

.myGroup("Massachusetts")

If you want to set a value from within a row in a repeating grid to an editable control outside of the grid, provide the full path to the property, beginning with the parent page, and represent it on the Pages & Classes tab of the layout containing the repeating grid.

Value Enter a property reference or a literal constant (source).

Click the Add Row icon to define more properties and values.

> Set Focus

FieldDescription
ActionSet Focus. Sets the cursor focus to an editable control that is bound to a property or to a specific row in a grid, tree, or tree grid.
Target Enter a property reference.

.propertyName

If you specify a Page List or Page Group property, additional fields display, enabling you to set Focus On the First Row, Last Row, or to a specific index position within a grid, tree, or tree grid.

To set focus to an index position, select Other in the Focus On field and then use a constant or property reference:

.PageList.propertyName .PageList(15)

If you want to set focus from within a row in a repeating grid to an editable control outside of the grid, provide the full path to the property, beginning with the parent page, and represent it on the Pages & Classes tab of the layout containing the repeating grid.

> Launch

> Flow in Modal Dialog

FieldDescription
Action Flow in Modal Dialog. Allows a user to start a flow in a user form and run the process in a modal dialog. The user cannot continue work in the main user form until the modal dialog closes. See Controls form Completing the Controls tab for a full description of this action.
Using Page Optional. By default, the flow runs on the primary page pyWorkPage. If you want to run the flow in the context of an included section that is using either an embedded page (such as .pyWorkParty(Originator) or another top-level page, enter a Page or Page List name defined on the section's Page & Classes tab.

Parameters listed on the Flow rule form's Parameters tab appear beneath this field. Optionally, specify values to pass to the flow.

Flow NameEnter the second key part of a flow rule.

> Harness

FieldDescription
Action Harness. Appears when the navigation rule is Type Mobile or Standard. Replaces an open harness or displays a new one.
Target Specify the target location where the specified harness displays as a result of clicking the item. Select:
  • Pop-Up Window — Displays the harness in a new browser window.
  • Replace Current — Replaces the current tab or dynamic container contents with the specified harness, with the option to save (submit) the current data before the new harness is displayed.
  • New Document — Opens the specified harness with the option to display in a named tab.
Tab Name Available for Replace Current and New Document targets. Specify the tab to be replaced. If this value matches the name of an open tab, the new harness replaces the tab. Otherwise, the new harness appears in a new tab.
Class Available for a New Document target. Specify the class of the harness.
HarnessSelect the harness to display.
Read Only Select Yes if you want the harness contents to appear in read-only mode. (For a Pop-Up Window target, if set to No you must enter a window name.)
Submit Current Available for a target of Replace Current. Select Yes to specify that the current contents is saved before the harness replaces it.
Window Name Available if Pop-Up Window is selected for the Target. Enter a name that the system uses to identify a browser window. If a window of that name is open, the new harness replaces the contents of that window. Otherwise, the system opens a new browser window and displays the harness in that window.
Window Width Available if Pop-Up Window is selected for the Target. Enter a positive integer to set the window width in pixels. If you leave this and the Window Height field blank, the system replicates the dimensions of the current window.
Window Height Available if Pop-Up Window is selected for the Target. Enter a positive integer to set the window height in pixels. If you leave this and the Window Width field blank, the system replicates the dimensions of the current window.
Key Optional. Available for a New Document target. Specify the key value ( pxInsName ) of a data instance you want automatically opened as the new primary page when the harness is displayed. The system uses this value and the Class value to identify the data record. This action executes before a pre-activity (if one is defined).
Data Transform Optional. Enter a Name key part of a data transform. See Data Transforms.

Parameters listed on the Data Transform form's Parameters tab appear beneath the field. Optionally enter the values you want pass to the data transform.

Activity Optional. Specify an activity to run before displaying the harness. If the activity uses parameters, enter their values. This activity is processed after a data transform.

Parameters listed on the Activity rule form's Parameters tab appear beneath the field. Optionally, enter the values you want pass to the activity.

> Landing Page

The Landing Page choice is only applicable in portals defined with the Developer role (for example the Developer or BusinessAnalyst portal rules). The Open Landing Page choice does not apply when the navigation rule is used in portals defined with the User role. See Keystores.

FieldDescription
Action Choose Display to open a landing page for display, or CreateNewWork to create a new work item based on a landing page.
NameEnter a unique name for the landing page. Attempting to open a landing page while a landing page with the same Name value is open will result in the new landing page overriding the tab in which the already open landing page was displayed.
Class
  • For Action set to Display : Select the class on which the harness for the landing page is based.
  • For Action set to CreateNewWork : Select the class on which the flow runs to create the work item is based.
Harness Name Applicable when Action is set to Display : Select the harness that the landing page is built on.
Data Transform Applicable when Action is set to Display : Select the data transform used to generate initial values for the landing page.
Page Applicable when Action is set to Display : Specify an existing page.
Read Only Applicable when Action is set to Display : Select to display a read-only harness.
Flow Name Applicable when Action is set to CreateNewWork : Specify the name of the flow used to create new work.
Level AEnter a value to work with a when condition defined to open the selected item in a specified tab on the landing page.
Level BEnter a value to work with a when condition defined to open the selected item in a specified tab on the landing page.
Level CEnter a value to work with a when condition defined to open the selected item in a specified tab on the landing page.
> Parameters
NameSpecify additional parameters to pass to the harness or flow.
ValueSpecify additional parameter values to pass to the harness or flow.

> List View

FieldDescription
ActionOpen List. Opens a list view.
ClassSelect the class of a list view to be opened.
PurposeRequired. Select the Purpose (second key-part) of the list view to be opened from the menu.
Action Choose Refresh, Redisplay, or Sort.
HeaderSelect to display the list view header.
> Parameters
NameSpecify additional parameters to pass to the list view.
ValueSpecify additional parameter values to pass to the list view.

> Local Action

FieldDescription
Action Local Action. For harnesses only. Allows the user to complete a local action or local and connector flow actions in a modal window or in an action section ( .pyActionArea ).
Using PageEnter a page from the Pages & Classes tab to use when invoking the local action.
Local ActionSelect the flow action to be triggered.
Open in Modal Dialog Optionally, select Open in Modal Dialog to present the local action window as a modal window, which appears in front of all other windows and must be completed (or closed) before the user can perform any other process.

Select this when the local action accepts one or more input fields

Launch local action is for local or local and connector flow actions, and it can load the local action in modal or in the action area.

Perform action is similar but it is more for flow actions and it advances the flow when the flow action has no UI. The is more related to work items where as the local action can be on any data instances as well.

> Open URL in Window

FieldDescription
ActionOpen URL In Window
Use Alternate Domain Select to specify an alternate domain for the URL to open. When selected, select a URL in the Alternate Domain URL field.

Use the Querystring section to specify the name and value of a query string for the alternate domain URL.

Use Primary PageSelect to call an activity based on the contents of the primary page when this node is selected.
Data Transform Optional. Enter a Name key part of a data transform. See Data Transforms.

Parameters listed on the Data Transform form's Parameters tab appear beneath this field. Optionally, enter the values you want pass to the data transform.

Activity Select an activity to return an HTML stream that will be shown in the opened window.

Parameters listed on the Activity rule form's Parameters tab appear beneath the field. Optionally, enter the values you want pass to the activity.

> Window Properties
Window NameSpecify a text string to define the name of the opened window.
Replace HistorySelect to erase the history of the opened browser window.
HeightEnter a numeric value to represent the height in pixels of the opened window.
WidthEnter a numeric value to represent the width in pixels of the opened window.
TopEnter a numeric value to represent the offset in pixels from the top of the screen.
LeftEnter a numeric value to represent the offset in pixels from the left of the screen.
ResizableSelect to enable the opened window to be resized.
ScrollbarsSelect to enable scrollbars in the opened window.
Location BarSelect to enable the location bar in the opened window.
Menu BarSelect to enable the browser's menu bar in the opened window.
Status BarSelect to enable the browser's status bar in the opened window.
Tool BarSelect to enable the browser's tool bar in the opened window.

> Report Definition

FieldDescription
ActionReport Definition. Executes the retrieval and sorting operations, but not the formatting and display processing, of a report definition.
ClassSelect the class for the Report Definition.
NameSelect the name of the Report Definition.

> Wizard

FieldDescription
ActionWizard. Launch a wizard based on the key part label and class.
Class Select the class of the wizard. This class name will begin with PegaAccel-.
Wizard LabelSpecify a label for the wizard.
> Parameters
NameSpecify additional parameters to pass to the wizard.
ValueSpecify additional parameter values to pass to the wizard.

> Advanced

> Open Rule

FieldDescription
Action Open Rule. Opens a rule that takes the pzInsKey value as its parameter.
Handle Select a pzInsKey key value in the rule you want to open.
Resolved By Select Name, Handle, or Handle By Condition to specify how the rule is located.
Handle Condition Applicable for Handle By Condition : Select a when condition to define when a rule should be resolved by handle.

> Open Rule By Name

FieldDescription
ActionOpen Rule By Name.
Rule TypeSelect the class in which the rule is saved.
Instance NameRequired. Select the name of the rule you wish to open.

> Open Rule By Keys

FieldDescription
ActionOpen Rule By Keys. Opens a rule by its class and the class key values.
Rule Type ClassSpecify the class that has keys defined.
KeyRead only, based on the keys defined on the class rule form for the class selected in the Class field.
ValueEnter the key value that pertains to the rule you wish to open.

> Run Activity

FieldDescription
Action Run Activity. Appears when the navigation rule is Type Mobile or Standard. Runs the activity you specify in the Activity field.
Activity Required. Enter the Activity Name key part of the activity.

Parameters listed on the Activity rule form's Parameters tab appear beneath this field. Optionally, enter values you want pass to the activity.

Parameters

> Run Data Transform

FieldDescription
Action Run Data Transform. Appears when the navigation rule is Type Mobile or Standard. Runs the data transform you specify.
Page Select Auto to keep the primary page context. Select Other to use another page context.
Name Appears if you select Other on the Page field. Enter the page name.
Data TransformEnter the Name key part. Parameters listed on the Data Transform form's Parameters tab appear beneath the field. Enter the values you want pass to the data transform.
Parameters

> Run Script

FieldDescription
Action Run Script. Appears when the navigation rule is Type Mobile or Standard. Calls a custom JavaScript function or the Pega Platform API. See Controls form Completing the Controls tab for a full description of this action.
Function Enter the clipboard property or literal reference that contains the function you wish to run.

For a Mobile application, enter the name of a JavaScript function in quotes.

> Parameters
NameSpecify additional parameters to pass to the script function.
ValueSpecify additional parameter values to pass to the script function.
About Navigation rules

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us