LinkedIn
Copied!

Table of Contents

Enabling classes for search indexing

Version:

Only available versions of this content are shown in the dropdown

On the Search landing page, for default indexes, you can configure which classes and class instances to index. You can also configure whether to index the contents of attachments. Enable attachment indexing only if your applications provide full-text search of work items. PDF, Microsoft Office, and text attachments are indexed and will be full-text searchable. However, if your application saves work item file attachments in an external enterprise content management system that is accessed through Connect CMS rules, such file attachments are not included in Pega Platform search results.

To access the Search landing page, you must have the pxAccessSearchLP privilege, which is included in the PegaRULES:SysAdm4 role.

On the Search landing page, you can also specify the maximum size of attachments to index. Attachments that exceed the threshold are not indexed and are listed in the log file.

By default, properties defined in the Data-Tag-RelevantRecord instance for a class are indexed and returned in search results and do not need to be explicitly configured. If you change the properties defined in the Data-Tag-RelevantRecord instance, you must reindex the class from the Search landing page for the changes to take effect.

You can configure indexing while a Pega Platform server node is operating, however index processing can affect system performance if the indexes are large. As a best practice; choose a time when the server is less busy to perform these one-time processor-intensive operations.

  1. In the header of Dev Studio, click Configure System Settings Search .

  2. In the Search indexing section, click Default.

  3. Toggle Enable indexing.

  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.
      Data- class requires a specified ruleform for indexing.

      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.
    You can skip indexing of specific class instances by clicking Exclude this class from search? on the Advanced tab of the Class form. Excluded instances will not be included in search results.
  5. Select Index attachments to index attachments.

  6. Optional:

    In the Attachments threshold (MB) field, adjust the maximum size of attachments to be indexed by entering a value, in megabytes.

  7. 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.

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.