Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Harness form - Completing the Display Options tab

Updated on April 5, 2022

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 rules. See Skin form Components tab General Errors.

You can also use this tab to configure optional logging of each use at run time of this rule.

> Error 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.
  • Top of harness — In a standard error section at the top of the form.
  • In configurable section — In a custom section that you create and place on the harness.
Always show – Select this check box so that a form-level error message appears in the standard form-error section even when a field-level error occurs. This enables you to see both-field level and form-level errors.
Custom Error Section This field appears only when you select Displayed in Configurable Section in the Form-level errors field. To add the section do the following:
  1. Press the down arrow to select a section that will display the error message.
  2. Open the section. On the section's Design tab, type 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 tpen the section's Properties panel.
  4. In the Visible When field, select hasMessages from @baseclass and click OK.
  5. Save the harness.

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

Caution: If you select this option, the 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.
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 visible – Leave cleared in most cases. Select this check box to cause the entire run-time work item to scroll vertically as a single unit, except for the button bar and form error area which remain visible at the top.

> Presentation

Show container iconsSelect this check box to display container (header) icons to the user.
Enforce CSS minimum width Select this check box to enforce the Minimum Screen Width set in the skin. This determines the smallest width to which a user can compress the screen width before text is truncated and horizontal and vertical scroll bars appear. The minimum value provides consistent alignment by preventing columns and text from wrapping.

When the Enforce CSS minimum width check box is selected, the Minimum Screen Width setting, located in the Skin form — Components tab — Layouts — Legacy layouts, applies to all harnesses, regardless of whether the harness contains a Smart layout.

> Additional

Enable auditing Select to enable auditing of the user forms produced by this harness. Additional fields display.

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

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 reports on Log-DataAccessAudit instances, or export the data for analysis.

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


  • Previous topic Harnesses form - Completing the Design tab
  • Next topic Harness form - Completing the Scripts and Styles tab

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us