Skip to main content

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

Configuring display options for a harness

Updated on February 7, 2022

Define the look and behavior of your application by setting display options at a harness level. Display options help you configure error presentation, container settings, and harness auditing to further customize your user interface.

For example, you can set up a section to display a customized message when the harness registers an error.

  1. Search for and open the harness that you want to edit.

  2. On the Display options tab, in the Form-level errors list, define how you want to display form-level errors:

    • To display errors in a standard section at the top and bottom of the user form, select Default.
    • To display errors in a standard section at the top of the user form, select Top of harness.
    • To display errors in a custom section that you place in the harness, select In configurable section, and then, in the Custom error section field, define the section that contains the error message.
    For example: To display errors in a custom section, select Custom error section, and then enter the name of the target section, for example customError.
    If you decide to use a custom section, the standard form-level error section is not displayed at run time. Therefore, ensure that the harness layout contains the custom section. Otherwise, the system does not display error messages.
  3. To display form-level errors even when a field-level error occurs, select Always show.

  4. To cause the entire run-time work item to scroll vertically as a single unit, select Keep error display visible.

  5. In the Field-level errors list, define how you want to display field-level errors:

    • To mark fields with errors with a standard error icon and display error text in a tooltip, select As image with tooltip.
    • To display the error text above the field with the error, select As full error text.
  6. To display header icons, select Show container icons.

  7. To force the harness to adopt the minimum width that is defined in the skin rule, select Enforce CSS minimum width.

    For more information, see Skins.
  8. To record every time that a user requests the form that is produced by the harness, select Enable auditing, and then define the when condition for the audit.

    Each time that the form is displayed, your application can add an instance of the Log-DataAccessAudit class to support auditing, reporting, and analysis. The added instance identifies the date, time, operator ID, harness, customer party and work item ID.
  9. For harnesses that are the basis of a landing page in a portal, in the Initialization section, define the behavior of the harness on load:

    1. In the Visibility list, define when the users can see the harness.

    2. To launch a data transform when the harness loads, in the Data transform field, enter target data transform.

      For more information, see Data transforms.
    3. In the Activity field, enter the activity that you want to launch when the harness loads.

      For more information, see Available UI actions.
      Note: Applications that use Cosmos React UI do not use harnesses for landing pages. You can modify Cosmos React UI landing pages only in App Studio.
  10. In the form, click Save.

For example: In this scenario, when the harness registers and error, the UI displays a custom section. In preparation, you create a customError section that contains the target error text, and then add that section to the harness. You also set the visibility in the section to the hasMessages when rule from @baseclass, which is an out-of-the-box rule that handles custom error sections. The following figure illustrates the section configiration.

Section configuration
The section customError has Visibility set to Condition (when rule) - hasMessages.

For more information, see Creating an embedded section and Creating a When rule.

  • Previous topic Adding scripts and style sheets to a harness
  • Next topic Harness and Section forms: Help — Client Event Editor

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