Back Forward Harness form
Completing the Display Options tab
  1. About 
  2. New 
  3. Layout 
  4. Scripts and Styles 
  5. Pages & Classes 
  6. HTML 
  1. Display Options 
  2. History 
  3. More... 

Optional. Complete the Display Options tab to control the presentation of form-level and field-level error messages. You can customize the fonts, colors and image used in field-level messages in the Skin rule. See Skin form — Styles tab — General — Errors.

Also use this tab to configure optional logging of each use at runtime of this rule.

Field

Description
Display Form-Level errors  
 

Form-level errors are reported against properties not present on the current form. By default, the messages appear in a standard form-error message section. You can display the error messages in one of three ways:

  • Default — In a standard error section at both the top and bottom of the user form. If the form is presented in action mode, form-level error messages display at the top. (This choice matches pre-V5.4 presentation.)
  • Top of harness — In a standard error section at the top of the form.
  • Displayed in Configurable Section — In a custom section that you create and place on the harness.
Always show form level errors Check this box so that a form-level error message appears in the standard form-error section when a field-level error occurs.
Custom Error Section

SmartPromptThis field appears only when you choose Displayed in Configurable Section. To add the section do the following:

  1. From SmartPrompt, select or create a section that will display the error message.
  2. On the section's Layout tab, enter the message text in one or more label fields on the layout, and save the rule.
  3. Include the section on the harness where you want the message to appear.
  4. Open the section's Properties panel.
  5. In the Visible When field, select hasMessages from @baseclass and click OK.
  6. Save the harness.

For an example, see PDN article 26403 How to create a custom error section in user forms.

If you select this option, standard form-level error section will not appear. Therefore, make sure that you add the custom section to the harness layout. Otherwise, no messages will appear. Optionally, you can use the Displayed in Configurable Section option, add the section specified here to the layout, and change the option to Default or Top of harness — both the custom and standard form-level error section will appear.
Display Field-Level Errors  
 

Field-level errors (such as leaving a required field blank) are reported against properties on the current form. You can display them in one of two ways:
Keep fixed header/footer visible

Leave cleared in most cases. Check this box to cause the entire runtime work item to scroll vertically as a single unit, except for the button bar and form error area which remain visible at the top.
Container Icons  
Show Container Icons

Clear this checkbox so that the header icons are not displayed to the user.
Screen Size  
Has Minimum Width?

Select to have the system at runtime conform to SmartLayout styles in the skin that determines the smallest width a user can compress the screen width before text is truncated and when horizontal and vertical slide bars appear.

The minimum value provides consistent alignment by preventing columns and text from wrapping.

Auditing

Complete these optional fields to record each time a user requests the user form based on this harness. Each time the form appears, your application can add an instance of the Log-DataAccessAudit class, to support later compliance auditing, reporting, and analysis. The added instance identifies the date, time, Operator ID, harness, Customer party (if any) and work item ID.

Logging occurs upon initial display of the form; it does not require that the user update any fields. You can create list view rules and summary rules to report on Log-DataAccessAudit instances, or export the data for analysis.

(On the Security tab of the Flow Action form, you can provide a similar logging capability for flow actions.)

NoteEnable this feature only if such detailed auditing is needed in your application. Auditing increases the database workload of your application and can produce large volumes of log data.

Field

Description
Auditing  
Audit Use?

Select to enable auditing of the user forms produced by this harness. The When and Audit Activity fields become visible.
When

SmartPromptOptional. Enter the When Name key part of a when condition rule that is evaluated each time a user displays a user form based on this harness. To find this when rule at runtime, rule resolution uses the Applies To key part of this harness as the Applies To key part of the when rule. If the when rule evaluates to true, the activity in the Audit Activity is executed.

If blank, the activity is always executed.
Audit Activity

SmartPromptEnter the Activity Name key part of an activity to run when a user requests a user form based on this harness (and the When condition, if not blank, evaluates to true). To find this activity at runtime, rule resolution uses the Applies To key part of this harness as the Applies To key part of the activity.

You can use the standard activity Work-.Audit here, or a similar activity that meets the needs of your application and adds an instance to the Log-DataAccessAudit class. The Work-.Audit activity records the full name and identifier of a work party with the party role Customer, if present. Your application can choose to record a different role or other facts about the work item. Your activity can use the Obj-Save method with WriteNow enabled, to ensure that logging occurs even when the work item is displayed but not updated.
Params

If the activity uses input parameters, click to provide values for each parameter. The system automatically completes the following four parameter values; you do not need to complete them.

  • pyRuleKey — Handle (pzInsKey) of this harness.
  • pyRuleClass — Rule-HTML-Harness
  • pyRuleAppliesToClass — The Applies To key part of this harness
  • pyRulePurpose — The Action Name key part of this harness.

Mobile

This section will appear only if the Pega-Mobile RuleSet is part of your application.

Field

Description
Mobile  
Supplemental Toolbar Navigation Rule

SmartPrompt Optional. Enter the name of a navigation rule to render as a supplemental toolbar navigation menu. The nodes specified in this rule appear in the toolbar navigation menu in addition to the nodes defined in the Toolbar Navigation Rule field of the mobile portal rule.

NoteTo display the toolbar navigation menu, rule resolution checks:

  • the required Toolbar Navigation Rule field of the mobile portal rule.
  • the Supplemental Toolbar Navigation Rule field on the Display Options tab of the Harness rule form.

Be careful to reference a navigation rule of type Mobile. If you reference a Standard type navigation rule, a validation error will appear when you save the harness.

Up About Harnesses