Skip to main content

Table of Contents

Declare Index rules - Completing the New or Save As form


Only available versions of this content are shown in the dropdown

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.

Based on your use case, you use the Create, Save As, or Specialization form to create the record.

Create a Declare Index rule by selecting Declare Index from the SysAdmin category.

A Declare Index rule has two key parts:

Field Description
Apply to Select a concrete or abstract class that defines the scope of the indexes. At runtime, a clipboard page of this class must be a top-level page. Concrete objects in classes derived from this class are candidates for indexing under this rule.

Note these restrictions:

  • Choose an internal class. You can't index an external class.
  • You cannot use @baseclass or the Rule- base class, nor any class derived from the Rule- base class here. You cannot use a class derived from the Code- or Embed- class here.
  • You can choose a class derived from the Data- base class, but limitations apply. See More about Declare Index rules.
Identifier Enter a name for this Declare Index rule. Begin the name with a letter and use only letters, numbers, and a hyphen.

No other rules explicitly reference this Identifier value. However, based on class inheritance, a Declare Index rule named ByChild at one level in the class structure may override and therefore prevent execution of a Declare Index rule named ByChild at a higher level in the class structure.

Did you find this content helpful?

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us