Identifying parts of rule and data forms

Displayed in the upper-left corner, the form name provides an easier-to-say name associated with the rule type or data class.

See Rules by form name and Data classes by form name for the complete lists. Form names are similar to common names in most cases.

The category image suggests how this rule type (or data class) is used.

Indicates whether this form contains a locked (read-only) instance, or errors, or other modes. A smaller version of the icon is always visible in the top bar. Two common examples:

	The form is Read-only: you cannot change this instance. It may belong to a RuleSet version you cannot access, a class you cannot update, or a locked RuleSet version; or you may need to check out a rule before you can update it.
	You saved a form successfully and have not changed any values on the form since the form was last saved.

See How to complete rule form and data form fields for an explanation of form modes.

Your Application Explorer settings govern what appears in the rule headers. To review or change these settings, access the Application Explorer and choose Customize, the final entry in the drop-down list. Choose a Display Type radio button:

• Label to repeat the Short Description text in the header.
• Name to show all the key parts in the header.

See Using the Application Explorer.

The expanded header area lists all key parts, with field labels.

You cannot alter the value of rule key parts directly on the form. You determine key parts in the New form or the Save As form. See Completing the new rule dialog and How to enter rule keys using Save As.

The Description text aids other developers in identifying the purpose and source of this instance. (This field is called Short Description on some rule forms.)

For flows, flow actions, application rules, and certain class rule instances, the text you enter here may be visible to users of your application. See Creating good Descriptions and Short Descriptions.

If custom fields (of type Text) are established using the Custom Fields facility on the History tab of this rule, you can change the values here:

1. Click Edit Custom Fields
2. In the form that appears, enter a new text value for any of the custom fields associated with this rule
3. Click Apply.

Along with key parts, RuleSets versions, and circumstances, custom fields help to label or classify rules. For more about the uses and development of custom fields, see How to classify and select rules based on Custom Field values.

The HTML rule Embed-CustomFields.defaultFields sets the appearance of this area. You can save a copy of this rule into your application and modify it to present custom fields in a way that best suits the needs of your application and your user community. For more information, see the Pega Development Network article 17693 How to allow developers to review or update Custom Field values.

For rules, identifies the RuleSet and version that apply to this rule. Rules in RuleSet names beginning with the five characters Pega- are reserved and locked. If your Operator ID appears here, this rule is checked out into your personal RuleSet.

For rules, an icon indicates whether this rule is available, blocked, withdrawn, or final. See available rule. Click the Availability toolbar button () to change the availability setting.

A green clock icon indicates that this rule is time-qualified.

For rules, a green lock icon () indicates that this rule is checked out by a developer other than yourself. Access a ToolTip for this icon to identify how the rule is checked out. See check out.

For data instances, identifies the associated RuleSet for this data instance.

To assist in application packaging and migration, you can "tag" data instances with a RuleSet. Such associations make it easier to identify which data instances to include in an application package. Associating a RuleSet with a data instance does not affect or restrict any runtime behavior. See Associated RuleSet.

For data instances, click to update the Associated RuleSet to another RuleSet. When you click , the Associated RuleSet field become active and you can use the SmartPrompt to specify another RuleSet, or enter a RuleSet name.

When a displayed rule is checked out (usually by yourself, either with a standard check out or private check out), this field shows the original RuleSet and version. Click the link to open the current checked-in version.

When you later complete checking in this rule (using either the Check-in button or Private Check-in button ) the revised rule instance returns to this RuleSet and version, replacing the earlier copy. See check out and private RuleSet.

When you access a rule that is checked out by a developer, the Checked out by field identifies the Operator ID of that user. Click the link to review the checked-out copy.

This field does not indicate if a developer has performed a private check out on the rule.

If this rule is circumstance qualified, the property name and value appear here, with a circumstance icon (). See circumstance.

If this rule is a base rule for other rules (that are qualified by circumstance or time-qualified), the base rule icon () appears.

Identifies the date and time this instance was last saved.

Error conditions identify situations that prevent the system from saving the rule or data form. You must address the situation before the system will save the form.

Warning conditions identify unexpected and possible unintended situations, practices not recommended, or variances from best practices and guardrails. They do not prevent the rule from saving. (See warning.) The warning conditions are listed in the rule form in order of severity (Severe, Moderate, Caution) so that the most severe ones are displayed first.

If there are justified warning conditions, the errors-and-warning section displays how many are justified.

When you expand the section to view the warning messages, the justification comment entered by the user who justified the warning is displayed after the warning. The user who justified the warning and the date when the comment was entered is also displayed.

See warning for details about justifying warnings.