HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

episerver.search

The following XML pseudocode describes the <episerver.search> section of the configuration file for CMS 10 and 11.

The following XML pseudocode describes the <episerver.search> section of the configuration file. The Configuration topic describes the syntax used in the description 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

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.
dequeuePageSize50The page size to use when dequeueing the request queue.
dynamicDataStoreNameIndexRequestQueueDataStoreThe name of the Dynamic Data Store.
htmlStripDisplayTexttrueDefines whether to automatically strip HTML from the IndexItem DisplayText before sending it to indexing service.
htmlStripMetadatatrueDefines whether to automatically strip HTML from the IndexItem Metadata before sending it to indexing service.
htmlStripTitletrueDefines whether to automatically strip HTML from the IndexItem Title before sending it to indexing service.
indexingServiceFieldNameAclEPISERVER_SEARCH_ACLThe names for different indexing service fields.
indexingServiceFieldNameAuthorsEPISERVER_SEARCH_AUTHORS
indexingServiceFieldNameCategoriesEPISERVER_SEARCH_CATEGORIES
indexingServiceFieldNameCreatedEPISERVER_SEARCH_CREATED
indexingServiceFieldNameCultureEPISERVER_SEARCH_CULTURE
indexingServiceFieldNameDefaultEPISERVER_SEARCH_DEFAULT
indexingServiceFieldNameDisplayTextEPISERVER_SEARCH_DISPLAYTEXT
indexingServiceFieldNameIdEPISERVER_SEARCH_ID
indexingServiceFieldNameItemStatusEPISERVER_SEARCH_ITEMSTATUS
indexingServiceFieldNameModifiedEPISERVER_SEARCH_MODIFIED
indexingServiceFieldNameTitleEPISERVER_SEARCH_TITLE
indexingServiceFieldNameTypeEPISERVER_SEARCH_TYPE
indexingServiceFieldNameVirtualPathEPISERVER_SEARCH_VIRTUALPATH
maxHitsFromIndexingService500The 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.
queueFlushInterval30The timer interval in seconds when the requests queue to indexing service should be dequeued.
resetHttpMethodPOSTThe 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}".
syndicationFeedAttributeNameTotalHitsTotalHitsThe names for the syndication feed attribute extensions.
syndicationFeedAttributeNameVersionVersion
syndicationItemAttributeNameBoostFactorBoostFactorThe names for the syndication feed item attribute extensions.
syndicationItemAttributeNameCultureCulture
syndicationItemAttributeNameDataUriDataUri
syndicationItemAttributeNameIndexActionIndexAction
syndicationItemAttributeNameItemStatusItemStatus
syndicationItemAttributeNameNamedIndexNamedIndex
syndicationItemAttributeNamePublicationEndPublicationEnd
syndicationItemAttributeNamePublicationStartPublicationStart
syndicationItemAttributeNameReferenceIdReferenceId/td>
syndicationItemAttributeNameScoreScore
syndicationItemAttributeNameTypeType
syndicationItemAttributeNameVersionVersion
syndicationItemElementNameAclACLThe names for the syndication item element extensions.
syndicationItemElementNameMetadataMetadata
syndicationItemElementNameVirtualPathVirtualPath
updateUriTemplate/update/?accesskey={accesskey}The URI template for update reqeuest to the indexing service.
"{accesskey}" will be replaced with the accessKey attribute value of the registered service.
useIndexingServicePagingtrueDefines 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.
This should be set to false if any SearchResultFilter is plugged in.
xmlQualifiedNamespaceEPiServer.Search.IndexingServiceThe 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

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.
certificateAllowUntrustedfalseDefines if server certificate validation should be bypassed.
name Required. Unique name for this service registration.

<searchResultFilter>

<searchResultFilter defaultInclude="bool">
        <providers>
           <add name="string"
                type="string" />
           ...
        </providers>
    </searchResultFilter>

<searchResultFilter> Element Attributes

NameDefault valueDescription
defaultIncludefalseRequired. 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.

What’s Next
Did this page help you?