Available UI actions
Pega Platform provides a wide variety of out-of-the-box behavior patterns (actions) that you can use to make a UI component more responsive and user-friendly.
The UI actions are divided into several categories which depend on their typical use case and main functionality:
Display actions
Display actions open a UI component in a target space.
| Action | Description |
| Apply conditions | Evaluates conditions on the client, based on a keyboard event. The action evaluates all conditions that use Run on client, such as Visible when and Refresh when. |
| Close | Closes an overlay. |
| Expand/collapse | Causes a layout to expand or collapse. You can use the action to make a layout collapsible, or on a control, such as a button, to collapse other collapsible layouts in the harness. |
| Home | Opens the Home tab in an AJAX container. |
| Menu | Displays the contents of a navigation rule as a menu. The top-level menu is displayed in a column below the control. Second and lower levels expand to the right. When you use this action, the menu generates its contents each time that the system requests them. This approach eliminates on-load processing and ensures that the items are always up-to-date. |
| Mobile search | Opens the native search capacity in a mobile app. For more information, see Configuring a search action in a mobile app. |
| Post value | Posts a property value to the clipboard and refreshes the
contents of the cell. Post value is triggered by the Change or
OnBlur events of the field before users initiate any other event
(such as a Click action) from a control, or from the calculation of
expressions. For example, a pxButton control refreshes another section by using an activity that requires three updated properties before the control can update the target section. When the user clicks the button, the action posts the properties to the clipboard and synchronizes with the activity. |
| Starts browser-based printing, which prints the current user form. | |
| Refresh | Refreshes the target that the action parameters specify. By default, changes are submitted before refreshing. |
| Refresh row | Refreshes a row in a table. You configure this action on an element outside of the table. |
| Section | Opens a specific section in a target container. |
| Set focus | Sets the focus on an editable control that is bound to a property
or to a specific row in a table, tree, or tree table. For example, if a section or layout becomes visible on a click of a button, you can set focus on an editable control in the section that is now visible. |
| Set style | Applies a selected inline style or CSS class to a UI element. |
| Set 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. |
| Show smart info | Displays a SmartInfo pop-up window. The contents of the pop-up window are determined by a section that you specify, and are presented in read-only mode. |
| Show smart tip | Adds a smart tip to a UI element when you pair this action with a Click or Hover event. |
| Spell check | Invokes the spell checker. This tool determines which dictionaries to apply, how to operate the spellchecking algorithm, and other details. |
Process Work actions
Process work actions relate to how users handle cases, forms, and work items.
| Action | Description |
| Add new work | Adds a new work item that uses the primary page data. Saves the new work item on the deferred list. |
| Cancel | Closes the current form without applying any changes. |
| Contents | For a cover work item, changes the form so that users can view and navigate to member work items. You can override a standard list view rule to control the details of this display. |
| Enable action section | Presents a user form in review-only mode. |
| Explore | For a folder work item, changes the form so that users can view and navigate among the associated work items. |
| Finish assignment | Submits changes and marks the assignment as complete. |
| Perform action | Submits a flow action and completes the assignment if either of
the following conditions are met:
|
| Review | Presents the user form or flow action form in review-only mode. |
| Save | Saves the work item. |
| Show flow location | Marks the location of the current assignment with an arrow. |
| Show reopen screen | Shows the form in review mode but provides users with the tools to reopen a resolved work item if they hold the Work-.Reopen privilege. Runs the standard activity Work-.Reopen or an activity of that name in your application. |
| Update | Reconstructs the form in update mode, for users who hold the
Work-.Update privilege. The user can change
previously provided values in sections other than the
Take Action section that is presented by
the flow action. The Apply button on the update form sends changed user input to the server, but does not commit these changes. Users must select and complete a flow action to cause these changes to save. |
| View attachments | Presents a list of work item attachments so that users can view or add attachments. |
| View history | Displays the work item history for users who hold the Work-.AccessAuditTrail privilege. |
Launch actions
Launch actions open content or functionalities that can help users achieve their business goals.
| Action | Description |
| Flow in modal dialog | Provides users with an option to start a flow in a user form and
run the process in a modal dialog box. The user cannot continue work
in the main user form until the modal dialog box closes. When the user starts a modal flow, that flow runs on its own thread on the primary page of the harness that contains the control. When the user submits the modal flow's final assignment, the flow page merges into the parent flow primary page. The following actions then occur:
|
| Get directions | Launches the Google Maps service that displays a route between two locations that you provide in the action. |
| Harness | Replaces the open harness or displays a new one. |
| Mobile view | Opens a native mobile component, such as a native mobile list, in the interface. |
| Landing page | Performs one of the following actions:
You can also specify additional parameters and corresponding values to pass to the harness or flow. |
| Local action | Loads the Local or Local and connector flow action, and presents
the action as a modal dialog box, overlay, or in an action section.
For a sample configuration, see Configuring a modal dialog box for a button. |
| Open URL in window | Opens a URL in a browser window by using an activity that returns an HTML stream. |
| Report definition | Executes the retrieval and sorting operations, but not the formatting and display processing, of a report definition. |
| Scan barcode/QR code | Opens a bar code or QR code scanner on a mobile device. |
| Wizard label | Launches a wizard based on key part label and the class of the wizard (the class name begins with PegaAccel- ). |
Get Work actions
Get work actions cover operations that are related to work items and assignments.
| Action | Description |
| Create work | Creates a new work item. This action is called with a primary page that inherits from the Work- base class. Create work commits the new work item if no flow run exists. If the action starts a flow run, the commit operation occurs when that flow run creates an assignment. |
| Get next work | Returns the next assignment for the operator to complete. This assignment can either come from the operator worklist or from one of the work queues to which they have access. |
| Open assignment | Opens an assignment that is based on its key value pxAssignmentKey. |
| Open work by handle | Opens a work item that is based on the internal key that uniquely identifies the instance. |
| Open work item | Opens a work item that is based on the work item ID. |
| Re-open work item | Reopens a resolved work item for users who hold the Work-.Reopen privilege. Runs the standard activity Work-.Reopen or an activity of that name in your application. |
List category actions
List category actions manage list handling in repeating layouts.
| Action | Description |
| Add child | Adds a child item beneath the selected row or branch in a repeating layout or tree. |
| Add item | Adds a row to a layout, above or below the current row. |
| Delete item | Deletes a row in a layout. |
| Edit item | Enables editing of the selected item in the layout. The action is is not available if the repeating layout edit mode is set to read-only. |
| Open local action | Displays the flow action that you specify. |
| Open selected item | Opens the item that is selected in the layout. |
| Refresh current row | Refreshes the content of the active row in the active grid. |
| Refresh list | Refreshes the content of the repeating grid or tree based on the clipboard data. Maintains the current page, filter, or setting. |
| Set focus | Sets the cursor focus on the Current Item, Next Item, or Previous Item in the repeating layout. |
Other actions
Other actions include miscellaneous operations.
| Action | Description |
| Invoke action | Defines a clipboard page that contains the action that you want
to perform when the specified events occurs. When the event occurs,
the clipboard page is passed into the action and the action is
performed. The following actions are supported:
|
| Log off | Logs the user out of the system. |
| Manage guided tour | Configures a control to start, continue, or dismiss a guided tour. |
| Open rule | Opens a rule that takes the pzInsKey value as its parameter. |
| Open rule by keys | Opens a rule by its class and the class key values. You specify a class that has keys defined. You select values for the keys that are specified on the Class rule form, on the General tab. |
| Open rule by name | Opens a rule based on the rule type (a specific class that is derived from the Rule- base class) and a Property Name key part. |
| Run activity | Runs the activity that you specify in the Activity field. You enter the Activity key part. |
| Run data transform | Runs the data transform that you specify. For more information, see Data transforms. |
| Run script | Calls a custom JavaScript function or a Pega Platform API. You can add custom JS methods to the application by attaching the file with the script to the harness. For more information, see Adding scripts and style sheets to a harness. |
Subscribe action
The Subscribe action becomes available when you select On load as the event for an action set.
You use the Subscribe action to subscribe to a notification channel for your user. Notification channels provide a way to notify the client about changes on the server without having to explicitly refresh the application in the browser. When subscribed to a channel, your user receives a notification when an event is published on that channel. You can specify the filter criteria for the channel, so that the user receives only relevant notifications.
For more information, see Creating UI subscription channels.
Previous topic Adding action sets to a layout Next topic Styling your application with design systems