Table of Contents

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.

You can include all properties in the class or specify which properties to include. When you include all properties:

  • All top-level and embedded page scalar properties for the class are indexed and returned in search results.

  • All embedded page list, page group, value list, and value group properties for the class are indexed, but not returned in search results.
Including all properties might affect performance.
  1. In the Dev Studio header, click Create SysAdmin Custom Search Properties .

  2. Specify the class name for which you are creating custom search properties.

  3. Click Create and Open.

  4. To include all properties, click Enable search results for all properties or select individual properties using the following steps:

    1. Click Add.

    2. Select the properties.

    3. Click Submit.

  5. Optional:

    You can create a dedicated search index for this class. For more information, see Creating dedicated search indexes.

  6. Optional:

    For embedded scalar and top-level properties, you can also specify whether the property is returnable in search results by selecting Include in search results. If a property is included in search results in the rule form, the value is added to the search results only if it is defined in the Column source field on the report definition.

  7. Optional:

    You can specify whether the property is available for full-text search by selecting Make this property available for full-text search. When Customize full text serach and For specified properties are selected on the Search landing page, only the properties selected on this page are included.

  8. Click Save.

  9. Rebuild the search index for the class on the Search landing page so that all data instances reflect the changes. For more information, see Rebuilding search indexes.

  • Configuring dynamic system settings

    As a best practice, set system configuration settings by using dynamic system settings data instances. For example, you can use a dynamic system settings to configure which fields are available in full-text search. Dynamic system settings are stored in the Pega Platform database and are used by all nodes that share that database.

  • Configuring search to allow filtering on embedded properties

    By default, full-text search only allows report definitions to filter based on top-level scalar properties. You can configure search to allow filtering based on embedded properties using the indexing/useDataInstances dynamic system setting and invoking search using the pxRetrieveSearchData activity.

  • Limitation on page-correlated filters

    When you use Report Definition filters that search the indexes, multiple filter conditions referencing properties in the same page list or page group might not return the expected results. The following example illustrates this limitation.

Have a question? Get answers now.

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