Harness, section and flow action forms

Show all

A section rule can appear within another section, within a harness rule, or within a cell of a layout. (You cannot edit a section that is within a cell directly; open the section rule.)

Sections define reusable rectangular sub-areas of a harness, section, or flow action. For example, the standard section Work-.CoreSummary is included in both the Work-.New and Work-.Perform harness rules. This achieves modularity, ensures a uniform appearance, and reduces the number of rules you need to maintain and update when you later need to revise work object forms.

Before you save a Harness, Section, or Flow Action form, review and adjust the layout. If a section is expanded when you save the form, it appears initially expanded at runtime; if a section is collapsed when you save the form, it appears initially collapsed at runtime.

You can embed sections within sections within sections. The maximum recommended depth is four levels.

Drag and drop the Section control

Click the down-arrow ( ) at the right end of the Layout control group () and select the Section control (). Drag the control. When the pointer changes shape to indicate that you can drop the control, release the mouse button. Click the magnifying glassto display the Containers panel.

Adding sections to harness and flow action rules

Drop the section in a cell. Complete the Section Include panel.

Adding sections to sections

You can add a new section to an existing section rule in either of two ways: nested or peer. A peer section appears below the current section rule, and may present properties from a different page (of a different class) than the Applies To class in the key of the current section.

To include an additional section as a nested section:

Drag and drop the section control
() into a cell. The cell border becomes yellow.
Complete the pop-up prompts to identify the section key: Applies To and Purpose.
Click the magnifying glass icon () and complete the Section Include panel.

To include an additional section as a peer to the current section:

Ensure that SmartFrames gridlines are visible. If gridlines are not visible, click to present the SmartFrames wireframe preview.
Drag and drop the section control () onto the Layout box at the top of a section. The entire layout border becomes yellow.
Complete the pop-up dialog box that appears. Select the On different object check box if the inserted section is to be based on a different page than the current section.
Identify the selection by completing the Applies To and Purpose key parts. SmartPrompt is available
Click OK . The included peer selection appears below the current section. The system updates the Pages & Classes tab to reflect the additional class.

Case A: Section is in a table cell — Cell Properties panel

If the section is in a table cell, complete all three tabs of the Cell Properties panel. If the panel is pinned (), the wireframe presentation on the rule form changes immediately to reflect of your inputs. If the panel is not pinned (), click Apply to apply your inputs.

Top fields

Field

Description

Use Section

Select or confirm the Purpose key part of the section rule. Click the pencil icon () to open or create the section rule. Click the magnifying glass icon ( ) to enter parameters for the section or to share the current parameter page with the section.

Refresh When

Optional. Enter a simple Java expression evaluated upon JavaScript events as part of a client event to cause this section to refresh from the server when the expression evaluates to true.

For example, enter .Color =="Blue" in this field to make this section refresh when the property Color changes to the text value Blue. See Implementing dynamic form actions and the Client Event Editor.

General tab

Field	Description
Width	Optional. Enter a positive number for the width in pixels of this cell. (At runtime, normal browser processing for rendering tables determines the actual displayed width.) This field appears only when the Unit field in the Layout panel or Repeat panel (for the layout containing this cell) is set to `px fixed`. You can also adjust the width of columns directly: Click a vertical wireframe cell border. Wait until the pointer shape changes (), then drag the border.
Height	Optional. Enter a positive number for the height in pixels of this cell. (At runtime, normal browser processing for rendering tables determines the actual displayed height.) This field appears only when the Unit field in the Layout panel or Repeat panel (for the layout containing this cell) is set to `px fixed`. You can also adjust the height of a row directly: Click a horizontal wireframe cell border. Wait until the pointer shape changes (), then drag the border.
Visible	Select `Always` or `Other Condition`. 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.
When	If you selected `Other Condition` for the Visible field, complete this field. Enter an expression involving other properties, or identify the When Name key part of a when condition rule. Specify one of three outcomes: 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 target properties 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 =="Red" in this field to make this section visible when the property Color has the value Red, and invisible otherwise. Depending on the state of the Run on Client check box, the comparison can be executed only once as the form is initially displayed, or dynamically. You can use parentheses and the \|\| and && operators to group and combine multiple single-property comparisons. See Implementing dynamic form actions and the Client Event Editor.
Run on Client	This field appears only if you select `Other Condition` for the Visible field and a simple expression in the When field. Select to indicate that the When field contains a simple property comparison test that will be evaluated on the user workstation in response to a client event. See Implementing dynamic form actions and the Client Event Editor. Clear to indicate that the When field contains a when condition rule name or an expression to be evaluated once upon initial display of the form.
Read Only	Select to cause the section to be presented in read-only styles, even when the form is in read-write mode, always or conditionally.
When	Optional. Enter an expression involving another property, or identify the When Name key part of a when condition rule. Specify one of three outcomes: Leave blank to present the content in read-only mode always, regardless of the mode of the enclosing layout. When condition rule — Enter the When Name key part of a when condition rule that determines the mode 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, and executes the When rule once as it renders the form. 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. This field appears only when you select the Read Only check box.

Advanced tab

Field	Description
Read-Write Style	Optional. By default, when the work object form or flow action form appears in read-write mode, the CSS style named `DataValueWrite` applies. You can enter another style name or select from those listed. Click the pencil icon () to review the text file rule that defines the style sheet. Your application can override the standard style sheet.
Read-Only Style	Optional. By default, when the work object form or flow action form appears in read-only mode, the CSS style named `DataValueRead` applies. You can enter another style name or select from those listed. Click the pencil icon () to review the text file rule that defines the style sheet. Your application can override the standard style sheet.
Inline Style	To apply inline styling to this cell only, 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 standard CSS rules. 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, 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.

Case B: Section Include

If the section you entered is not within a cell, complete the Section Include panel.

Field	Description
Include Section	You can review or change the section you identified earlier.
Visible When	Optional. To control visibility of the section, enter or select one of the following: Leave blank to present the section always. A 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 the body 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 styles or in the styles of the enclosing layout. For example, enter .Color =="Red" in this field to make section body visible when the property Color has the value Red, and hidden otherwise. Depending on the state of the Run on Client? check box, the expression can be executed only once as the form is initially displayed, or dynamically. See Implementing dynamic form actions and the Client Event Editor.
Refresh When	Optional. To force refresh of this section based on a test , enter a simple Java expression evaluated upon JavaScript events involving a property comparison or multiple property comparisons using the \|\| and && operators and parentheses.
Using Page	Identify the name of the page that is the basis for fields (properties) within this section. Leave this field blank if the page is the one matching the Applies To key part of the rule.
View Privilege	Optional. To restrict the presentation of this section (in read-only mode) to those users who hold a specific privilege, select a privilege name. Click the pencil icon () to review or create the privilege rule.
Update Privilege	Optional. To restrict the presentation of this section (in read-write mode) to those users who hold a specific privilege, select a privilege name. Click the pencil icon () to review or create the privilege rule. If a user holds the privilege in the View Privilege field but does not hold the privilege identified in this field, the section appears in read-only format. In this case, default values for fields are not shown.