Skip to main content

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

Configuring a report definition to run against an Elasticsearch index

Updated on July 8, 2022

To improve report generation performance, you can run report definitions against Elasticsearch indexes instead of using SQL queries directly against the database. Running report definitions against Elasticsearch indexes is disabled by default and does not apply to reports that have features that are not supported by Elasticsearch. If a report query cannot be run against Elasticsearch indexes, Pega Platform automatically uses an SQL query.

Elasticsearch is eventually consistent storage. By enabling report definitions to run against Elasticsearch indexes, you are indicating that strong consistency is not required.

It is recommended that you change the pyContent.pyGetCachedDistinctValues parameter in memory and run the report as a virtual report, that is, use a UI component that supports virtual reports, or pass this parameter to an activity that runs the report. In addition, use a dedicated index because the dedicated index gives you more options for selecting which fields to include in the search results and improves the chances that Elasticsearch is valid storage.

Note: When creating report definitions, follow instructions that the system displays in guardrails, because performing not recommended actions can affect the outcome of report definition. For example, the system does not support embedded properties in report definitions. Reports with embedded properties use database instead of Elasticsearch.

  1. In the navigation panel, click RecordsSysAdminDynamic System Settings.
  2. Locate the reporting/searchdata/enabled setting.
  3. Click the setting.
  4. In the Value field, enter true.
  5. Click Save.
  6. Set the pyContent.pyGetCachedDistinctValues property to true. The method for setting this property varies depending on the method you are using to call the report definition, for example, a virtual report, a data transform, or an activity.

    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