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 use declarative indexes in report definitions

Updated on September 20, 2019

This article describes how to include indexed embedded properties in your report definition rules using the Declarative Index Join feature. To include indexed embedded properties in a report, associate a prefix with an index definition. Each property in the index definition is then accessible in the other tabs by using the syntax: prefix.indexed property.

For more information about creating declarative indexes, see How to create Declarative indexes for embedded properties.

You can also use declarative indexes in list view and summary view rules. See How to use declarative indexes in reports.

Properties discussed in this article must be optimized ("exposed") to be included in the report. Work with your database administrator to optimize the properties you need.

Suggested Approach

  1. Create or edit a new report definition.
  2. On the Data Access tab, enter a Prefix value in the Declarative Index Join section. Choose a value that is relevant to the properties you have indexed. Ensure that the Prefix value is not a SQL reserved word. In the Index Name field, choose the index definition from the SmartPrompt list.
  3. When you reference properties on the Design tab, enter the Prefix value followed by a "." first, then select the desired property.
  4. After you are finished editing the report structure, click the Save & Preview button to view the report.


Pega Platform 7.1.1 - 7.4 Reporting Financial Services Healthcare and Life Sciences Insurance Communications and Media Government Healthcare and Life Sciences Consumer Services Consumer Services Manufacturing Consumer Services

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