|
|
Class form
The Advanced tab is meaningful only for concrete classes. Complete this tab if this class:
- Implements a custom rule type (and so is derived from the Rule- base class)
- Is derived from the Data- base class and has a FormBuilder form linked to a Rule-File-Form rule or a harness-based form.
- Is to appear on the Application Explorer and Rules as part of a category
- Is a concrete class derived from the Work- class (or Data- or Rule- class) and is to be excluded from full-text search indexing and full-text search results.
- Has restrictions on subclassing or the RuleSets of Applies To rules.
Category
Field |
Description |
| Category | |
|
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. |
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 display.
Field |
Description |
| Rule Form | |
| Type |
Select to control which rules define the form
|
| Name |
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, depending on the value of the Type field. To locate the harness, the system uses the name of the class as the Applies To key part. Click the pencil icon ( |
)
Field |
Description |
| Primary Rule Assembly |
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. |
| Primary Aspect |
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 |
| Primary Implementation Class |
Reserved. For standard rule types, this identifies the primary Java class that implements rules assembly. |
Field |
Description |
| Secondary Rule Assembly |
Leave these two fields blank. |
| Secondary Aspect |
Reserved. |
| Secondary Implementation Class |
Reserved. |
Field |
Description |
| Java Wrapper |
|
| Wrapper Name |
|
Working with the Java Pages Feature, an article on the PDN.
Field |
Description |
| Full-Text Search | |
| Exclude this class from search? |
Check to cause the full-text search indexing process to ignore all instances of this class. Instances of this class will not appear in search results. Leave unchecked in most cases. See Understanding 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 items. 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.)
This option affects only indexing that occurs after you save the Class form. If you select or clear this checkbox 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 |
As a best practice, do not select this option for Rule- classes
Field |
Description |
| Full-Text Search | |
| Create dedicated table for this class? |
Check to cause the system to create a dedicated database table in the PegaRULES database to hold instances of this class. (This feature is available only to users who hold the @baseclass. |
Field |
Description |
| Child Classes | |
| Prevent SubClassing in Other RuleSets? |
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. |
| RuleSets |
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.)
|
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:
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.
About Class rules