Harness, Section, and Flow Action forms
Adding a Text Input control

Field

Description

Select or type a property reference that identifies a single text value.

Alternatively, you can drag a property name from the lists of properties visible in the Application Explorer. Typically, this works for Single Value properties belonging to in the Applies to class of the current rule (or a higher class). If the container in which this field sits has a non-blank Using Page value, you can drag a Single Value property from within that embedded page property. B-16325 Rejected

Click the pencil icon () to review the property rule (if the reference is to an existing property in the Applies To class of this rule or a parent of that class). If the property is not found, the New dialog box for the property form appears.

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.

If this field is in a cell of a section that includes parameter declarations on the Parameters tab, you can enter the notation param.NAME here, to use a parameter value for the field, where NAME identifies a string parameter. Make sure that the NAME parameter is declared on the Parameters tab, and that your application provides a non-blank value for the parameter value in all possible situations where the section appears. See Section rules — Completing the Parameter tab. Proj-1424

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

Customizing the control

The control's default parameters are the ones you'll most likely use in your UI design for both edit and read-only modes. If you wish, you can customize the control within the context of the section that contains it. For example, you can:

• Specify the input box's width it in pixels or as a percentage rather than let the size of the cell determine the size.
• Obfuscate the text (passwords, for example) when entered or displayed.
• Add behaviors so that when the user hovers over the input box, the background color changes or SmartInfo appears.

Your edits apply only to the control within the section that contains it and do not update the underlying rule. You an add multiple controls of the same type within a section, each with its own custom settings. See Control Form — Completing the Control tab for descriptions of the available parameters and how to define behaviors.

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 Control Modes and UI Element settings.
4. Modify as necessary. To immediately render your changes, click OK in the dialog. If satisfactory, save the section. Your edits update the control's HTML in the section.

To establish a dynamic form action, click the magnifying glass icon () to open the Client Event Editor in a new dialog window. Complete the Client Event Editor to select an event (On Blur, On Change, or On Click) and the resulting form action. C-2526

Click the help icon ( ) on the Client Event Editor for assistance. For general information on this capability, see Implementing dynamic form actions and the Client Event Editor.

Client event support is not available for harness, section, or flow action rules that use directives.

Field

Description

• Choose Always, If Not Blank, or If Not Zero to have the field appear or be hidden based on the property value at the time this area of the work object form (section or flow action) is first presented or 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-1990 B-21692

When a user submits an HTML form, an input field that is not visible is not included in the HTTP details. Don't make an input field invisible if your application expects user input on the field. MARTT 2/28/07

If you selected Other Condition for the Visible field, complete this field. 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:

• 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 one or more comparisons involving a target property values to literal constant values and select the Run on Client? box. You can use parentheses and the && and || operators to group comparisons. At runtime, the result determines whether the content of this cell appears in read-only mode or in the mode of the enclosing layout. Examples: GRP-224

.Color =="Blue"

.Phone !="0"

(.Phone!="0")&&(.StateCode=="MA"||.StateCode=="VA"))

• 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

Select to indicate that the Condition field contains one more property comparison tests that will be evaluated on the user workstation in response to a client event. See Implementing dynamic form actions and the Client Event Editor. C-1990

Clear to indicate that the Condition field contains a when condition rule name or an expression to be evaluated once upon initial display of the form.

Selecting Required marks the label for this field with an orange asterisk () when the flow action form appears in read-write mode. (The asterisk also appears if the Label control's Value For field is not blank and the Label control's Required box is checked.)

For section rules, checking this box enables client-side format validation when this section is part of a harness form that has the Enable Client Side Validation box selected on the HTML tab. At runtime, users who leave this field blank and submit the form are notified immediately that the field is required; the form is not transmitted to the server. C-1197

Don't select Required if the field is hidden or read-only. At runtime, users can see the error message but cannot alter the field. SR-4488

• 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 checkbox.

Field

Description

As a best practice, use SmartLayouts to achieve uniform width of cells throughout your application's forms. You can set the width of SmartLayout templates using the Application Skin wizard.

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 cell is not controlled by SmartLayout column restrictions. In that case, you can also adjust the width this column directly:

1. Click a vertical wireframe cell border.
2. Wait until the pointer shape changes (), then drag the border. PROJ-281

As a best practice, use SmartLayouts to achieve uniform height of cells throughout your application's forms. You can set the width of SmartLayout templates using the Branding wizard.

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 all columns in the Layout are not controlled by SmartLayout column restrictions (that is, all columns have the None template). In that case, you can also adjust the height of a row directly:

1. Click a horizontal wireframe cell border.
2. Wait until the pointer shape changes (), then drag the border. PROJ-281

Optional. Enter a constant value for the property value, a property reference, or an expression, to be used only when the work object form or flow action form appears in read-write mode rather than read-only mode.

Click the magnifying glass icon () to start the Expression Builder. Click the pencil button () to review a property rule.

Choose a default value that speeds data entry. When the system renders a harness or section in read-only mode (for example because the read-write mode requires a privilege that the current user does not hold), the default value does not appear, because data entry is not permitted. B-14313 REJECTED MARTT 4/7/06

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.

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