Skip to main content

Table of Contents

Custom search properties


Only available versions of this content are shown in the dropdown

By default, a subset of all the properties in a class instance is indexed and returned in a search. You can specify additional properties to index by creating a custom search property data instance. Including properties in the search index enables you to reference them in report definition rules that query the search indexes. You can include all properties in a class or some of them. Including all properties might affect performance.

You can specify single value, page list, page group, value list, and value group properties. Properties can be stored in the index in a format that is filterable and/or returnable. Filterable properties can be referenced in report definition filters that search the indexes. Returnable properties can be included in the results of report definition queries that search the indexes.

You can also specify which properties are available for full-text search if you want only certain properties to be available.

In addition, you can create and use a dedicated index for this class. Dedicated search indexes are property type-aware, per-class indexes that return the data type of each returned property instead of the default type of string used by the default indexes.


Custom search properties are instances of the Data-CustomProperties-Search class. They belong to the SysAdmin category.

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.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us