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 -

Updated on April 5, 2022

Create a harness by clicking Create User InterfaceHarness in Dev Studio.

Records can be created in various ways. You can add a new record to your application or copy an existing one. You can specialize existing rules by creating a copy in a specific ruleset, against a different class or (in some cases) with a set of circumstance definitions. You can copy data instances but they do not support specialization because they are not versioned.

Note: When generating a harness, About HTML Fragment rules that do not already exist in a core ruleset cannot be directly referenced with a generated JavaServer Pages (JSP) tag. Instead, an error displays and the harness does not generate. To address this issue, create a stub for the HTML Fragment in a core ruleset.

> Key parts:

Apply to Select a class that this harness applies to. In most cases, select the name of the class which contains the work items that the harness supports. Choose the class that is most specific to the application and its work items, rather than a general Work- class.

Typically the class you specify in this field is derived from the Work- base class. In special cases, a harness can apply to a class derived from the Assign- base class.

Identifier Enter a name for this harness. If this rule is to override a standard rule, choose:
  • AutoClose — An empty harness that closes automatically. An alternative to Confirm, for use in those flow actions that do not require users to see (and dismiss) a confirmation form.
  • Confirm — To display the results, including the work item ID, of an update.
  • New — To create a work item. (You can choose a value other than New if desired; identify the harness in the Harness for work item creation field on the Process tab of the Flow form.)
  • NewCovered — To create a work item that is associated with an existing cover work item.
  • Perform — To update and possibly complete an assignment.
  • Reopen — To allow a resolved work item to be reopened.
  • Review — To review a work item and assignment without the ability to update.

Begin the name with a letter and use only letters, numbers, the ampersand character, and hyphens to form a Java identifier. See How to enter a Java identifier.

Note: When completing the Add to ruleset field, you cannot add a harness to a component ruleset.

Additional creation options

Template Select a template rule to copy for the harness and mark the new rule as JSR 168 compliant.

Specify PortletHarness to create a harness that uses portlet-compliant HTML and can be displayed in a portlet window on a portal server through Service Portlet rules.


The rule type Service Portlet is deprecated. Use Pega Web Mashup instead.

Rule resolution

  • Harness form Adding a screen layout

    Screen layouts determine the overall structure of your screen. They define the structure of a harness that is included in a composite portal. When you create a new harness it contains a screen layout by default. A harness can contain only one screen layout.

  • Harness form Adding a container.

    A container can provide a visual grouping of other elements on a harness form, including sections and subsections. Every harness contains one or more containers. A container can contain a header, and includes the area of the harness form where tabs appear, if you use tabs to present sections.

  • Harness forms - How to support work item copying

    Follow these steps to allow users of your application to enter a new work item by copying information from an existing work item. Through a data transform, you can control which properties in the existing work item are copied.

  • Harness forms - Supporting work item printing

    Follow these steps to support complete or custom printing of work items in your application, including information about attachments and history.

  • harnesses

    Organize the content and structure of a portal by defining harnesses. By populating harnesses with sections, you can build a modular interface that promotes reuse and maintainability.

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