Configuration - <episerver.search> Section
Product version: |
EPiServer CMS 6 R2 / Relate 2 R2 |
---|---|
Document version: |
1.0 |
Document last saved: |
Section Hierarchy - Table of Contents
This is a pseudocode description of the element structure of the episerver.community section. Each element name is also a link leading to the detailed information for that element
<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 |
---|---|---|
active |
Defines whether the full text search service is active or not. No calls will be made to the search index if false. |
|
dequeuePageSize |
50 |
The page size to use when dequeueing the request queue. |
dynamicDataStoreName |
IndexRequestQueueDataStore |
The name of the Dynamic Data Store. |
htmlStripDisplayText |
true |
Defines whether to automatically strip HTML from the IndexItem DisplayText before sending it to indexing service. |
htmlStripMetadata |
true |
Defines whether to automatically strip HTML from the IndexItem Metadata before sending it to indexing service. |
htmlStripTitle |
true |
Defines whether to automatically strip HTML from the IndexItem Title before sending it to indexing service. |
indexingServiceFieldNameAcl |
EPISERVER_SEARCH_ACL |
The names for different indexing service fileds. |
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 |
500 |
The 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 |
30 |
The timer interval in seconds when the requests queue to indexing service should be dequeued. |
resetHttpMethod |
POST |
The 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 |
TotalHits |
The names for the syndication feed attribute extensions. |
syndicationFeedAttributeNameVersion |
Version |
|
syndicationItemAttributeNameBoostFactor |
BoostFactor |
The names for the syndication feed item attribute extensions. |
syndicationItemAttributeNameCulture |
Culture |
|
syndicationItemAttributeNameDataUri |
DataUri |
|
syndicationItemAttributeNameIndexAction |
IndexAction |
|
syndicationItemAttributeNameItemStatus |
ItemStatus |
|
syndicationItemAttributeNameNamedIndex |
NamedIndex |
|
syndicationItemAttributeNamePublicationEnd |
PublicationEnd |
|
syndicationItemAttributeNamePublicationStart |
PublicationStart |
|
syndicationItemAttributeNameReferenceId |
ReferenceId |
|
syndicationItemAttributeNameScore |
Score |
|
syndicationItemAttributeNameType |
Type |
|
syndicationItemAttributeNameVersion |
Version |
|
syndicationItemElementNameAcl |
ACL |
The names for the syndication item element extensions. |
syndicationItemElementNameMetadata |
Metadata |
|
syndicationItemElementNameVirtualPath |
VirtualPath |
|
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. |
useIndexingServicePaging |
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] will be sent. This should be set to false if any SearchResultFilter is plugged in. |
xmlQualifiedNamespace |
EPiServer.Search.IndexingService |
The namespace for XmlQualifiedName. |
<namedIndexingServices>
<namedIndexingServices defaultService="string" >
<services>
<add accessKey="local"
baseUri="string"
certificateAllowUntrusted="bool"
name="localIndexingService" >
<certificate />
...
</services>
</namedIndexingServices>
<namedIndexingServices> Element Attributes
Name | Default Value | Description |
---|---|---|
defaultService |
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 |
---|---|---|
accessKey |
The access key that will be used to replace "{accesskey}" in the *UriTemplate attributes defined on the <episerver.search> element. |
|
baseUri |
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 |
false |
Defines if server certificate validation should be bypassed. |
name |
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 |
---|---|---|
defaultInclude |
false |
Defines whether the default behaviour for filtering should be to include results when no provider is configured for the type. |
<providers>/<add> Element Attributes
Name | Default Value | Description |
---|---|---|
name |
|
Unique name for this search result filter. |
type |
The full name for this search result filter class. The referenced class must inherit SearchResultFilterProvider and have a static instance property called "Instance". |