Table of Contents

About Declare Index rules

Indexing can improve database performance and facilitate reporting. Create a Declare Index rule to define criteria under which the Pega Platform automatically maintains index instances for faster access. An index can improve search and reporting access for properties that cannot be exposed as database columns because they are embedded within an aggregate property.

As an alternative to completing the rule form, you can use the Property optimization tool to create the rule, properties, and other required instances.

Index instances are sometimes called alternate keys or secondary keys. The system saves indexes as instances of concrete classes derived from the Index- base class.


Use the Records Explorer to list all declare index rules available to you.


Declare Index rules are instances of the Rule-Declare-Index class. They are part of the SysAdmin category.

  • Creating a class group manually

    Create a class group using the Class Group form by selecting Class Group from the SysAdmin category. Creating appropriate class groups is typically done automatically, although you can create a class group and related rules manually.

  • Declare Index form - Completing the Indexes tab

    Use this tab to convey how and when the system constructs an index in a database. The system forms an index instance from the Purpose key part of this rule and the handle of the base instance.

  • Declare Index form - Completing the Pages & Indexes tab

    Identify the name and class of clipboard pages that, at run time, contain properties referenced in the Indexes tab, on any page other than the page that contains the Source Class properties. See How to Complete a Pages & Classes tab for basic instructions.

  • Identifying active nodes

    In a multi-node system, multiple servers each hosting Pega Platform share one PegaRULES database. Each server is known as a node. Each user connects to a single node of a cluster, but nodes can start and stop independently.

Have a question? Get answers now.

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