Harness form
Completing the Advanced tab

  1. About 
  2. New 
  3. Design 
  4. Display Options 
  5. Scripts and Styles 
  1. Pages & Classes 
  2. Advanced 
  3. History 
  4. More... 

Each time you save a harness, Pega 7 generates source HTML from your entries on the other tabs of this form. Complete the fields on this tab to control how the HTML is generated.

Advanced Options

Field

Description

Enable Client Side Validation

Select to cause Pega 7 to immediately validate the format of user input to dates, integers, and other fields within the browser window when focus leaves the form field, before a user submits the form.

This feature can affect input of dates, times, text areas, and selected other properties, in sections of the user form other than the Take Action section. This feature depends on the control associated with the property. See client-side format validation.

Select when users are to enter dates, times, integers, or text through typing rather than through selection. Workstation-level validation can detect and mark invalid input earlier, and may consume less network traffic and bandwidth. Do not select if the user form presented by this harness contains only check boxes, selection lists, combo boxes, and other input widgets that do not require typing.

Standard client-side validation scripts are in the text file rule named webwb.CSValid.js; to allow for localization, the corresponding error messages are in the HTML fragment rule named CSValid. You can add custom client-side validation scripts or error messages on an application-wide by overriding the HTML fragment rule named UserWorkForm, which is included in the fragment WorkFormStandard, which in turn is included in the HTML code for every user form.

Enable Expression Calculation

Select to enable automatic recomputation and redisplay of all target properties of a Declare Expression rules that appear on the user form, and automatic evaluation of constraints rules associated with properties on this form, immediately after the user touches an input field. This feature is sometimes known as "calculated values".

You can select this check box if the user form defined by this rule:

  • Displays one or more properties computed by Declare Expressions rules using forward chaining, or one or more properties involved in constraints rules
  • Allows users to input a property value that affects the computed property (directly through forward chaining) or the constraints

Computation occurs (and the system updates the display) as user focus leaves the input field for a property. See More about Declare Expression rules.

For example, the form may contain a total that sums values entered into an array.

Portlet compliant

Select to generate portlet-compliant HTML that can be displayed by a portal server. Portlet-compliant HTML meets the requirements of Java Specification Request 168, which defines the portlet standard.

A portlet-compliant harness form can be sent to an external portal server through Service Portlet rules and displayed in a portlet window. A harness is considered portlet-compliant only when its sections are also portlet-compliant.

The standard harness Work-.SimpleConfirm provides an example of portlet-compliant form.

Localize

Select to indicate that at runtime, presentation of this harness will be localized based on field value rules in a language-specific ruleset.

For each locale, you must add field value rules in such a ruleset to support presentation of this section. Typically, use the Localization wizard and the Rules Inspector tool to identify, create, and maintain these field value rules. See:

This check box is available only when Generate For is set to JSP.

When Localize? is selected, the generated HTML calls the PublicAPI Java function getLocalizedTextForString() at runtime to convert text in the pyCaption, pyButtonLabel, pyActionLabel, pyActionPrompt and other properties to a locale-specific value.

Document Type

The Document Type determines the rendering of the application user interface. The Document Type is set on the Advanced Tab of the Application rule.

You can override the Document Type for the selected harness, if desired. If you do not want to override the Document Type set in the application, accept the default, Inherit from application rule.

Select one of the following to determine rendering of this harness:

  • Inherit from application rule: this harness renders using the Document Type set on the Advanced Tab of the Application rule.
  • HTML 5 (standards mode): this harness renders in standards mode, regardless of the Document Type set in the Application rule.
  • None (quirks mode): this harness renders quirks mode, regardless of the Document Type set in the Application rule.

HTML5 Document Type is the default for new applications, beginning with Pega 7. See HTML5 Application Readiness for more information.

IE document mode

Select one of the following to determine how document compatibility mode in Internet Explorer is utilized:

  • PRPC default: no compatibility mode. The browser will not emulate older versions of IE.
  • none: the same as PRPC default. No compatibility mode is set, so the browser will not emulate anything.
  • Other: allows you to set the X-UA-Compatible Mode on this harness to ensure that a specific version of IE can be emulated and overrides the compatibility view setting.
Client RunTime Version

Select to control which JavaScript files are included in the generated harness. In most cases, accept the default value.

  • 06-02— The default for a new harness. Improves initial page render time by moving all JavaScript to the end of the document.
  • 05-04+ — Setting client runtime to 05-04 disables script move to end and progressive streaming performance optimizations. When performance optimizations are enabled, harness operation may be impacted by including non-auto sections containing third party controls or invalid HTML.
    To reduce the runtime workstation memory requirements from this harness form, do not include three JavaScript files: DynamicSelect, SmartPrompt, and PRWBSScripts.js) in generated HTML code for this harness. Either these three are not needed by any control, section, or other parts of the form, or the generated HTML code for the control, section, or other parts of the form incorporates one or more of these three scripts directly.
  • 05-03 — Displays only if a harness . This harness does not meet the above criteria for 05-04+ setting. (Deprecated; use only when necessary)

Choosing the 06-02 setting when possible improves performance by reducing the quantity of JavaScript code required on the client workstation at runtime, potentially reducing the amount of workstation memory required by the browser.

If your application includes custom versions of the standard controls DynamicSelect, SmartPromptforClass, SmartPromptForDataClass, or other SmartPromptzzz rules, select 05-03.

Selecting 05-04+ excludes the legacy scripts file prscripts.js from the generated HTML code. Choose 05-03 if your harness references custom controls that use scripts in the prscripts.js file.

When entering HTML source code directly into the HTML tab of a control (or similar form), you can minimize the size of the resulting HTML document with the <pega:onlyonce > and <pega:static > tags.

Frame Source

Displays if Portlet compliant is not selected.

Optional. Enter an HTML <FRAMESET > element if you want to present the harness as a set of frames.

ID

Optional. Enter an alphanumeric ID for this layout for use in JavaScript functions.

The ID attribute is applied to the <body> HTML element in the harness, for easier reference in custom scripts and styles.

HTML Source (Read Only)

Select the expand icon to view a read-only display of the generated HTML. You can review, but not directly alter, the HTML text on this tab.

At runtime, Pega 7 uses stream processing to evaluate the JSP tags and this source HTML (which references properties and other rules such as HTML fragment rules, HTML rules, controls, and sections) in the context of the current clipboard contents and static files.

Pega 7 then returns the resulting HTML to the browser on the client workstation.

Definitions active property, open authoring
Related topics JavaServer Pages tags
How stream processing works

Up About Harnesses