Section, Harness, and Flow Action forms
Adding an Icon control

Field

Description

(Appears only when this field is in a section included within the current open rule.) Click to open the section that immediately contains the field.

() to review the control rule identified in this field.

Customizing the control

The Icon's default parameters represent the basic configuration. However, you will need to specify the binary file used for the icon and the action or actions that will execute when the user clicks or hovers the mouse pointer over the icon. For example, you can configure the control to refresh a section or display a new harness. In addition, you may want to:

• Add a label or tooltip.
• Add conditions that, for specific users, disable or hide the icon.

Do the following to customize an auto-generated control rule in a section:

1. Open the section or harness that contains the rule.
2. Select the cell containing the rule and open its Cell Properties panel.
3. In the panel, select the magnifying glass icon () next to the Control field. This displays the control Parameters dialog, which contains most of the settings in the underlying rule's Control tab. (You cannot edit the rule form's Control Modes and UI Element settings from here.)
4. Modify as necessary. 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.

Icon Name

Icon and Action

Control Rule

— Adds (above or below) a row to a grid, tree, or tree grid layout

— Adds a new work object using the primary page data. Saves the new work object on the deferred list.

— Presents a list of work object attachments, so users can view or add attachments. This icon appears only for users who hold the Work-.AccessAuditTrail privilege.

— No action is associated with it.

— Closes the current form without applying any changes.

— For a cover work object, changes the form to allow users to view and navigate among the covered work objects. You can override a standard list view rule to control details of this display. See Understanding covers. C-2579

— Removes a row in a grid, tree, or tree grid layout.

— Presents the work object form in review-only mode; inputs allowed in the action section only.

— Redraw the form with all areas fully expanded.

— For a folder work object, changes the form to allow users to view and navigate among the associated work objects.

— Submits changes and marks this assignment as complete.

— Cancels any unsubmitted changes and finds the most important assignment to work on next.

— Displays the work object history, for users who hold the Work-.AccessAuditTrail privilege.

— Starts browser-based printing, which prints the current work object 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.

— Reopens a resolved work object, for users who hold the Work-.Reopen privilege. Runs the standard activity Work-.Reopen or your application override.

— Presents the work object form in review-only mode, allowing no updates.

— Saves the work object with Submit.

— 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. This icon appears only to users who hold the Perform privilege. SR-1430 B-17011

If the harness rule is a New harness — one supporting the entry of new work objects — do not include the Show Flow Location icon in most cases. A flow execution doesn't start until users submit a work object form. If you do include this icon in a New harness, use a when condition rule to disable the icon at runtime unless a non-blank work object ID exists. GROVS 2/9/06

— Shows the form in review mode but allows users to reopen a resolved work object. Available to users who hold the Work-.Reopen privilege. Runs the standard activity Work-.Reopen or your application override.

— Enables spell-checking. See How to enable spellchecking in work object forms.

— Redraws the form in update mode. Appears only for users who hold the Work-.Update privilege. Update mode allows changes to values that appear in sections other than the TAKE ACTION section.

This capability is not desirable in all applications, as it allows users to overwrite values entered previously, perhaps by other users.

The  Apply   button sends changed user inputs to the server, but does not commit these changes. The user must select and complete a flow action to save the changes. See Understanding transactions in flow executions. Clinic 9/6/05

Field

Description

• Choose Always to have the icon appear or be hidden based on the visibility of the enclosing section or flow action when the form is first presented or is refreshed. This condition is checked only once.
• Choose Other Condition to make the visibility depend on a when condition rule, a Boolean expression evaluated only once, or a test evaluated repeatedly upon JavaScript events. C-1990B-21692

• When condition rule — Enter the When Name key part of a when condition rule that determines the visibility of this field at runtime. The system uses the Applies To key part of the current rule in rule resolution to locate the when condition rule. Click the pencil icon () to review or create the when condition rule.
• Expression evaluated once — Enter an expression that returns true or false. This expression can involve multiple properties, function calls, and other syntax as supported by the <pega:when > JSP tag.
• Simple Java expression evaluated upon JavaScript events — To dynamically control the visibility of this property with a JavaScript event, enter a simple comparison involving a target property and select the Run on Client? box. The result at runtime determines whether the content of this cell appears in read-only mode or in the mode of the enclosing layout.
  For example, enter .Color =="Blue" in this field to make this field visible when the property Color has the value Blue, and invisible otherwise. Depending on the state of the Run on Client checkbox, the comparison can be executed only once as the form is initially displayed, or dynamically. See Implementing dynamic form actions and the Client Event Editor. C-1990

An icon that is not visible is also disabled and cannot be clicked.

Select to cause dynamic execution of the condition each time the value of the property mentioned in the condition changes. (Mark the field containing that property as a Client Event.) Leave cleared to cause the condition to execute only once, upon initial presentation of the form.

Field

Description

The SmartPrompt list shows all styles that start with the word Data. You are not limited to these styles.

Click the pencil icon () to review the text file rule that defines the style sheet. Your application can override and extend this style sheet in an application text file rule.

Optional. By default, when the work object form or flow action form appears in read-only mode, the CSS style named DataValueRead or DataValueRead RV2 applies. If this cell is not controlled by Smart Layout restrictions, you can enter another style name or select from those listed.

The SmartPrompt list shows all styles that start with the word Data. You are not limited to these styles.

Click the pencil icon () to review the text file rule that defines the style sheet. Your application can override and extend this style sheet in an application text file rule.

Inline styles are recorded in the generated HTML for the form; they do not alter the CSS definitions.

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.