Table of Contents

Using declarative indexes


Only available versions of this content are shown in the dropdown

Create a Declare Index rule to define criteria under which 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. Creating a Declare Index rule manually is an alternative to the integrated approach used by the Property Optimization tool.

After you implement a declarative index, reports can use the indexed property value as a selection criteria. For example, if an array of embedded Universal Product Code (UPC) codes in a work item is indexed, you can report on all work items containing a specific UPC code by referencing the index class on the Contents and Join tabs of the report definition form.

As a best practice, do not create declarative indexes for top-level Single Value properties.
  • Setting up a declarative index

    You can use indexing to improve database performance and facilitate reporting by setting up a declarative index.

  • Licenses

    A license defines input parameters that support collecting and reporting usage data. By using a license, you can demonstrate compliance with your software license agreement.

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.