Controls form - Completing the Control tab

Control form Completing the Control tab
About New Control HTML Parameters Pages & Classes History
More...

By default, this tab appears when you open an auto-generated control or open a New rule. When you clear the Auto-Generated? checkbox on the HTML tab, the Parameters tab displays. This tab offers an array of settings that govern how the auto-generated control appears to the user and the actions the user can perform. The settings enable you to format editable and read-only values and pick from a set of pre-configured actions.

Introduction

PRPC includes a set of standard auto-generated controls. See Standard auto-generated controls. As a best practice, use these controls in new development. Auto-generated controls provide these benefits:

Eliminates hand-coding, which simplifies design and maintenance.
Lets you to customize a control in a section or harness without having to make multiple copies and reconfigurations.
Preserves custom settings when you upgrade your system.
Eliminates inline JavaScript, which reduces cross-site scripting (XSS) vulnerabilities and improves performance.
Ensures browser independence and compatibility.

In Mobile applications, over one hundred controls are supported. The decision table pyMobileControlMapping, maps commonly used controls to one of seven controls that will display on mobile devices. This mapping facilitates the operation of the desktop version of PRPC applications on a mobile device. For example, pxDateTime is mapped to pxDateTimeMobile. See Supported user interface features for mobile applications.

Customizing a control in a section

Auto-generated controls and their settings are optimized for most interfaces. If necessary, edit the settings within the section, flow action, or harness in which you are working.

To customize an auto-generated control:

Open the section or harness that contains the rule.
Select the cell that holds the rule and open its Cell Properties panel.
In the panel, select the magnifying glass icon () next to the Control field. The control Parameters dialog appears, which displays most of the settings in the underlying rule's Control tab. You cannot edit the Control Modes or UI Element settings.
Make your modifications. To immediately render your changes, click OK in the dialog. If satisfactory, save the section. The system generates the XML representing your edits and stores it in the section.

If you wish to modify an auto-generated control and reuse it in a number of sections, make a copy into your RuleSet and change the Stream Name key part. Keep the original Control Modes and UI Element settings. As a best practice, do use an auto-generated rule to build an entirely new control.

Any customization you make to the control in the section is maintained even if the control later changes. Parameters that are not customized apply to all of the instances. For example, if the Expand Options setting in the rule is Collapsed With Icon and you customize the control's Parameter dialog setting to Expanded With Icon, updating the rule setting to No Scrollbar does not change the custom parameter. If you had not customized the Expand Options setting, your rule update is reflected in the control's Parameter dialog.

If you want to revert to the control's configuration, clear the customized instance and re-add the rule.

Control tab settings

These settings determine the read-only and edit-mode presentation and behavior of the control.

Field

Description

Control Modes

Before you begin editing the rule, use the radio buttons to filter the initial array of options and parameters in the form. Select one of the following:

Editable/Read-only if you want to configure the associated property for both edit and read-only modes. The options appear in the Basics, Format, Options, and Behaviors areas under Editable and Read-Only column headings.
Read-Only if you want a control that always appears as non-editable text. The Editable column does not appear.
Action to set the UI Element to Button, Icon, or Link. Only one column of settings appears, which applies to both editable and read-only control modes as defined in other parameter settings in this form.

The Control Modes field does not appear in the Parameters dialog when customizing the control in a section.

Basics

Use this area to specify the control or category of property type used with the control.

Field

Description

UI Element

For Editable/Read Only and Action control modes, select the type of control that appears on the layout. For Read-Only mode, select the type of presentation of the property value. Your selection filters the Format, Options, and Behaviors areas on this tab.

Group/Selection	Description
`Date Picker`	Add a Calendar control. Appears when Control Mode is set to `Editable/Read-Only`.
`Text Input`	Add a Text Input control. Appears when Control Mode is set to `Editable/Read-Only`.
`Text Area`	Add a Text Area control, which can contain more than one line of text. Spellchecking is enabled by default. Appears when Control Mode is set to `Editable/Read-Only`.
`Checkbox`	Add a Checkbox control. Appears when Control Mode is set to `Editable/Read-Only`.
`Button`	Add a button (with a text label) that triggers an action when clicked. Appears when Control Mode is set to `Action`. You can include an image next to the label. You can use the Skin rule to specify and create button styles.
`Icon`	Add an icon that triggers an action when clicked or hovered on. Appears when Control Mode is set to `Action`. You can use standard icons or create custom ones. Available actions are the same as the Button control.
`Link`	Add a text link that triggers an action when clicked or hovered on. Appears when Control Mode is set to `Action`. You can include an image next to the label. You can use the Skin rule to specify and create link styles. Available actions are the same as the Button control.
`Text`	Display values of property types that include text, number, boolean, and date/time. Appears when Control Mode set to `Read-Only`.
`Hidden`	Use this element when you want to include a property value that is submitted but is not visible to the user. Appears when Control Mode is set to `Read-Only`.

You cannot edit the UI Element field in the Parameters dialog.

Value

Select a single-value property or text string that contains the value you want to associate with the control. This option does not appear in Action control mode. Select one of the following:

