Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

How to create a Declare Index rule for an embedded property with the Property Optimization tool

Updated on October 8, 2019

By default, Pega Platform™ stores properties that are embedded in a Page List or Page Group property in a BLOB ("Binary Large OBject") column in the database. In order to make these properties available for reports, and to optimize them for processing in other operations, the Property Optimization tool optimizes ("exposes") the values of an embedded property by creating a concrete Index- class, properties for the new class, and a Declare Index that allow Pega Platform fast access to the property values without having to process the entire BLOB entry.

You cannot optimize properties in pega- based rulesets, in abstract classes, in classes mapped to pr_other, or transient properties (as the column values would all be null).

You can access the Property Optimization tool from the context menu for a property in the Application Explorer. Right-click the property that you want to expose, select Optimize for reporting from the context menu, and Process Commander manages the appropriate processing as a background task.

Step-by-step instructions for exposing an embedded property are detailed below.

In Pega Platform 6.1 SP2, the option is labeled as Optimize for Filtering, and the steps in the process appear differently than what is described below.


To use the Property Optimization tool, your Pega Platform environment must be configured as follows:

  • The prconfig.xml setting database/AutoDBSchemaChanges must not be set to FALSE.
    • By default, this property is not set in the proconfig.xml file.
    • If your site wants to limit this type of operation, database/AutoDBSchemaChanges may have been added and set to FALSE in prconfig.xml.
  • The production level of your system is 1 or 2.
  • The database user used to access the PegaRULES database must have ALTER TABLE and CREATE TABLE permissions.

    This user's username and password are specified in the data source definition defined in your application server for the jdbc/AdminPegaRULES JNDI location, if defined, or else the base user specified in the data source associated with jdbc/PegaRULES.

How to expose an embedded property

To expose an embedded property:

  1. In the Application Explorer, locate the property.
  2. Right-click the property and select Optimize for reporting from the context menu.
    Optimize for reporting option
  3. If multiple classes are available, the wizard lets you select the class in which to work:
    choose classes
    If only one option is available, the option is selected automatically.
  4. At the bottom of the same form, select the ruleset and version in which to save the declare index for the optimized property.
    Select ruleset and version
  5. Click Next to proceed to the next step where you can review the class in which you are optimizing the property:
    warning before beginning optimization
    Note the warning message indicating that proceeding will begin optimization of the property that you selected.
  6. Click Next to optimize the property.
  7. When the process is complete, a completion message appears. Click OK to close the message.

The property is now optimized for use in reporting, filtering, and other processes.

The background processing performed by the Property Optimization tool to create the Index- table rows may take many minutes to complete, depending on current database activity. During this time, processes using these properties may fail or produce incorrect results.

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us