Class form
Completing the Advanced tab

Field

Description

Optional. Select a category from the selection list to determine where rules or data instances of this type appear on the Application Explorer and Rules by Type display.

The categories that appear here are defined by field value rules with the value Rule-Obj-Class as the first key party and the value pyCategory as the second key part. Your application can define additional field value rules to extend the Application Explorer display if desired. For example, you can group several data classes in your application into a category named Customer Data.

Field

Description

Select to control which rules define the form

• Form — The form is defined by a FormBuilder XML definition associated with a Rule-File-Form rule. (This approach is deprecated for new development)
• Harness — The form is defined by a harness rule. (Introduced with V5.5)

Optional. Leave blank in most cases. For concrete classes derived from the Rule- base class or Data- base class, identify the key of a form rule (Rule-File-Form rule type), or the second key part (Purpose) of a harness rule, depending on the value of the Type field. To locate the harness rule, the system uses the name of the class as the Applies To key part.

Click the pencil icon () to open the rule.

Field

Description

These two reserved fields are used only for those Rule- classes which use rules assembly. They control how the system generates and assembles Java. Leave blank unless you are building a custom rule type.

Reserved. Identifies an aspect for the sole or primary Java class. These values correspond to PublicAPI methods defined on

com.pega.pegarules.pub.runtime.PublicAPI

Reserved. For standard rule types, this identifies the primary Java class that implements rules assembly.

Field

Description

Leave these two fields blank.

Reserved.

Reserved.

Field

Description

When you use the Connector and Metadata Accelerator to import a JavaBean, in addition to generating the class rules that represent the data model of the JavaBean, the accelerator generates Java wrapper classes that enable the clipboard to access instances of the JavaBean.

Reserved. For generated class rules that represent external Java objects, the name of the generated Java wrapper class that enables the clipboard to access instances of the Java object. For more information, see About importing JavaBeans andWorking with the Java Pages Feature, an article on the Pega Developer Network.

Field

Description

Check to cause the full text search indexing process to ignore all instances of this class. Leave unchecked in most cases. See How to enable and control the full text search facility.

For example, if your application includes a work type that has a large number of objects per month but are never searched, select this option to eliminate the processing and space required for indexes for these work objects.

This option is meaningful only for concrete classes derived from the Work-, Rule-, or Data- base classes, only when indexing is enabled, and only for instances of this exact class (not for instances of other classes derived from this class.)

As a best practice, do not select this option for Rule- classes

This option affects only indexing that occurs after you save the Class form. If you select or clear this check box at a time when instances of the class exist and indexes are built, it will get indexed or removed from the index automatically.

For an example, see Pega Developer Network article PRKB-25620 How to limit text search to specific class instances.

Field

Description

Select to require that any classes derived from this class belong to the same RuleSet as this class.

If not selected, a class derived from this RuleSet may belong to any RuleSet.

Optional. Identify those RuleSets that can contain this class as the first key part of a class-based rule. A class-based rule is one that has a class name as a key part, such as Rule-Obj-Property or Rule-Access-When. In most cases, the key part label is Class Name or Applies To.

Although you can list any RuleSet here, you restricting who (which users) can add rules and who can execute rules, not capabilities. To add a rule that uses this class name as the Applies To class:

• The developer needs access to an unlocked version of a RuleSet listed here.
• The RuleSet that this class belongs to — the RuleSet entered on the New dialog box — must appear in the Requires RuleSets and Versions area of the selected version of the RuleSet listed here.

For example, if class ALPHA in RuleSet ROGER lists RuleSet TANGO here, then a user can add a when condition rule named ALPHA.MyWhen into TANGO:01-01-01 only if the RuleSet version TANGO:01-01-01 lists ROGER as a prerequisite.

If you leave this blank, no restrictions apply. Rules in any RuleSet can reference this class in a class key part. (Of course, users must have access to the RuleSet of this class itself.)

You cannot enter here a RuleSet name that appears as a prerequisite to the current version RuleSet defined during the New form for this class itself. That is, if you are adding this class to the GAMMA RuleSet, and your current GAMMA RuleSet version rule lists BETA 02-02 as a prerequisite RuleSet, you cannot enter BETA here.