Group/Selection	Description
`Value of associated property`	Uses the property or field value entered in the Properties field in the control's Cell Properties panel (located in the section). In edit mode, this setting is the default and cannot be changed.
`Value of a different property`	A Single Value property or field other than the one in the Properties field. You can reference properties on any page identified on the Pages & Classes tab, using the normal notation pagename.propertyname for pages other than the page corresponding to the Applies To class of the rule.
`Constant`	A text string. If the Localize? checkbox is selected on the section's HTML tab, a SmartPrompt appears in the Constant field in the Parameters dialog. Select a field value rule if you plan to localize the text. Enter no more than 64 characters. A field value rule with pyCaption as the second key part and this text as the final key part is needed for each locale.

When a property is computed through a Declare Expression rule, the system presents the value as read only in the control's read-only format.

Options

Use this area to specify parameters for editable and action control modes.

Field

Description

Specify Size

Appears when the UI Element is Text Input.

Group/Selection	Description
`Auto`	Select if you want the layout to determine the width of the control area. Default.
`Custom`	Select to specify a fixed value in the Width field.

Min/Max Chars

Appears if the UI Element is Text Input.

Optional. Enter a value that determines the minimum and maximum number of characters that can be entered in the text field. You can designate either value as unlimited by leaving it blank.

Placeholder

UI Element is Text Input, Text Area, or Date Picker. Optional.

Group/Selection	Description
`Other`	Select to display inside the field a hint or instructional text that helps users enter a correct value.
`Expected Format` (Date Picker only)	Select to display the localized DateTime Format value selected in this control.

The text disappears when the user enters a value. If no value is entered, the placeholder text reappears when the field loses focus. Use the Skin rule Placeholder Text setting (Components > Inputs) to specify the text color.

Specify Width

Appears if the UI Element is Text Area.

Group/Selection	Description
`Auto`	Select if you want the layout to determine the width of the control area. Default.
`Custom`	Select to specify fixed value in the Width field. You can override this setting in the layout.

Width

Appears if the UI Element is Text Area or Text Input and you select Custom.

Enter a positive integer that is a pixel count, a percentage of the cell area, or a number of columns (Text Area only). In the pull-down list to the right of this field, select the unit of measure:

px — pixels.
% — percentage
columns — number of columns.

Specify Height

Appears if the UI Element is Text Area.

Group/Selection	Description
`Auto`	Select if you want the layout to determine the height of the control area height.
`Size to Content`	Select if you want the height to expand with the content. This selection also provides collapse options. As a best practice, use this setting.
`Custom`	Select to specify a fixed height. You can override this setting in the layout.

Height

Appears when the Text Area Height is Custom.

Enter a positive integer that is a pixel count or number of rows. In the pull-down list to the right of this field, select the unit of measure. To ensure uniform text area heights within a layout, do not mix row and pixel settings.

Scrollbar

Appears when the Text Area Height is Custom.

Select to display a scrollbar to the right of the area if the content exceeds the number of rows or pixels.

Min Height

Appears when the Text Area Height is Size to Content.

Enter a positive integer that is a pixel count or number of rows. In the pull-down list to the right of this field, select the unit of measure.

Collapsible

Appears when the Text Area Height is Size to Content.

Select one of the following:

Group/Selection	Description
`No`	The text area is presented i at a size determined by the `Width` and `Height` settings. The user cannot expand or collapse the text area.
`Yes, Default Expanded`	The text area is initially presented in expanded mode at a size determined by the `Width` and `Height` settings. The user clicks the Collapse icon () to collapse the text area.
`Yes, Default Collapsed`	The text area is initially presented in display-only mode, with only the Min Height value visible. The user clicks the Expand icon () to expand the area.

Date/Time

Appears when the UI Element is Date Picker.

Enables date and time selections in the Calendar control. Select one of the following:

Group/Selection	Description
`Auto` (default)	Based on the associated property type, the system enables the appropriate date or time selections in the control as follows: `DateTime` — Enables date and time selections. For example, in Drop-down Lists mode, six lists are displayed — one for each date and time value. `Date` — Enables date selection only. For example, in Calendar mode, the time selection function does not appear in the pop-up calendar. `Time` (`TimeOfDay`) — Enables time selection only. For example, in Drop-down Lists mode, three lists are displayed — one for each time value.
`DateTime`	Enables date and time selections.
`Date`	Enables date selections only..
`Time`	Enables time selections only.

As a best practice, use the non-auto options only with DateTime properties or dates stored as valid text strings. Using an option that is unsuitable for the property type may present an incorrect read value at run-time. For example, enabling the Date option for a TimeOfDay property will not display a result.

Display Mode

Appears when the UI Element is Date Picker.

Determines the presentation of the control to the user. Select either:

Group/Selection	Description
`Text Input + Calendar` (default)	Display a text field that contains a calendar icon. The user can click the icon to select the date and time values in a pop-up calendar. Alternatively, the user can enter a date as a text value by clicking inside the field.
`Dropdown Lists`	Display an array of drop-down lists from which the user selects the day, month, year, hour, minute, and A.M./P.M. Locale settings determine the order of the drop-downs. Use this option if the interface is configured for accessibility.

