Back Forward Harness form
Completing the Display Options tab

 About Harness rules

Optional. Complete the Display Options tab to control the presentation of form-level and field-level error messages. For additional instructions and an example, see the Pega Developer Network article PDNPRKB-25150 How to customize the presentation of errors on work object forms.

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

Field

Description
Form Error Configuration

Form-level errors are reported against properties not present on the current form. By default they appear on the top of the form in a gray box. Optionally, you can choose to display them in one of three ways:

  • Default — Form-level error messages are displayed at the top and bottom of the work object form. If the form is presented in action mode, form-level error messages will display at the top. (This choice matches pre-V5.4 presentation.)
  • Top of harness — Form-level error messages display at the top of the form as you scroll down the screen.
  • Displayed in Configurable Section — Form error messages will display in a customizable section on the harness.

TipYou can customize the fonts, colors and other styles used in the form errors section with the Application Skin wizard, at Step 4A.
Custom Error Section

SmartPromptThis field appears only when you choose Displayed in Configurable Section in the Form Error Configuration field. Select the configurable section that will display errors on the harness.

Field Error Configuration

Field-level errors are reported against properties that are present on the current form. By default, they are indicated by a red X next to the field in error. Optionally, you can choose to display them in one of two ways:

  • Displayed as Image with Tooltip — Field-level error messages display with a custom error image with the error message text in a Tooltip.
  • Displayed as Full Error Text — Field-level error messages display with the full error text next to the field.
Keep fixed header/footer visible

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

Auditing

Complete these optional fields to record each time a user requests the work object form based on this harness rule. 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 rule, Customer party (if any) and work object 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 work object forms produced by this harness rule. 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 work object form based on this harness rule. To find this when rule at runtime, rule resolution uses the Applies To key part of this harness rule 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 work object form based on this harness rule (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 rule as the Applies To key part of the activity rule.

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 object. Your activity can use the Obj-Save method with WriteNow enabled, to ensure that logging occurs even when the work object 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 rule.
  • pyRuleClass — Rule-HTML-Harness
  • pyRuleAppliesToClass — The Applies To key part of this harness rule
  • pyRulePurpose — The Action Name key part of this harness rule.
Screen Size  
Has Minimum Width?

Select to have the system at runtime conform to Smart Layout 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.

zzz About Harness rules