Enable/disable the xDB and the tracker

Change the Xdb.Enabled and Xdb.Tracking.Enabled settings to enable or disable the tracker and the xDB. Depending on your requirements, you can choose to:

  • Disable the xDB and disable tracking.

  • Disable the xDB and enable tracking.

  • Enable the xDB and disable tracking.

  • Enable the xDB and enable tracking.

Important

You must also include the VisitorIdentification tag or helper in your layout in order to track visitors.

To disable the xDB and the tracker, perform this procedure on all the servers that have the Content Management and Content Delivery roles:

  1. Create a patch file for the \\path\to\web\root\App_Config\Sitecore\Marketing.xDB\Sitecore.Xdb.config configuration file.

  2. To disable data collection, set the Xdb.Enabled setting to false.

  3. Open the web.config file and in the <appSettings> section, in the <add key="exmEnabled:define" value="yes"/> setting, change the value to "no".

    Note

    If you have disabled the xDB, you must also disable the Email Experience Manager (EXM). If you are only disabling tracking, you do not have to disable EXM.

  4. Optionally to disable tracking, set the Xdb.Tracking.Enabled setting to false.

Reverse the instructions to enable the xDB and the tracker.

To disable tracking for a particular site:

  1. Create a patch file for the \\path\to\web\root\App_Config\sitecore.config configuration file.

  2. In the site node, set the enableTracking attribute to true or false.

    <site name="customwebsite" enableTracking="false" ... />

Note

If the Xdb.Tracking.Enabled is set to false, tracking is disabled for all sites - even if enableTracking is set to true on an individual site node.

If you temporarily disable the xDB and the tracker in a Sitecore XP environment, you can disable the xDB on all xDB Processing server roles as well. This affects features such as aggregation and the ability to rebuild the reporting database.

Note

If you have an Experience Platform license, disabling the xDB and the tracker on the core server roles (CD, CM, Processing, and Reporting) does not prevent you from using the xConnect Client API to work with contacts and interactions in the xDB.

The following table describes the effect of enabling/disabling the xDB and tracking in different combinations.

Note

If you used Sitecore 9.1 XM Scaled packages to install the Content Delivery and Content Management server roles, a reduced list of compatible features are available.

Tracking

xDB

Role

Effects

Disabled

Enabled

Content Management

  • In-session personalization is available, but personalization rules that rely on tracking are not. For example, you cannot personalize based on goals, campaigns, or GeoIP.

  • xDB cannot identify contacts.

  • Contacts cannot be enrolled in engagement plans.

  • IP Geolocation services are unavailable.

  • You cannot perform content testing

Content Delivery

  • You can use personalization rules based on goals, campaigns, and events.

  • Contacts cannot be identified.

  • Contacts cannot be enrolled in engagement plans.

  • IP Geolocation services are unavailable.

xDB Processing

No change.

Contact and interaction data that is created by calling the xConnect Client API directly is still processed.

xDB Reporting

No change.

The xDB Reporting server role returns data from the xDB Reporting database.

Enabled

Disabled

Content Management

  • Engagement plans cannot be created or processed.

  • Data cannot be collected in the Preview environment.

  • Contacts cannot be identified.

  • You cannot deploy Marketing Operations definitions to the Reference Data service.

Content Delivery

  • Contacts cannot be identified immediately, and any data gathered from the contact is discarded at the end of the session.

  • You can use personalization rules for contact facets and segmentation.

  • IP Geolocation services are available.

  • Engagement plan processing occurs for the live session.

  • Contact repositories are available for the session, and outcomes that are triggered during the session are registered.

xDB Processing

The xDB Processing role does not process contact and interaction data. This includes data created by calling the xConnect Client API directly.

xDB Reporting

You cannot rebuild the Reporting database. However, the xDB Reporting server role returns data from the xDB Reporting database.

Note

Disabling the xDB does not disable the xConnect Client, and you can still use the xConnect Client API.

We recommend that you disable tracking on Content Delivery servers if:

  • Some Content Delivery servers are used exclusively to serve static content, such as digital assets, and do not require personalization.

  • You want to ensure that your implementation complies with privacy legislation.

  • You write data to the xDB from other sources - such as a mobile application - but do not wish to track visitors on your website.