This content is archived. See latest version here.

Last updated: Mar 21 2013

Introduction

This document describes how to configure EPiServer Full-Text Search Service (FTS Service). Configuration for the FTS Service is found in the EPiServer.Search.IndexingService section in the web.config and is accessible via properties on EPiServer.Search.IndexingService.IndexingServiceSettings. Most of the values have defaults and are not required. Below are tables for section and element names and their defaults.

IndexingServiceSection

Attribute Type Default Value Comment
maxDisplayTextLength int 500 Maximum number of characters allowed in the DisplayText field. If DisplayText field succeeds this length, the content will be cut and the remaining part will be added to the Metadata field.
maxHitsForReferenceSearch int 10000 Maximum number of hits to be returned internally within the service when updating referenced documents or virtual path nodes.
maxHitsForSearchResults int 1000 Maximum number of hits to be returned internally within the service when preparing a search response.

Element Type Comment
clients ClientCollection A collection of client elements that define which clients are allowed to 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 is allowed to 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 will be 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 should be 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 serivice.

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 need to 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 should be included in the search response.
authorFieldInResponse
categoriesFieldInResponse
createdFieldInResponse
cultureFieldInResponse
displayTextFieldInResponse
idFieldInResponse
itemStatusFieldInResponse
metadataFieldInResponse false
modifiedFieldInResponse true
publicationEndFieldInResponse
publicationStartFieldInResponse
referenceIdFieldInResponse
titleFieldInResponse
typeFieldInResponse
uriFieldInResponse
virtualPathFieldInResponse

See Also

The search integration for EPiServer CMS, Relate (Community) and Commerce are described in more detail in their respective SDK under the Developer Guide "Search" section.

Comments