Configure full-text search service
Describes how to set up full-text search service.
Note
The Full-text Search Service applies to Optimizely Content Management System (CMS 11) and is not supported on Optimizely Digital Experience Platform (DXP) and other cloud service deployments. It is a legacy feature that will be removed in future versions.
This section is not supported for ASP.NET Core-based applications.
The Optimizely Content Management System (CMS) full-text search service (FTS Service) configuration is found in the EPiServer.Search.IndexingService section of web.config and is accessible through properties on EPiServer.Search.IndexingService.IndexingServiceSettings. Most of the values have defaults and are not required. The following tables show section and element names and their defaults.
IndexingServiceSection
| Attribute | Type | Default Value | Comment |
|---|---|---|---|
| fipsCompliant | bool | false | Sets to true whether search service must comply with the Federal Information Processing Standards (FIPS). |
| maxDisplayTextLength | int | 500 | Maximum number of characters allowed in the DisplayText field. If DisplayText field exceeds this length, search truncates the content and adds the remaining part to the Metadata field. |
| maxHitsForReferenceSearch | int | 10000 | Maximum number of search results to return internally within the service when you update referenced documents or virtual path nodes. |
| maxHitsForSearchResults | int | 1000 | Maximum number of search results to return internally within the service when you prepare a search response. |
| Element | Type | Comment |
|---|---|---|
| clients | ClientCollection | A collection of client elements that define which clients can communicate with the indexing service. |
| namedIndexes | NamedIndexesElement | Contains the collection of indexes and defines the default index to be used. |
Client element
Each client element contains an IP address or address range from which clients are allowed to connect to the indexing service.
| Name | Type | Default Value | Comment |
|---|---|---|---|
| allowLocal | bool | false | Indicates whether the service should accept connection from all local interfaces. |
| description | string | Â | Description associated with this client. |
| ipAddress | string | Â | IPv4 address or range used to authenticate the client. |
| ip6Address | string | Â | IPv6 address or range used to authenticate the client. |
| name | string | Required key attribute, no default value | Name of the configured client that have access to this service. |
| readonly | bool | Required, no default value | Indicates whether the client can modify the index. |
NamedIndexes element
The namedIndexes element acts as a container for the index collection. This element only has the attribute defaultIndex, which should reference one of the indexes in the indexes collection. The referenced index is the one that is used if no specific index is requested.
| Name | Type | Default Value | Comment |
|---|---|---|---|
| defaultIndex | string | Required, no default value | Name of the configured named index that is the default index to use. |
| Element | Type | Comment |
|---|---|---|
| indexes | NamedIndexCollection | Container for a collection of NamedIndex elements. |
NamedIndex element
Each index element defines settings for one index hosted by the indexing service.
| Name | Type | Default Value | Comment |
|---|---|---|---|
| directoryPath | string | Required key attribute, no default value | Path where the associated Lucene index files are stored. |
| name | string | Required key attribute, no default value | Name of the index. |
| pendingDeletesOptimizeThreshold | int | 100 | The number of delete operations that occur before the index is optimized. |
| readonly | bool | false | Indicates whether the named index can be modified. |
| aclFieldInResponse | bool | true | Indicates whether the contents of the respective fields are included in the search response. |
| authorFieldInResponse | |||
| categoriesFieldInResponse | |||
| createdFieldInResponse | |||
| cultureFieldInResponse | |||
| displayTextFieldInResponse | |||
| idFieldInResponse | |||
| itemStatusFieldInResponse | |||
| metadataFieldInResponse | false | ||
| modifiedFieldInResponse | true | ||
| publicationEndFieldInResponse | |||
| publicationStartFieldInResponse | |||
| referenceIdFieldInResponse | |||
| titleFieldInResponse | |||
| typeFieldInResponse | |||
| uriFieldInResponse | |||
| virtualPathFieldInResponse |
Updated 12 months ago