Skip to main content

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

Custom search properties

Updated on July 8, 2022
Applicable to deployments with Search and Reporting Service and embedded Elasticsearch.

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.

  • Previous topic Specifying custom search properties
  • Next topic Configuring search to allow filtering on embedded properties

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