Allow Text Entry

Appears when the UI element is Date Picker and the Display Mode is Text Input + Calendar.

Click Yes (default) to enable the user to enter a text value in the field. Click No to prevent text entry.

Enable Calendar

Appears when the UI Element is Date Picker and the Display Mode is Dropdown Lists.

Click Yes to display a calendar icon with the drop-down lists in the field. This enables the user to use the lists or the pop-up calendar to pick dates and times. No is the default.

Number of Years

Required. Appears when the UI Element is Date Picker and the Display Mode is Dropdowns.

Enter a numerical value indicating the date range (in years) in the Year drop-down list. The list contains an equal number of years forward and backwards from the current year. For example, if the current year is 2011, a value of 10 displays a range of 2007 to 2016 . If the value is an odd number, the odd date is counted as a future year. For instance, a value of 11 displays a range of 2007 to 2017.

Caption

Appears when the UI Element is Checkbox.

Enter text describing the purpose of the control. The user can click this text to select or deselect the checkbox.

Caption Position

Appears when the UI Element is Checkbox.

Select Left or Right to indicate where you want the caption text to appear in relation to the checkbox image.

Label

Appears when the UI Element is Button (optional), or Link.

Enter text or select a property or field value that contains brief text, which appears on the button or as a text link.

Configuring labels

As a best practice, start the text with a verb. Consider the collection of controls that appear at runtime collectively; provide each control with a clear and distinctive label. For example, Cancel order.

To allow users to execute an action using a shortcut key combination, include an ampersand character (&) immediately before a letter in the caption text. At runtime, users can press the ALT key and the letter key together to execute the activity. For example, enter &History as a caption text to allow users to access work item history with ALT + h. At runtime, the label appears with the shortcut key underscored, as in Visual Basic applications.

If you use shortcut keys in your application, be careful to choose distinct letters for each control; for example, you can't have ALT + c as the label for both the Contents button and Close button. (To include an ampersand in a label as text, follow the ampersand by a space character.)

Localization

Use SmartPrompt to select a field value rule if you plan to localize the text. Enter no more than 64 characters. A field value rule with pyButtonLabel as the second key part and this text as the final key part is needed for each locale. When practical, choose a caption already included in a language pack, to simplify later localization. See About the Localization wizard.

Tooltip

Optional. Appears when Control Modes is Action or Editable/Read-Only (all UI Elements except Date Picker).

Select a property value or enter a constant that contains a sentence or phrase identifying to users the purpose and function of the control.

Tip As a best practice, start the sentence with verb either in the imperative ("Enter price of item here") or as an infinitive ("To cancel the order, click here").

When UI Element is Icon, the system enters a default value here based upon the value selected in the Icon field.

Localization

Use SmartPrompt to select a field value rule if you plan to localize the text. Enter no more than 64 characters. A field value rule with pyActionPrompt as the second key part and this text as the final key part is needed for each locale. When practical, choose a caption already included in a language pack, to simplify later localization. See About the Localization wizard.

Format

Appears when the UI Element is Button or Link. Select a pre-defined format (Standard, Simple, Strong), which is configured in the Skin rule. The default selection is Standard. Use the Skin rule to modify the settings for these formats.

Alternatively, select Other to reference a custom format created in the Skin rule. A blank field appears when you select this option. Enter the format name.

Privilege

Optional. Appears when the Control Mode is Action.

Select the Privilege Name key part of a privilege rule that controls the availability of this control at runtime. During rule resolution at runtime, the system uses the Applies To key part of the current rule as the first key part.

If there is a privilege and a when rule (see Disabled field), both rules must evaluate to true for the button to be available to the user.

When Not Met

Appears when you enter a privilege. Select Hide or Disable (the button) if the user fails the privilege rule.

Image
(for Button or Link)

Optional. Appears when the UI Element is Button or Link.

Insert an icon next to the label by clicking the magnifying glass icon (). This opens the Image Viewer. Select the binary file you wish to use.

If the button or link Format, for example, Standard, contains an image in the background, then that image overlays the image specified here. Button and link formats are defined in the Skin rule.

Image Position

Appears when you enter an image in the Image field.

Select Left or Right to indicate where you want the image to appear in relation to the label.

Disabled

Optional. Appears when the Control Mode is Action.

Select Yes if you want to apply a when condition that tests whether the user can use the control. If selected, the following options appear:

Group/Selection

Description

Disabled Condition

Select one of the following:

The When Name key part of a when condition rule. Click the pencil icon () to review or create the rule.
Expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression using the && and || operators.

As a best practice, use the Condition Builder to edit this field. Click the magnifying glass icon ( ) to open the tool. See Using the Condition Builder to configure dynamic UI actions.

Run On Client

Appears only if the Disabled Condition field contains an expression that can be evaluated on the client. Complex expressions and When rules are not eligible.

