Enable data extraction

Abstract

How to enable the data extraction feature in a Sitecore and non-Sitecore context.

This topic describes how to enable the data extraction feature in a Sitecore and non-Sitecore context.

In a Sitecore context, data extraction can be enabled or disabled via configuration. By default, data extraction is disabled on Content Delivery servers and enabled on all other core roles. To enable or disable data extraction on a particular rule, modify the following section of the C:\path\to\sitecore\App_Config\Sitecore\XConnect.Client.Configuration\Sitecore.XConnect.Client.config configuration file:

<settings>
  <!-- This setting enables XConnect Collection and Search Client to access data extraction services. It is recommended to disable data extraction when not in use. -->
  <setting name="XConnect.Client.EnableDataExtraction" value="false" role:require="ContentDelivery"/>
  <setting name="XConnect.Client.EnableDataExtraction" value="true" role:require="!ContentDelivery" />
</settings>

For more information, see Rule-based configuration.

Note

For security reasons, it is recommended that you disable the data extraction feature if you are not using it. Furthermore, it is recommended that you never enable the data extraction feature on Content Delivery servers.

When you create an instance of the client in non-Sitecore context, you can enable data extraction via the XConnectClientConfiguration constructor:

// Sets enableDataExtraction parameter to true
var cfg = new XConnectClientConfiguration(
    new XdbRuntimeModel(CollectionModel.Model), collectionClient, searchClient, configurationClient, true);

By default, the IsDataExtractionEnabled property is set to false.