Available actions and conditions
Applicable to Theme UI-Kit applications
Choose an action from the list, see which options are available for the action and when you can use it. Learn which conditions you can apply.
Click Add another action to display an action menu. By default, the menu displays the most common actions. Click All actions to see the full list of actions organized into the following categories:
|Apply conditions||Evaluates conditions on the client, based on a Keyboard event. All conditions with Run On Client enabled, such as Visible When and Refresh When, are evaluated.|
|Close||Provides an explicit close action for an overlay. To configure an overlay, specify the Overlay. The overlay closes automatically when the user clicks outside of the overlay.as an|
|Menu||Displays the contents of a navigation rule as a menu. The
top-level menu appears in a column below the control. Second and
lower levels expand to the right.
When using this action, the menu contents are generated each time they are requested. This eliminates on-load processing and ensures that the items are always up-to-date. As a best practice, use the Menu action for complex menus (such as the Actions link in a flow action) and in repeating layouts.
|Post value||Posts the property value to the clipboard and refreshes the
cell's contents. Post value is triggered by
|Starts browser-based printing, which prints the current user form as displayed. This printout may not include desired fields and may use colors, fonts, and labels that are not desired in hard copy prints.|
|Refresh|| Refreshes the target specified in the action parameters. By
default, changes are submitted before refreshing.
|Refresh row||Select this option to refresh a row in a grid by configuring this
action on an element outside of the grid.
|Set focus||Sets the focus to an editable control that is bound to a property
or to a specific row in a table, tree, or tree table.
|Set value||Sets a target property to the source value. You can configure
multiple properties and values. The source property can be editable
|Show smart info||This option is displayed when the UI element is
Icon or Link, and
the Event is Hover.
When you select this option, a SmartInfo pop-up is displayed. The
contents of the pop-up are determined by a section that you specify,
and are presented in read-only mode.
|Show smart tip||This option is displayed for a UI element when the
Event is Click or
Hover. When you select this option, a
smart tip is displayed in an overlay. At run time, the smart tip is
visible until the application user hovers or clicks away from the
element. To display a smart tip with a header, select
Specify the Header Source, if applicable, and the Tip Source (the body of the smart tip) as one of the following: Message, Property, Field value, or Plain text.
Format — Select the format for the smart tip. You can style smart tips and create additional smart tip formats in the skin rule.
|Spell check||Use this option to invoke the spellchecker. This tool determines which dictionaries to apply, how to operate the spellchecking algorithm, and other details.|
|Add new work||Adds a new work item using 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 to allow users to view and navigate among the member work items. You can override a standard list view rule to control details of this display.|
|Enable action section||Presents the user form in review-only mode; inputs area allowed in the action section only.|
|Explore||For a folder work item, changes the form to allow users to view and navigate among the associated work items.|
|Finish assignment||Submits changes and marks this assignment as complete.|
|Perform action||Submits the flow action and completes the assignment if either of
the following is true:
For Flow Action, select the Name key part of a flow action.
|Review||Presents the user form or flow action form in review-only mode; no updates are allowed.|
|Save||Saves the work item with Submit.|
|Show flow location||Known as the Where-Am-I? icon, which marks the location of the current assignment with an arrow. Requires the Work-.Perform privilege.|
|Show reopen screen||Shows the form in review mode but allows users 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||Redraws the form in update mode, for users who hold the
Work-.Update privilege. This allows changes
to previously input values that appear in sections other than the
Take Action section that is presented by
the flow action. This capability is not desirable in all
applications, as it allows users to overwrite values that were
entered previously, perhaps by other users.
The Apply button on the update form sends changed user inputs 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. The button is visible only for users who hold the Work-.AccessAuditTrail privilege.|
|View history||Displays the work item history, for users who hold the Work-.AccessAuditTrail privilege.|
|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. You can place this control in
all standard harnesses inheriting from Work-,
Data- or Embed-. The modal
flow must be available from the class of the section containing the
Flow in modal dialog is only supported with default locking, not with optimistic locking.
When the user starts a modal flow, it runs on its own thread on the primary page of the harness containing the control.
When the user submits the modal flow's final assignment, the flow's page merges into the parent flow primary page. The following then occurs:
Specify the following:
Use auto-generated controls within modal dialogs. This ensures accurate server processing if a modal dialog is launched from a list or grid of work items configured with actions. An action on a work item in a list is created in a temporary work processing thread. Auto-generated controls default to this temporary thread. However, non-auto-generated controls may default to use the thread of the base document for AJAX interactions, instead of the temporary thread. Using auto-generated controls ensures accurate server processing.
More on modal flows:
|Harness||Replaces an open harness or displays a new one.
You can also specify additional parameters and corresponding values to pass to the harness or flow.
|List view||Opens a list view. Specify the class of a list view, the Purpose key part. Select Refresh, Redisplay, or Sort. Select the Header check box to display the list view header.|
|Local action||Loads the local or local & connector flow action and presents
it as a modal dialog, overlay, or in an action section. In the
Local action field, select the local action. In the Target
field, select to present the local action as one of the following:
Although similar to local actions, you use Perform actions to advance the flow in those flow actions that do not have a user interface.
If you are using local actions in offline-enabled applications, see also Supported actions when working offline.
If this control is located in a repeating grid row (from a button or icon, for example), then you should click the All actions link and select . Local action does not operate normally in the repeating grid environment.
|Open URL in window||Using an activity that returns an HTML stream, opens a URL in a
|Report definition||Executes the retrieval and sorting operations, but not the
formatting and display processing, of a report definition.
Target — Define where the system will render the specified report.
|Wizard||Launch a wizard based on key part Label
and the class of the wizard (class name begins with
All actions in the Get work section require a target destination:
- Default — Sets the default container as the target.
- Dynamic container — Sets a dynamic container as the target.
- Ajax Container — Sets an Ajax container as the
target. If no Ajax container exists, the action runs in a dynamic container.
If no dynamic container exists, the action runs in a new browser window.
- Default — Runs action in the primary Ajax container.
- Secondary — Runs action in the secondary Ajax container.
- Tertiary — Runs action in the tertiary Ajax container.
|Create work||Creates a new covered or non-covered work item. This action is
called with a primary page that inherits from the
|Get next work||Returns the next assignment for the operator to complete. This assignment can either come from the operator's 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 work that is based on the internal key that uniquely identifies the instance.|
|Open work item||Opens work 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.|
Use these actions for repeating layouts, only.
|Add child||Adds a child item beneath the selected row or branch or in a repeating grid 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. Not available if the repeating layout Edit Mode is set to Read Only.|
|Open local action||Displays the flow action that you specify.
Use auto-generated controls if you plan to configure actions on a list of work items. An action on a work item in a list is created in a temporary work processing thread. Auto-generated controls default to this temporary thread. However, non-auto-generated controls may default to use the thread of the base document for AJAX interactions, instead of the temporary thread. Using auto-generated controls ensures accurate server processing.
|Open selected item||Opens the item selected in the layout.|
|Refresh current row||Refreshes the content of the active row in the active
Disable submit on refresh — Select if you do not want to submit edited data to the clipboard. For example, you may want to use this option to reset the row by populating it with data from the clipboard, without submitting data that the user entered.
|Refresh list||Refreshes the content of the repeating grid or tree based on data in the clipboard. Maintains the current page, filter, or sort.|
|Set focus||Sets the cursor focus to the
You can use
Set focus with Keyboard events to
enable users to navigate within a repeating grid using the Up
and Down arrow keys. For example, configure the
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
|Invoke action||Select to specify 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. This is supported for the following actions:
|Log off||Log out of the system.|
|Manage guided tour||Configures a control to start, continue, or dismiss a guided
|Open rule||Opens a rule that takes the pzInsKey value as
|Open rule by keys||Opens a rule by its class and the class key values. Specify the class that has keys defined. Select values for the Keys specified on the Class rule form General tab.|
|Open rule by name||Opens a rule based upon the rule type (concrete class derived from the Rule- base class) and a Property Name key part.|
|Run activity||Runs the activity you specify in the Activity field. Enter the Activity key part. Parameters listed on the Activity rule form's Parameters tab appear beneath the field. Enter the values you want pass to the activity.|
|Run data transform||Runs the data transform that you specify.
to view the JavaScipt API. |
|Toggle Mobile / Full Site||Switch between the standard view of the site and the view optimized for mobile devices.|
After you add an action to a set, you can select one or more conditions that determine whether (or how) the system takes action when the user performs the control event.
Check box, you cannot apply conditions.
Optional. To define a condition, click the Add a row icon. Select one of the when conditions in the drop-down list. Enter input parameters if required. When you click Submit to close the dialog, a condition icon appears in the condition column indicating that the behavior has an associated condition.
Enter another row if you want to use multiple conditions. Select either an "AND" or an "OR" operator for the second condition. You can add conditions using the operators of the same type. That is, if the first operator is "AND", all the following operators are "AND."
The conditions that appear in the drop-down list depend upon whether UI element is editable or read-only. Select one of the following when conditions:
- Active — The field has focus.
- Associated Property — Property value specified in the control's
Cell Property panel (
Value of associated propertyoption) is equal, greater, or less than another property value.
- Empty — The control does not contain a property value.
- Inactive — The field does not have focus.
- Not Required — An input field that is not required.
- Other Property — Property value given for the
Value of a different propertyoption on this tab is equal, greater, or less than another property value.
- Populated — The control contains a property value.
- Required — An input field that must have a non-blank value. The Required condition checks whether the field is required, but does not consider the value of the input field. Most forms label a required field with an orange asterisk.
- When Rule — A when condition that you configure.