Select to cause evaluation and execution of the condition each time the value of a property stated in the condition changes.

If unselected, the expression is evaluated and the condition executed when the form is initially presented and whenever the form is refreshed.

Icon

Appears when UI Element is Icon. Select a standard icon from the drop-down list. By default, the Blank icon is selected when pxIcon is entered in the Control field on the Cell Properties dialog.

If you specify a standard pxIcon variation such as pxIconPrint or pxIconReview, the system selects a standard icon for that rule. For example, if the control is pxIconAddItem, the Add Item icon is selected. See Section, and Flow Action forms — Adding an Icon Control for icon descriptions.

To use a custom icon, select Other.

Image
(for Icon)

Appears when you enter Other in the Icon field. Select the magnifying glass icon ( ) to open the Image Viewer. Select the binary file you wish to use.

As a best practice, use sprites rather than individual images for Icon controls.

Position

Appears when the file you select in the Image field is defined as a sprite on the Binary File rule form. See Binary File — Completing the Main tab.

The numbers in the drop-down reflect the number of columns in the sprite. Select the number you wish to use for this control's action. The value in the Tooltip field applies to this position.

For information about icon positions, hover the mouse pointer on the help icon next to this field ( ).

Format

Use this area to design the appearance of read-only text or an editable control. Action controls do not use formats.

Field

Description

Type

Select a format (read-only) used with this property. Your selection filters the format options.

Group/Selection	Description
`None`	The property is not formatted. There are no options.
`Text`	Unedited text, which may contain spaces, tabs, line break characters, and other control characters.
`Number`	Numeric properties on output.
`Date/Time`	Renders `DateTime` and `Text` property types in date and time format. See Understanding the Date, Time of Day, and DateTime property types. Specify the format in the DateTime Format field.
`Date`	Renders `DateTime` and `Text` property types in date-only format (hours and minutes are not displayed). See Understanding the Date, Time of Day, and DateTime property types. Specify the format in the Date Format field.
`True/False`	Boolean values. Specify the format in the True Label and False Label fields.

Do not confuse format types with property types.

Obfuscated

Appears if Type is Text.

For read-only, select Yes if you want to display to the user the characters as a string of bullets.

For Editable (Text Input), select Yes if you want the characters entered by the user to appear as a string of bullets. The input characters are initially added to the clipboard as unencrypted, clear text values. The system computes the hashed value only as the page is committed to the PegaRULES database. Thereafter, the hashed value appears in both the clipboard and the database row.

Decimal Places

Appears if Type is Number.

A non-negative integer to control the number of digits presented after the decimal place. The default is Auto, which displays a maximum of three decimal places (placeholder zeroes are not added). Select to remove all digits after the decimal point and round to the nearest integer. Select All to include all digits.

Scale

Appears if Type is Number.

Select a label indicating the scaling you wish to apply to the number. The scales are K for thousands, M for millions, B for billions, and T for trillions. For instance, if you select Thousands, a value of 20,000 appears as "20 K." If Percentage, the value appears as a percentage sign (.8 appears as "80%").

Negative Format

Appears if the Type is Number.

Select a format (minus sign or parenthesis) for displaying negative numbers.

You can also specify a CSS class if you select one of the Style Ref options. By default, the class name is NegativeNumber.

Symbol

Appears if Type is Number. When a symbol is specified an additional character(s) is prepended to the value. Currency automatically uses the localized currency symbol, constant uses a string, and reference uses a property value.

Select an option for representing the number as

Currency — Formats the number as a currency using the default locale.
Constant — A text string or character (for example, "%") ASCII character that you enter.
Reference — A property value.

Separators

Appears if Type is Number.

Select to use a thousands' separator. Depending upon the default locale, a comma or period is used.

Text Alignment

Appears if Type is Number.

Select left, right, or center alignment.

Auto Prepend

Auto Append

Appears if Type is Text and the control is not obfuscated.

Select a property or constant that you want to add either before or after the displayed property value. For example, when the user name appears, the system can automatically append the full mail extension to the name or prepend the user's title.

DateTime Format
or
Date Format

Appears if Type is Date/Time or Date.

Select one of the following:

A DateTime format (for example: 1/1/01 1:00 AM), or a Date format (for example: 1/1/01). The formats are locale-specific, changing automatically based on the value set on each user's Windows workstation, or the locale of a user, as recorded in the Operator ID data instance.
The elapsed time format (2 days, 5 hours ago). The system displays the value calculated as the difference between the current system date/time and the date/time value of the property. For example:

Current = 3/21/2011

Property value of 3/20/2011 = 1 day ago

Property value of 3/22/2011 = 1 day from now

The units of measure are minutes, hours, days, and years. If greater than 59 minutes, the value is represented in two units (unless the difference is exactly one unit). For example:

1 hour, 10 minutes

2 days, 20 hours

1 month, 4 days

1 year, 3 months

If less than a minute, the value is displayed as "less than a minute ago" (or from now).

To calculate months and days, the system uses today's numerical day in the previous month(s). For example, if today is March 21, one month ago was February 21, not one month, six days ago.

