HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket


The following XML pseudocode describes the \<episerver.search\> section of the configuration file. The [Configure CMS](🔗) topic describes the syntax used in the description of the configuration elements.



## \<episerver.search\>



### \<episerver.search\> element attributes

NameDefault valueDescription
[active](🔗) **_Required_** – Defines whether the full text search service is active or not. No calls will be made to the search index if false.
[dequeuePageSize](🔗)50The page size to use when dequeueing the request queue.
[dynamicDataStoreName](🔗)IndexRequestQueueDataStoreThe name of the Dynamic Data Store.
[htmlStripDisplayText](🔗)trueDefines whether to automatically strip HTML from the `IndexItem` `DisplayText` before sending it to indexing service.
[htmlStripMetadata](🔗)trueDefines whether to automatically strip HTML from the `IndexItem` Metadata before sending it to indexing service.
[htmlStripTitle](🔗)trueDefines whether to automatically strip HTML from the `IndexItem` Title before sending it to indexing service.
[indexingServiceFieldNameAcl](🔗)EPISERVER\_SEARCH\_ACLThe names for different indexing service fields.
[indexingServiceFieldNameAuthors](🔗)EPISERVER\_SEARCH\_AUTHORS
[indexingServiceFieldNameCategories](🔗)EPISERVER\_SEARCH\_CATEGORIES
[indexingServiceFieldNameCreated](🔗)EPISERVER\_SEARCH\_CREATED
[indexingServiceFieldNameCulture](🔗)EPISERVER\_SEARCH\_CULTURE
[indexingServiceFieldNameDefault](🔗)EPISERVER\_SEARCH\_DEFAULT
[indexingServiceFieldNameDisplayText](🔗)EPISERVER\_SEARCH\_DISPLAYTEXT
[indexingServiceFieldNameId](🔗)EPISERVER\_SEARCH\_ID
[indexingServiceFieldNameItemStatus](🔗)EPISERVER\_SEARCH\_ITEMSTATUS
[indexingServiceFieldNameModified](🔗)EPISERVER\_SEARCH\_MODIFIED
[indexingServiceFieldNameTitle](🔗)EPISERVER\_SEARCH\_TITLE
[indexingServiceFieldNameType](🔗)EPISERVER\_SEARCH\_TYPE
[indexingServiceFieldNameVirtualPath](🔗)EPISERVER\_SEARCH\_VIRTUALPATH
[maxHitsFromIndexingService](🔗)500The maximum number of hits returned by the indexing service.
[namedIndexesUriTemplate](🔗)/namedindexes/?accesskey={accesskey}The URI template for getting all named indexes. `"{accesskey}"` will be replaced with the `accessKey` attribute value of the registered service.
[queueFlushInterval](🔗)30The timer interval in seconds when the requests queue to indexing service should be dequeued.
[resetHttpMethod](🔗)POSTThe HTTP method for reset index requests to the indexing service.
[resetUriTemplate](🔗)/reset/?namedindex={namedindex}&accesskey={accesskey}The URI template for reset index request to the indexing service. `"{accesskey}"` will be replaced with the `accessKey` attribute value of the registered service.
[searchUriTemplate](🔗)/search/?q={q}&namedindexes={namedindexes}&offset={offset}&limit={limit}&format=xml&accesskey={accesskey}Gets and sets the URI template for search requests to the indexing service. The HTTP method is always GET. Required `replaceables: "{q}"`, `"{namedIndexes}"`.
[syndicationFeedAttributeNameTotalHits](🔗)TotalHitsThe names for the syndication feed attribute extensions.
[syndicationFeedAttributeNameVersion](🔗)Version
[syndicationItemAttributeNameBoostFactor](🔗)BoostFactorThe names for the syndication feed item attribute extensions.
[syndicationItemAttributeNameCulture](🔗)Culture
[syndicationItemAttributeNameDataUri](🔗)DataUri
[syndicationItemAttributeNameIndexAction](🔗)IndexAction
[syndicationItemAttributeNameItemStatus](🔗)ItemStatus
[syndicationItemAttributeNameNamedIndex](🔗)NamedIndex
[syndicationItemAttributeNamePublicationEnd](🔗)PublicationEnd
[syndicationItemAttributeNamePublicationStart](🔗)PublicationStart
[syndicationItemAttributeNameReferenceId](🔗)ReferenceId/td>
[syndicationItemAttributeNameScore](🔗)Score
[syndicationItemAttributeNameType](🔗)Type
[syndicationItemAttributeNameVersion](🔗)Version
[syndicationItemElementNameAcl](🔗)ACLThe names for the syndication item element extensions.
[syndicationItemElementNameMetadata](🔗)Metadata
[syndicationItemElementNameVirtualPath](🔗)VirtualPath
[updateUriTemplate](🔗)/update/?accesskey={accesskey}The URI template for update request to the indexing service. ` "{accesskey}"` will be replaced with the `accessKey` attribute value of the registered service.
[useIndexingServicePaging](🔗)trueDefines whether to send paging parameters passed to `GetSearchResults` (page and pagesize) to the service. If set to false `page=1` and `pagesize=[MaxHits]` will be sent. <br>This should be set to false if any `SearchResultFilter `is plugged in.
[xmlQualifiedNamespace](🔗)EPiServer.Search.IndexingServiceThe namespace for `XmlQualifiedName`.

## \<namedIndexingServices\>



### \<namedIndexingServices\> element attributes

NameDefault valueDescription
[defaultService](🔗) **_Required_** – The name of the service to be used. A service with the specified name must exist in the \<services\> collection.

### \<services\>/\<add\> element attributes

NameDefault valueDescription
[accessKey](🔗) **_Required_** – The access key that will be used to replace "{accesskey}" in the \*UriTemplate attributes defined on the \<episerver.search> element.
[baseUri](🔗) **_Required_** – The base URI that will be used as a base for constructing the full URI for procedure calls. This URI will be combined with the different \*UriTemplate attributes defined on the \<episerver.search> element.
[certificateAllowUntrusted](🔗)falseDefines if server certificate validation should be bypassed.
[name](🔗) **_Required_** – Unique name for this service registration.

## \<searchResultFilter\>



### \<searchResultFilter\> element attributes

NameDefault valueDescription
[defaultInclude](🔗)false**_Required_** – Defines whether the default behavior for filtering should be to include results when no provider is configured for the type.

### \<providers\>/\<add\> element attributes

NameDefault valueDescription
`name` **_Required_** – Unique name for this search result filter.
`type` **_Required_** – The full name for this search result filter class. The referenced class must inherit `SearchResultFilterProvider` and have a static instance property called `Instance`.