Configuring the xConnect service

Abstract

Overview of the configuration settings that affect the xConnect Search and xConnect Collection services.

This topic describes the configuration settings that affect the  xConnect Search and  xConnect Collection services. All configuration files are located in the C:\path\to\xconnect\App_data\Config folder.

Important

The xConnect Collection and Search service does not use all of the configuration settings available in the \App_data\Config sub-folder - for example, the indexer does not use the settings in the SearchIndexer sub-folder.

The following settings control how many records are returned to the indexer by the repository and underlying data provider.

File Path: C:\path\to\xconnect\App_data\Config\Sitecore\Collection\sc.Xdb.Collection.RepositorySettings.xml

Setting

Description

ContactsReturnedFromDataProviderChunkSize

Determines number of contacts returned by the underlying data provider. Increase to reduce number of queries to the underlying data provider.

ContactsReturnedChunkSize

Determines chunk size of contacts returned by the repository. If ContactsReturnedFromDataProviderChunkSize is set to 1000 and ContactsReturnedChunkSize is set to 100, only 100 contacts are expanded in memory at one time. Increase or decrease to control memory usage independently of query size.

InteractionsReturnedChunkSize

Determines chunk size of interactions returned by the repository and underlying data provider. Increase to reduce number of queries to the underlying data provider.

DeviceProfilesReturnedChunkSize

Determines chunk size of device profiles returned by the repository and underlying data provider. Increase to reduce number of queries to the underlying data provider.

Note

Depending on how data is distributed across shards, a request for 1000 contacts to the data provider may result in multiple queries across multiple shards.

The following settings control SQL provider timeouts. NumberOfChangeVersions and GetChangesCommandTimeoutInSeconds are not used by xConnect Collection or xConnect Collection Search.

File Path: C:\path\to\xconnect\App_data\Config\Sitecore\Collection\sc.Xdb.Collection.Data.Sql.xml

Setting

Description

BulkCopyTimeoutInSeconds

The timeout setting for the bulk copy operations. This value can be increased if you experience general timeout issues.

ContactIdentifierIndexLockTimeInSeconds

Defines how long a contact identifier index record is locked when it is first added to the database. The lock is required to update related contact data. If related contact data is not successfully updated, the identifier record is removed from the index.

CommandTimeoutInSeconds

The timeout setting for the CRUD commands. This value can be increased if you experience timeout issues during GET and SAVE operations.

File Path: C:\path\to\xconnect\App_data\Config\Sitecore\Collection\sc.Xdb.Collection.Data.MongoDb.xml

The following settings control how often and how many times an operation is retried. These settings also apply to calculated facets.

File Path: C:\path\to\xconnect\App_data\Config\Sitecore\Collection\sc.XConnect.CollectionService.xml

Setting

Description

SlotTime

The slot time used when pausing. xConnect uses an expotential backoff strategy by default, which means that repeated retries are spaced out at random intervals (using SlotTime as a base) to avoid congestion. Can be increased if you experience high response times.

MaxRetries

Determines the maximum number of times an operation will retry before failing.