episerver.search
The following XML pseudocode describes the <episerver.search> section of the configuration file. The Configure CMSConfigure CMS topic describes the syntax of the configuration elements.
<episerver.search>
<namedIndexingServices>
<searchResultFilter>
</episerver.search><episerver.search>
<episerver.search active="bool"
dequeuePageSize="int"
dynamicDataStoreName="string"
htmlStripDisplayText="bool"
htmlStripMetadata="bool"
htmlStripTitle="bool"
indexingServiceFieldNameAcl="string"
indexingServiceFieldNameAuthors="string"
indexingServiceFieldNameCategories="string"
indexingServiceFieldNameCreated="string"
indexingServiceFieldNameCulture="string"
indexingServiceFieldNameDefault="string"
indexingServiceFieldNameDisplayText="string"
indexingServiceFieldNameId="string"
indexingServiceFieldNameItemStatus="string"
indexingServiceFieldNameModified="string"
indexingServiceFieldNameTitle="string"
indexingServiceFieldNameType="string"
indexingServiceFieldNameVirtualPath="string"
maxHitsFromIndexingService="int"
namedIndexesUriTemplate="string"
queueFlushInterval="int"
resetHttpMethod="string"
resetUriTemplate="string"
searchUriTemplate="string"
syndicationFeedAttributeNameTotalHits="string"
syndicationFeedAttributeNameVersion="string"
syndicationItemAttributeNameBoostFactor="string"
syndicationItemAttributeNameCulture="string"
syndicationItemAttributeNameDataUri="string"
syndicationItemAttributeNameIndexAction="string"
syndicationItemAttributeNameItemStatus="string"
syndicationItemAttributeNameNamedIndex="string"
syndicationItemAttributeNamePublicationEnd="string"
syndicationItemAttributeNamePublicationStart="string"
syndicationItemAttributeNameReferenceId="string"
syndicationItemAttributeNameScore="string"
syndicationItemAttributeNameType="string"
syndicationItemAttributeNameVersion="string"
syndicationItemElementNameAcl="string"
syndicationItemElementNameMetadata="string"
syndicationItemElementNameVirtualPath="string"
updateUriTemplate="string"
useIndexingServicePaging="bool"
xmlQualifiedNamespace="string" >
<namedIndexingServices>
<searchResultFilter>
</episerver.search><episerver.search> element attributes
Name | Default value | Description |
|---|---|---|
| Required – Defines whether the full-text search service is active. No calls are made to the search index if false. | |
50 | The page size to use when dequeuing the request queue. | |
IndexRequestQueueDataStore | The name of the Dynamic Data Store. | |
true | Defines whether to strip HTML from the IndexItem DisplayText before sending it to the indexing service. | |
true | Defines whether to strip HTML from the IndexItem Metadata before sending it to indexing service. | |
true | Defines whether to strip HTML from the IndexItem Title before sending it to the indexing service. | |
EPISERVER_SEARCH_ACL | The names for different indexing service fields. | |
EPISERVER_SEARCH_AUTHORS | | |
EPISERVER_SEARCH_CATEGORIES | | |
EPISERVER_SEARCH_CREATED | | |
EPISERVER_SEARCH_CULTURE | | |
EPISERVER_SEARCH_DEFAULT | | |
EPISERVER_SEARCH_DISPLAYTEXT | | |
EPISERVER_SEARCH_ID | | |
EPISERVER_SEARCH_ITEMSTATUS | | |
EPISERVER_SEARCH_MODIFIED | | |
EPISERVER_SEARCH_TITLE | | |
EPISERVER_SEARCH_TYPE | | |
EPISERVER_SEARCH_VIRTUALPATH | | |
500 | The maximum number of hits returned by the indexing service. | |
/namedindexes/?accesskey={accesskey} | The URI template for getting all named indexes. "{accesskey}" is replaced with the accessKey attribute value of the registered service. | |
30 | The timer interval in seconds when the requests queue to the indexing service should be dequeued. | |
POST | The HTTP method for reset index requests to the indexing service. | |
/reset/?namedindex={namedindex}&accesskey={accesskey} | The URI template for reset index requests to the indexing service. "{accesskey}" is replaced with the accessKey attribute value of the registered service. | |
/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 GET. Required replaceables: "{q}", "{namedIndexes}". | |
TotalHits | The names for the syndication feed attribute extensions. | |
Version | | |
BoostFactor | The names for the syndication feed item attribute extensions. | |
Culture | | |
DataUri | | |
IndexAction | | |
ItemStatus | | |
NamedIndex | | |
PublicationEnd | | |
PublicationStart | | |
ReferenceId/td> | | |
Score | | |
Type | | |
Version | | |
ACL | The names for the syndication item element extensions. | |
Metadata | | |
VirtualPath | | |
/update/?accesskey={accesskey} | The URI template for update requests to the indexing service. "{accesskey}" is replaced with the accessKey attribute value of the registered service. | |
true | Defines whether to send paging parameters passed to GetSearchResults (page and pagesize) to the service. If set to false page=1 and pagesize=[MaxHits] is sent. Set this to false if any SearchResultFilter is plugged in. | |
EPiServer.Search.IndexingService | The namespace for XmlQualifiedName. |
<namedIndexingServices>
<namedIndexingServices defaultService="string" >
<services>
<add accessKey="local"
baseUri="string"
certificateAllowUntrusted="bool"
name="localIndexingService" >
<a href="http://msdn.microsoft.com/en-us/library/system.servicemodel.configuration.certificatereferenceelement.aspx">
<certificate />
</a>
...
</services>
</namedIndexingServices><namedIndexingServices\> element attributes
Name | Default value | Description |
|---|---|---|
| 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
Name | Default value | Description |
|---|---|---|
| Required – The access key that is used to replace {accesskey} in the *UriTemplate attributes defined on the<episerver.search> element. | |
| Required – The base URI that is used as a base for constructing the full URI for procedure calls. This URI is combined with the different *UriTemplate attributes defined on the <episerver.search> element. | |
false | Defines if server certificate validation should be bypassed. | |
| Required – Unique name for this service registration. |
<searchResultFilter>
<searchResultFilter defaultInclude="bool">
<providers>
<add name="string"
type="string" />
...
</providers>
</searchResultFilter><searchResultFilter> element attributes
Name | Default value | Description |
|---|---|---|
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
Name | Default value | Description |
|---|---|---|
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. |