Skip to main content

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

Enabling the indexing of classes

Updated on May 11, 2022

Decide what data you want to make searchable in your application by permitting the system to index certain class types. For example, on the Search landing page, you can index all Work- classes to make work items searchable.

Before you begin: Ensure that you have the pxAccessSearchLP privilege to access the Search landing page.
Note: The PegaRULES:SysAdm4 role includes the pxAccessSearchLP privilege.
  1. In the header of Dev Studio, click ConfigureSystemSettingsSearch.
  2. In the Search indexing section, turn on the Enable indexing switch, and then click Default.
  3. In the Default indexes section, enable indexing of the specific class types that you require.
    For example: Turn on indexing for all Rule- classes by selecting the All rules check box.
  4. Select any of the check boxes in front of the class types to enable indexing for that class:
    • Select All rules to turn on indexing for all Rule- classes.
    • Select All data to turn on indexing for all Data- classes.
      Note: Incremental indexing requires classes to include a specified ruleform. If the system does not automatically index data in your Data- class, set a ruleform type for that class. For more information, see Advanced tab on the Class form.
    • Select All work to turn on indexing for all Work- classes. Note that work object search is not available in Dev Studio.

    In Search and Reporting Service (SRS), when you select the Exclude this class from search check box, the system ignores the specific class regardless of Custom Search Properties and relevant records.

    Once you exclude a specific result from search, the system does not index new instances of that class, but does retain previously indexed instances. For more information about deleting instances data, see Indexing class data.

  5. Optional: To index attachments that are included in specific classes, select the Index work attachments check box, and then specify the maximum file size to index.
    Note: Enable attachment indexing only when your applications provide full-text search of work items. The attachments that your application saves in an external enterprise content management system are not included in search results.
  6. In the lower-left corner of the screen, click Save settings.
  1. Excluding properties with access control policies from search results

    You can include or exclude properties with access control policies from search results, which lets you control who can view sensitive data. When you select the option to display properties with access control policies, access control policies are ignored. When you do not select the option to display properties with access control policies, properties with access control policies are excluded from search results, whether or not the access control policies are satisfied.

  2. Specifying custom search properties

    You can specify additional properties to include in the search index for a class by creating a custom search property data instance. Including properties in the search index enables you to reference them and use them in filters in report definition rules that query the search indexes.

  3. Creating dedicated indexes

    Dedicated indexes are property type-aware, per-class indexes that return the data type of each returned property. Default indexes are typeless, that is, all properties are of type string. Dedicated indexes let you execute queries with filters, date calculations, and aggregations directly in the query. Dedicated indexes are displayed on the Search landing page in the Dedicated indexes section.

  4. Configuring a report definition to run against an Elasticsearch index

    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.

  • Previous topic Types of indexing errors
  • Next topic Excluding properties with access control policies from search 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