Identifying parts of rule and data forms

The top left portion of each rule form includes the form name, a mode icon, and the key parts of the specific rule. Click the expand button () to expand the header area. Click the collapse button () to hide the header area. C-1522

Form Name	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.
Category Image	The category image suggests how this rule type (or data class) is used.
Form Mode	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.
(varies)	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.
Names (Key Parts)	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.
Short Description	The Short Description text aids other developers in identifying the purpose and source of this instance. For flow rules, flow action rules, application rules, and certain class rule instances, the text you enter here may be visible to users of your application. See Creating good Short Descriptions.
Custom Fields	If custom fields (of type Text) have been established using the Custom Fields facility on the History tab of this rule, you can change the values here: Click Edit Custom Fields In the form that appears, enter a new text value for any of the custom fields associated with this rule 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 PRKB-17693 How to allow developers to review or update Custom Field values.

The RuleSet, version, and Availability icon appear at the top right of the form. (These fields are for rules only; they do not apply to data instances.)

Click the plus sign at the top left to see other qualifications and information:

RuleSet and Version	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 private RuleSet.
Availability	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.
Locked?	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.
Checked Out From	B-691 When a displayed rule is checked out (usually by yourself), this field shows the original RuleSet and version. Click the link to open the current checked-in version. When you later check this rule in (with the Check-in button ) the revised rule instance returns to this RuleSet and version, replacing the earlier copy. See check out and private RuleSet.
Checked Out By	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. C-1172
Circumstance or Base	If this rule is circumstance qualified, the property name and value appear here, with a circumstance icon (). B-20646 B-19444 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. PROJ-843
Last Update	Identifies the date and time this instance was last saved.

Click any tab to bring it to the front. (Some users can access only the left tab of certain rule forms.)

History tab

Every form has History tab. It can contain a text description of the rule or data instance, and show who created and updated it and when. In some cases, you can roll back a rule to an earlier version. Here you can also specify custom fields for the current rule. See:

• How to complete the History tab of a data form
• How to complete the History tab of a rule form
• How to recover (undelete) a deleted rule
• How to restore an earlier copy of a rule after check-in

Pages and Classes tab

Many rule forms contain a Pages & Classes tab. See How to complete a Pages & Classes tab.

Other tabs

Other tabs vary by form. Consult the help topics for information on specific tabs and fields.