If the property is a Date type or the format is Date, minutes are excluded.

2nd Number Cutoff

Appears if DateTime Format is 2 days, 5 hours ago (elapsed time).

Enter a numerical value for the first unit, which determines when the second unit is truncated in the display. When the first unit number reaches or exceeds this value, the second unit does not appear.

For instance, if you set the cutoff value to 5, here is how these dates and times will appear to the user:

1 hour, 45 minutes ago
2 hours, 45 minutes ago
3 hours, 45 minutes ago
4 hours, 45 minutes ago
5 hours
6 hours
etc.

Enter a value of 0 to always display a single unit.

True Label

False Label

Appears if the Type is True/False.

Enter a text string to label either outcome. Used with a boolean type.

If the Localize? checkbox is selected on the section's HTML tab, a SmartPrompt Appears in the Constant field in the Parameters dialog. Select a field value rule if you plan to localize the text. If this text is to be localized. enter no more than 64 characters. A field value rule with pyCaption as the second key part and this text as the final key part is needed for each locale.

Behaviors

Three factors determine a control's behavior:

Event — An action performed by the user, such as click, double-click, hover, focus, keyboard entry, or a change to the property bound to the auto-generated control. For example, selecting an item from a list.
Action — An action performed by the system as a result of the user event. For example, clicking a button may save, cancel, or update a work item.
Conditions — User restrictions such as When rules that can be applied to an event and action combination. For example, you can configure the conditions so that hovering over a field displays ShowInfo only if it contains a property value.

You cannot use conditions with Action control types — use the Disabled, Privilege, or both settings in the Options area.

Buttons do not use behavior conditions. Use the Disabled or Privilege fields in the Options area to determine whether the button is available to specific users.

The Behaviors area contains settings to specify the behavior of the control in Editable and Read-Only modes. For each mode, a grid summarizes a list of behaviors in three columns — Event, Action, and a red diamond-shaped condition icon (). If the behavior has condition, a solid red diamond icon appears in the row; if not, a gray diamond appears.

To define the control's behavior, click the add row icon . This opens the Behavior dialog, which contains a section for each of the above three factors. After you have completed the dialog, click OK to apply your edits and close the dialog. The new behavior displays in the control's Behaviors area grid. Here is an example of the Behaviors grid after you have defined two behaviors — one with a condition, the other without:

To edit a behavior, double-click the row to open the Behavior dialog. To delete a behavior, select it, and click the delete row icon ().

Using when conditions, you can combine behaviors for a single control. For example, a first behavior states that when the user focuses on the Input Area, the system sets the background color to red (defined in the Inline Style field) if the area is populated. A second behavior states that, for the same event, the system sets the background color to blue if the area is empty. The system executes the actions in the order they are listed on the grid. Use the row handles to rearrange them if necessary.

Defining behaviors in the Parameter dialog

When customizing a control in the Parameters dialog, you can add but cannot delete or modify behaviors defined in the underlying rule. The rule's behavior(s) appear in a top grid. A bottom grid enables you to add conditions, which you can delete or modify.

If you define more than one event for a control, 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 the Behavior field on a Cell Properties panel) and recalculation of an expression. After all processing is completed, the system starts Local Action.

The Behavior dialog contains the following fields and options ( the system filters the options based upon the selected UI Element and Event):

Field

Description

Behavior

Select to indicate what the user must do to invoke the action.

Event

Group/Selection	Description
`Hover`	Hover the mouse pointer over an edit-mode control or read-only text.
`Focus`	Select or click an edit-mode control.
`Click`	Click an action-mode control, such as a Button.
`Keyboard`	Press a key, such as Enter, or Up or Down arrow.
`Change`	Make a change to an auto-generated control, for example, by selecting or editing a value, or tabbing out of a field.

Action

Click Select... to display an action menu organized into the following categories.

Process Work

Action	Description
`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 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.
`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, presents the current flow rule as Visio diagram, and marks the location of the current assignment with an arrow. Requires the Work-.Perform privilege.
`Show Re-Open 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 presented by the flow action. This capability is not desirable in all applications, as it allows users to overwrite values 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. See Understanding transactions in flow executions.
`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.
`View History`	Displays the work item history, for users who hold the Work-.AccessAuditTrail privilege.

Get Work

Action	Description
`Create Work`	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.
`Get 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 workbaskets they have access to.
`Open Assignment`	Open an assignment based upon its key value pxAssignmentKey. Enter the key of the assignment you wish to open.
`Open Work by Handle`	Opens work based upon the internal key that uniquely identifies the instance. Specify the handle of a work item, beginning with the class name.
`Open Work Item`	Opens work based upon the work item ID. Specify the full ID of the work item.
`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.

Handle List Items

Use these actions only when acting upon repeating layouts.

Action	Description
`Add Child`	Adds a child item beneath the selected row or branch or in a repeating grid or tree.
`Add Item`	Adds (above or below) a row to a layout.

