Harness form
Completing the Layout tab — Adding a container

Field

Description

Select No Header, Standard Header, or Custom. If you select Standard Header, also complete the Header tab. If you select Custom, also complete the Custom tab. When included, the header appears as a bar or tabs above the container content, and is visible and clickable even when the container content is collapsed.

Identify the Stream Name key part of an HTML rule that defines the contents and appearance of a custom header. The system uses the Applies To key part of this harness rule as the first key part of the HTML rule.

This field is visible only when you select Custom Header for the Header field.

Optional. Enter literal text, a reference directive, reference JSP tag, Lookup directive, or JSP tag to derive the text to appear in the left title area of a header. For example, enter

{.pyLabel}

or equivalently

<pega:reference name=".pyLabel" />

to use the value of a property named pyLabel as a title.

This field is visible when you select Standard Headers for the Header field.

If your application is to support users in multiple locales, choose a noun or noun phrase for the caption. When practical, choose a caption already included in a language pack, to simplify later localization. Select the Localize? box on the HTML tab. Limit title text to no more than 64 characters, even after JSP or directive tags are expanded. See About the Localization wizard.

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

• Leave blank to present the container 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 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? check box, 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.

Don't confuse Expanded When with Visible When. When collapsed but visible, the clickable header appears. When not visible, nothing appears.

This check box appears only if the Visible When field contains a simple Java comparison.

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

Optional. Identify the name of a clipboard page on which the properties referenced in this expansion area are to be found. By convention, the page containing the work object is named pyWorkPage.

If you leave this field blank, Process Commander assumes that properties referenced in this expansion area are found on the primary page of the activity that displays the harness form. If, at runtime, no page with this name is found, all HTML output from this row is suppressed — both the top-level header and the included sections.

This field is not visible when you select No Header for the Header field.

Choose the format to be used to present this header:

• Bar — A horizontal bar that is always present. The section appears as a single horizontal strip; all labels and values visible on the strip.
• Collapsible — A horizontal bar marked with a + or - sign that marks an area below the bar that users can expand or collapse (hide).
• Tabbed — A labeled tab (). Users can click one tab to make it front-most, hiding other tabs temporarily.
• Accordion — A labeled accordion-style layout. At runtime, users can click one bar to make its content appear; this also hides the content of other accordion bars in the container.

Optional. If you choose Bar or Collapsible as the Header Type, you can identify a small image to appear at runtime to the left of the title text. Enter the relative path to a binary file image, in the format path/name.ext.

For example, enter image/3dball.gif in this field for the 3dball image. This bar contains the 3dball.gif image:

If you choose Collapsible, accordion, or Tabbed as the Header Type, clear this box to force details for this header to be transmitted to users' workstations upon initial display, even when the header is initially collapsed.

Select this box to instruct Process Commander to transmit the details for this header to the browser on the user workstation only when a user clicks a plus sign or tab to view the expanded details of this header.

By default, the setting is selected. Deferred loading technique can speed up the initial harness form display, by reducing the amount of HTML text sent to and processed by the workstation browser. Fields that do not interest most users are not transmitted unless the browser client sends an explicit request later. (This check box is only meaningful when the Header Type is Collapsible and the container is initially presented as collapsed.)

Optional. If Defer Load? is selected, you can specify an activity to be run when the container is expanded at runtime by a click on the Collapsed image ( or ). This activity can compute property values and other aspects of the expanded container.

Select if you chose Tabbed or Accordion as the Header Type and you want to start a new row of tabs or accordion bars with the sections in the group.

Select to cause all parts of the horizontal header area and all parts of the section rules referenced in this container to appear in read-only mode (and with read-only styles) always, or based on a when condition rule, even when the form is in read-write mode. Complete the next field to modify the effect of this check box.

This field appears only when you select the Read Only? check box.

Optional. Identify the When Name key part of a when condition rule that at runtime determines whether the content of this contain appears in read-only mode (with read-only styles) or in the mode of the enclosing layout. Leave blank to present the content in read-only mode always, regardless of the mode of the form.

You can override this result with Read Only settings and conditions for specific elements inside the container.

The system evaluates this condition once, when it renders the work object form. You can implement dynamic, client-side condition tests for cells within the layout inside the container, but not for the entire container.

Field

Description

Optional. Identify the name of a CSS style for the container. Click the pencil icon () to review the text file rule that contains the style.

Optional. If you choose Collapsible for the Header Type field, identify the When Name key part of a when condition rule to control whether the container is initially presented as expanded or collapsed. At runtime, the system uses the Applies To key part of the harness rule to locate the when rule. The when rule is executed only once, when the harness rule is first rendered.

Don't confuse Expanded When with Visible When. When collapsed but visible, the clickable header appears. When not visible, nothing appears.