Back Forward Harness, Section, and Flow Action forms
Adding a section

About Harness rules

  Show all 

A section rule can appear within another section, panels and containers within a harness rule, or within a layout cell. (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.

Tip 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.

Tip You can embed sections within sections within sections. The maximum recommended depth is four levels. CLINIC 7/11/06

  Drag and drop the Section controlupdated v6.1 pashm

Click the down-arrow (Arrow) at the right end of the Layout control group (Layout 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.

How to add sections

You can add a section rule to an existing section, harness, or flow action in either of two ways: nested or peer.


To add a nested section:

  1. Drag and drop the section control (Section) into a layout cell.
  2. Click the magnifying glass icon (Magnifying glass) and complete the Using the Cell Properties panel as described below.

To add a peer section: KARAF WERDA 3/7/06 clinic

  1. If the SmartFrames gridlines are not visible, click Gridlines to present the SmartFrames wireframe preview.
  2. Drag and drop the section control (Section) above or below a layout or section. As you move the cursor over the existing frames, a yellow line indicates where the section will be dropped.
  3. When you drop the section, the Include Section Rule dialog appears. Edit the fields as described below:

Field

Description

On different object

Click the checkbox if you want to add a section rule using a page other than the current section rule.

Applies To

SmartPrompt By default, the the Applies To key part of the current section appears in this field. If you wish, you can select a a child or ancestor class.

Purpose

SmartPrompt Select the Purpose key part of the section rule.

Using page

This field appears when you select the On different object checkbox. Identify the name of the page that is the basis for fields (properties) within this section. If the page is in the same class as the current rule, the system updates the Pages & Classes tab when you save the rule. If you name a page in a different class, the name must be defined on the tab before saving the rule.

Of class

SmartPrompt This field appears when you select the On different object checkbox. By default, the Applies To key of the current section appears. If you wish, select a different Applies To key. The class name must be defined on the Pages & Classes tab of the current section rule before you save the rule.

Purpose

SmartPrompt This field appears when you select the On different object checkbox. Select the Purpose key part of the section rule.

  1. When you exit the dialog, a Section Include header appears in the wireframe. If you want to update the settings in the Section Include panel, display it by clicking the magnifying glass icon (Magnifying glass). See Using the Section Include panel below. Click the pencil icon to open the referenced section rule. If enabled, click to check out the rule. Click to check it back in or click to delete the copy.

  Using the Cell Properties panel

If the section is in a layout cell, complete the fields and tabs of the Cell Properties panel. If the panel is pinned (Pinned), the wireframe presentation on the rule form changes immediately to reflect of your inputs. If the panel is not pinned (not pinned), click Apply to apply your inputs. GRP-229

Top fields

Field

Description

Use Section

SmartPromptSelect or confirm the Purpose key part of the section rule. Click the pencil icon (Pencil) to open or create the section rule. Click the magnifying glass icon ( Magnifying glass) to enter parameters for the section or to share the current parameter page with the section. The Applies To key is, by default, the same as the current section. pashm v6.1

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. GRP-229

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. C-1990

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:

  1. Click a vertical wireframe cell border.
  2. Wait until the pointer shape changes (drag), then drag the border. PROJ-281
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:

  1. Click a horizontal wireframe cell border.
  2. Wait until the pointer shape changes (drag), then drag the border. PROJ-281
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

SmartPrompt 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. PROJ-283 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 (Pencil) 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 checkbox, 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. C-1990
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

SmartPromptOptional. Enter an expression involving another property, or identify the When Name key part of a when condition rule. PROJ-283 Specify one of three outcomes: REMOVED RUN ON CLIENT per KUCHS 3/7/07

  • 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 (Pencil) 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 checkbox.

Advanced tab

Field

Description

Read-Write Style

SmartPromptOptional. 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 (Pencil) to review the text file rule that defines the style sheet. Your application can override the standard style sheet.

Read-Only Style

SmartPromptOptional. 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 (Pencil) 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, text align, vertical align PROJ 242 – TASK 16156, 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.

 Using the Section Include panel

The system updates the Pages & Classes tab to reflect the additional class.

Field

Description

Use Section

You can review or change the section you identified earlier.

Format

SmartPrompt Choose a format to control what appears above the layout (known as a header or subheader), and the appearance of both the header and any subheader, and aspects of the body.

This choice primarily affects styles and appearance. Information in or below a subheader (including Hidden Sub) presents information that is right-indented from information in a header.

Using the Branding wizard, you can review or revise the styles (colors, fonts, padding and margins) associated with each header or subheader format.

Group/Selection

Description

Default

 
No Format No header or subheader appears. In addition, no styles applied to the body that are specific to this layout, including background, fonts, colors, padding, margins, and so on. The appearance of the body depends on styles of the enclosing control (which may be another layout).

Header

 

Standard For a bolder or more prominent header.
Custom For a custom header. Select in the HTML field an HTML rule that defines the content and appearance of the custom header.
Hidden For no header. (This option is not available for the top-level of a harness rule).

SubHeader

 

Standard (sub) For a bolder or more prominent sub header.
    A

  B

  C

  D

  E
These names are provided so that you can apply separate styles to up to six types of subheaders (including the basic SubHeader). For example, if your forms include three hierarchical levels of subheaders, you can select A for the highest level, B for the middle level, and C for the lowest level.

In the standard style sheets, these subheaders function identically; they differ only in minor ways in the presentation of the subheader:
  • A — No bar in the subheader
  • B — Underlined subheader label
  • C — Outline border
  • D — Black font
  • E — Preserves V5.5 flow action styles for layouts created from V5.5-style flow actions. BUG-26946 V6.1SP1.
Outline Provides no header area, but a border around the contents of the layout with a single text label. (This produces HTML FieldSet and Legend elements.)
Hidden (Sub) Provides no subheader, but indented body.
In the workform CSS style sheets, the various styles named groupTitleBarzzzz define the appearance of the SubHeader element; for example groupTitleBarBackground. For A, the corresponding styles are named a_groupTitleBarBackground and so on. Similarly, the names of styles for B, C and D start with b_groupTitleBar, c_groupTitleBar, and d_groupTitleBar respectively.
Title

Enter text to appear in the header or subheader. This text may include directives or JSP tags, such as <p:r > or <pega:lookup >.

NoteIf you plan to localize the application using this rule so the application can support users in various languages or locales, choose the text carefully and limit the length to no more than 64 characters. When practical, choose a caption already included in a language pack, to simplify later localization. A field value rule with this text as the final key part is needed for each locale. See About the Localization wizard.

This field is not visible if the Format field contains No Format, Hidden, or Hidden (Sub).

HTML

This field appears if the Format field contains Custom. Identify the Stream Name (second key part) of an HTML rule that defines the content of the header.

Visible When

Optional. To control visibility of the section, enter or select one of the following:

  • Leave blank to present the section always.
  • SmartPromptA when condition rule. SR-7276 B-25698 BUG-1665 gone? Click the pencil icon (Pencil) 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? checkbox, 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. C-1990
Refresh When

Optional. To force refresh of this section at runtime 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. Click the pencil icon (Pencil) to review or create the property rule.

General tab

Not used

Advanced tab

Field

Description

Active When

SmartPromptOptional. To control the conditions under which the section controls are active, enter the following:

  • Leave blank so that the section is always active.
  • SmartPromptA when condition rule. SR-7276 B-25698 BUG-1665 gone? Click the pencil icon (Pencil) 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? checkbox, 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. C-1990
Body Visible When

SmartPrompt Optional. To control visibility of the body of the section, enter or select one of the following:

  • Leave blank to present the body always.
  • SmartPromptA when condition rule. Click the pencil icon (Pencil) 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. 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 the body visible when the property Color has the value Red, and read-write styles 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.
This field is not visible if the Format field contains No Format, Hidden, or Hidden (Sub).
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

SmartPrompt 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 (Pencil) to review or create the privilege rule.

Update Privilege

SmartPrompt 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 (Pencil) to review or create the privilege rule.

NoteIf 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. B-14313 rejected MARTT 4/7/06

Up About Flow Action rules

Up About Harness rules

Up About Section rules