`Delete Item`	Deletes a row in a layout.
`Edit Item`	Enables edit of the selected item in the layout. Not available if the repeating layout Edit Mode is `Read Only`.
`Open Local Action`	Displays the flow action you specify. Flow 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`	Opens the item selected in the layout.
`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 `Current Item`, `Next Item`, or `Previous Item` in the repeating layout. `Current Item` is the default action for Click events. 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 `Keyboard` Event `Up` to `Set Focus` to the `Previous Item` in the grid and the `Keyboard` Event `Down` to `Set Focus` to the `Next Item` in the grid. Use the `Keyboard` Event `Enter` to take an action, such as edit the selected item (Handle List Items>`Edit Item`.) 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. The UI Gallery contains a working example of Set Focus. To view and interact with examples and review configurations, select `> User Interface > UI Gallery` and select Click Actions in the Repeating Layouts group.

Display

Action	Description
`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.
`Expand/Collapse`	Expands or collapses the harness depending upon the current state of the form.
`Print`	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.
`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. Content — Select the Name key part of a navigation rule. Align Menu — Specify `Left` or `Right` to indicate how you want to horizontally align the top-level menu border with respect to control's image or label ( For example, assume you create a link control labeled Link Menu. If you select `Right` alignment, the menu's right border aligns with the letter "u" when the user opens the menu. Maximum Width — Select either of the following: `Auto` — The menu width at each level expands to the width of the menu item with the greatest number of characters. By default, there is no limit. `Custom` — The menu width at each level is determined by the number of text characters you enter in the Ellipsis After... field. For example, if you enter a value of 7, a menu item named `Resolve Work` truncates at "Resolve" and is followed by three dots. When using this action, the menu contents are generated each time they're requested. This eliminates on-load processing and ensure 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. See Completing the Layout tab — Adding a menu bar.
`Refresh Section`	Commits the contents of the section that contains the button or another section that you specify. Target — Specify the Name key part of the section that is refreshed when the user clicks the button. `This Section` — Refreshes the section containing the button. `Other Section` — Refreshes the section specified in the Section field. Section — Specify the Name key part of the section that is refreshed. Appears when `Other Section` is selected. Data Transform — Optional. Enter the Name key part of a data transform that may affect the content of the refreshed section. The prompt is based on information in the Pages and Classes tab of the current section. See About Data Transforms. Parameters listed on the Data Transform form's Parameters tab appear beneath this field. Enter the values you want pass to the data transform. Activity— Optional. Enter the Activity Name key part of an activity. Specify an activity that may affect the content of the refreshed section. The prompt is based on Pages and Classes of current section. This activity is processed after a data transform. Parameters listed on the Activity rule form's Parameters tab appear beneath the field. Enter the values you want pass to the activity.
`Spellcheck`	Invokes the spellchecker. This tool determines which dictionaries to apply, how to operate the spellchecking algorithm, and other details.
`Set Style`	Applies an inline styling to this control only. In the Inline Style field, type a CSS style definition in this field, or click the magnifying glass to access a Style Editor window. Styles you enter in this field supplement and override style elements defined in style sheets, according to normal CSS rules. This option does not appear if UI Element is `Icon`. Using the Style Editor You can select the font, color, font size, text align, vertical align , borders, margins, and other attributes of this cell using selection lists. The Style Editor maintains a preview of the resulting presentation. If you alter the style definition directly, click Apply to update the preview. Click OK to record the style defined with the Style Editor in the panel.
`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. 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") Value — Enter a property reference or a literal constant (source). Click the add row icon to add more properties and values. Examples: Use multiple properties to quickly populate a form. Set the value of a hidden property (in a cell using pxHidden control), which triggers an event such as making a layout visible. 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.
`Set Focus`	Sets the 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) Examples: If a section or layout becomes visible on click of a button, set focus to an editable control in the now visible section. Set focus to the first row in a list of search results. Optionally, set Conditions. See Conditions below. All browsers may not visually indicate that a control has focus, for example, a checkbox or radio button. 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. The UI Gallery contains a working example of Set Focus. To view and interact with examples and review configurations, select `> User Interface > UI Gallery` and select Date/Time in the Controls group.
`Show Smart Info`	Appears when the UI Element is `Icon` or `Link`, and the Event is `Hover`. Displays a SmartInfo pop-up. The contents of the display are determined by a section, presented in read-only mode. Section — Select the section that you want to include in the pop-up. Title — Optional. Enter a phrase that appears in the header area.
`Post Value`	Posts the property value to the clipboard and refreshes the cell's contents. Post Value is triggered by `Change` or `OnBlur` of the field and prior to any other event (such as a click action) initiated from a control, or from the calculation of expressions. For example: a pxButton control refreshes another section using an activity that requires three updated properties before the control can update the target section. When the user clicks the button, the properties are posted to the clipboard and are synchronized with the activity. The properties are already on the clipboard, in most cases, when the button is clicked.
`Close`	Provides an explicit close action for an overlay. Overlays, configured by specifying the `Launch>Local Action` Target as an `Overlay`, close automatically when the user clicks outside of the overlay.

Launch

Action	Description
`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 control. 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: The modal thread is deleted. The modal dialog automatically closes. The system refreshes the section on the user form containing the control. You can update other areas on the user form by appending actions such as `Refresh Section` (other), or `Set Value` to this control. These actions are triggered after the modal closes (cancelled or submitted). Specify the following: Using Page — Optional. If you want to run the flow in the context of an included section that uses 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. When this control is used in a grid, and this field does not contain a value, then the primary page becomes the row page. Flow Name — Enter the Flow Name key part of a flow rule. Parameters — Optional. Displays parameters listed on the Flow rule form's Parameters tab. Specify values to pass to the flow. More on modal flows The modal displays only the action sections of the flow actions. Harnesses are not displayed. The Harness Name settings on the Assignment shape properties panels are ignored. You do not need to create modal-specific harnesses. If an assignment has multiple flow actions, only the default flow action (the one with the highest likelihood) appears in the modal dialog. A modal flow does not create its own pzInsKey or pyID. The Creates a new work object? setting on the Flow rule form's Process tab is ignored. If the parent primary page has a pyID, the system applies the modal Flow rule form's Temporary object? checkbox setting as follows: Selected (create temporary object) — The modal flow does not save and commit the work item between modal screens. Assignments are not created. The modal flow page is merged with the parent primary page only when the final modal assignment is submitted. This configuration is useful for screen flows, and prevents hanging assignments if the user cancels the modal. Not selected — The modal flow saves and commits the work item at each assignment, and can create assignments. This configuration is useful when the flow in the modal is routed to another operator who needs to perform the assignment. If the parent flow is a temporary work item (no pyID), the modal flow always runs as a temporary work item, regardless of the Temporary object? checkbox setting. If you want to customize the modal's layout, buttons, or apply styles, copy the standard section Work-.pyModalFlowTemplate to your application (do not change the Purpose key part). Note that the modal flow actions use the buttons in this template, not those in the Work-.pyActionAreaButtons section used by standard flow actions. If this control is located in a repeating layout row, then settings for sorting, filtering, and expand-pane display will be lost when the section refreshes.
`Harness`	Replaces an open harness or displays a new one. Target — Define where the system will render the specified harness. `Replace Current` — Replaces the current tab or dynamic container contents with the new harness. `Pop-Up Window` — Displays the harness in a new browser window. `New Document` — Opens the harness and replaces the current dynamic container contents. Note that if the harness is launched outside a dynamic container, it always opens in a pop-up window. Harness — Select the harness that is displayed. Tab Name — Optional. Select a property or enter a text string that identifies a tab. 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. Used with `New Document` and `Replace Current`. Class — Select the class to which the harness belongs. Read Only — Select if you want the harness contents to display in read-only mode. If set to `No` you must enter a window name (`Pop-Up Window` target only). Submit Current — Select to save the harness data before the system replaces the harness. Used with `Replace Current`. Window Name — Optional. 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 harness appears in a new window. Used with `Pop-Up Window.` Window Width — Optional. 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. Used with `Pop-Up Window.` Window Height — Optional. Enter a positive integer to set the window height in pixels. Used with `Pop-Up Window.` Key — Optional. Enter the key value (pxInsName) of a data instance you want to automatically open as the new primary page when the harness is displayed. The system uses this value and the Class value to identify the record. This action executes before a pre-activity (if defined). Used with `New Document`. Data Transform — Optional. Enter a Name key part of a data transform that may affect the content of the harness. See About Data Transforms. Parameters listed on the Data Transform form's Parameters tab appear beneath this field. Enter the values you want pass to the data transform. Activity — Optional. Enter the key part Activity Name to cause the system to execute it before rendering the harness. This activity is processed after a data transform. Select the pencil icon () to open the rule. Parameters listed on the Activity rule form's Parameters tab appear beneath the field. Enter the values you want pass to the activity.
`Landing Page`	Opens a landing page for display or CreateNewWork to create a new work item based on a landing page. Action — Choose `Display` to open a landing page for display, or CreateNewWork to create a new work item based on a landing page. Name — Enter 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 — Enter one of the following based upon the action: `– Display` Action — Enter the class on which the harness for the landing page is based. `– CreateNewWork` Action — Enter the class on which the flow run to create the work item is based Harness Name — `Display` Action only. Select the harness that the landing page is built on. Data Transform `— Display` Action only. Select the data transform used to generate the landing page. Page — `Display` Action only. Specify an existing page. Read Only — `CreateNewWork` Action only. Specify the name of the flow used to create new work. Level A — Enter a value to work with a when condition on the harness to open the selected item in a specified tab on the landing page. Level B — Enter a value to work with a when condition on the harness to open the selected item in a specified tab on the landing page. Level C — Enter a value to work with a when condition on the harness to open the selected item in a specified tab on the landing page. Parameters Specify additional parameters to pass to the harness or flow. Specify additional parameter 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. Choose `Refresh`, `Redisplay`, or `Sort`. Select the Header checkbox 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. Select the local action in the Local Action field. In the Target field, select to present the local action as one of the following: Modal dialog — requires the user to complete or dismiss the dialog before continuing work. Overlay — launches the local action in a panel overlaying the current window. The user can dismiss it by clicking outside the overlay area or through an explicit `Display>Close` action, configured in the Local Action. Use an overlay to display information such as simple forms or flows. You can use this in conjunction with actions on other controls; for example, a Text Input box, to create an advanced picker as shown in the UI Gallery ( `> User Interface > UI Gallery` Combinations>Search and Select>Using Overlay.) Some of the more advanced flow action features are not supported for overlays. For example, a flow action can launch a Dynamic Container-based harness. Launching this flow action in an overlay is not supported. Replace current — appears in the current action section (.pyActionArea). The `Perform Action` is similar to the `Local Action`. However, the Perform action is used with flow actions to advance the flow when the flow action does not have a UI.
`Open URL in Window`	Using an activity that returns an HTML stream, opens a URL in a browser window. Action Use Alternate Domain — Select to specify an alternate domain for the URL to open. – Select a URL in the Alternate Domain URL field. – Optional. Use the Querystring area to specify the names and values of query strings for the alternate domain URL. User Primary Page — Optional. Select to invoke 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 About Data Transforms. Parameters listed on the Data Transform form's Parameters tab appear beneath this field. Enter the values you want pass to the data transform. Activity — Select an activity to return an HTML stream that displays in the opened window. This activity is processed after a data transform. Select the pencil icon () to open the rule. Parameters listed on the Activity rule form's Parameters tab appear beneath the field. Enter the values you want pass to the activity. Window Properties Window Name — Specify a text string to define the name of the opened window. Replace History — Select to erase the history of the opened browser window. Height — Enter a numerical value to represent the height in pixels of the opened window Width — Enter a numerical value to represent the width in pixels of the opened window Top — Enter a numerical value to represent the offset in pixels from the top of the screen Left — Enter a numerical value to represent the offset in pixels from the left of the screen. Resizable — Select to enable the opened window to be resized. Scrollbars — Select to enable scrollbars in the opened window. Location Bar — Select to enable the location bar in the opened window. Menu Bar — Select to enable the browser's menu bar in the opened window. Status Bar — Select to enable the browser's status bar in the opened window. Tool Bar — Select to enable the browser's tool bar in the opened window.
`Report Definition`	Executes the retrieval and sorting operations, but not the formatting and display processing, of a report definition.
`Wizard`	Launch a wizard based on key part Label and class of the wizard (class name begins with `PegaAccel-` ). Optionally, specify parameters such as operator ID, status, and so on.

Advanced

Action	Description
`Open Rule`	Opens a rule that takes the pzInsKey value as its parameter. Handle — A pzInsKey key value in the rule you want to open. Resolve By — To determine how the system locates the rule, enter one of the following: `Name` – A Property Name key value. `Handle` — Value entered in the Handle field. `Handle By Condition` — A when condition that qualifies the value entered in the Handle field.
`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.
`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 .
`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 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 Transform — Enter 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.
`Run Script`	Calls a custom JavaScript function or PRPC API. Function Name — Select the property or literal reference that contains the function you wish to run. (In the Control form, only @ baseclass properties appear). Enter the JavaScript file using this function on the Harness rule form's Scripts and Styles tab. The `Run Script` action instructs the browser to find a JavaScript function with that name and then pass those parameters. If the same function is used in multiple files in the list, the last file is used (the last function overwrites the others with that name). The browser uses the defined function when it executes the JavaScript file. Do not use ( ) in the function or parameter names. You can specify a property that stores the name of the function. To use javascript object references, prepend `script:` or `javascript:` to name of the javascript function. For example `script:window.alert` Use `“ ”` to specify literal values. You can also use `script:MyObject.MyField` to access objects in function parameters. Parameter area — Optional. Enter parameter names and values (constants or properties). Order is important; if necessary, reorder the list by selecting a row and moving it.

Conditions

Use this area to select one or more conditions that determine whether (or how) the system takes action when the user performs the control event.

When

SmartPrompt Optional. If this area is blank, the system always performs the action. To define a condition, click the add row icon . Select one of the when conditions in the drop-down list. Enter input parameters if required. When you click OK 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:

Group/Selection	Description
`Active`	The field has focus.
`Associated Property`	Property value specified in the control's Cell Property panel (`Value of associated property` option) 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 property` option 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. Most forms label a required field with an orange asterisk () .
`When Rule`	A when condition that you configure.

If the UI Element is Checkbox, you cannot apply conditions.

About Controls

Control form Completing the Control tab

Field

Description

Field

Description

Group/Selection

Description

Group/Selection

Description

Field

Description

Group/Selection

Description

Group/Selection

Description

Group/Selection

Description

Group/Selection

Description

Group/Selection

Description

Group/Selection

Description

Group/Selection

Description

Group/Selection

Description

Field

Description

Group/Selection

Description

Field

Description

Group/Selection

Description

Action

Description

Action

Description

Action

Description

Action

Description

Action

Description

Action

Description

Group/Selection

Description

Control form
Completing the Control tab