xDB Cloud

Configure a Sitecore xDB Cloud connection

Abstract

Set up your xDB Cloud 2.0 connection.

Sitecore xDB Cloud comes with open tenancy improvements for increased privacy in the Cloud. You connect to xDB Cloud by following the standard Sitecore configuration guidelines.

Note

Before configuring Sitecore for xDB Cloud 2.0, you must ensure that you are running Sitecore 8.0 or later and you must upgrade to the latest supported update for the Sitecore version that you are running. See the xDB Cloud service compatibility tables for the list of versions that are supported by the xDB Cloud service for new xDB Cloud customer sets.

This topic describes how to:

To request an xDB Cloud 2.0 customer set, register a support ticket through the Sitecore Support portal. If you do not have a valid Sitecore certification you must contact your Sitecore Implementation Partner to register the support ticket for you. If this is not possible, contact your Sitecore representative to access the Sitecore Support portal. Ensure that you include:

  • Your License ID

  • Your deployment ID

  • The version of Sitecore that you are running.

  • The preferred location for your xDB Cloud environment. See the xDB Cloud Service compatibility tables for compatible data center locations.

  • You will receive the following from Sitecore Support:

    • MongoDB connection strings: analytics, tracking.live, tracking.history, tracking.contact.

    • The Reporting API key (for Sitecore 8.2 Update-1 and later.

    • A Search index connection string: For Sitecore 8.2 Initial release: analytics.cloud.index, or for Sitecore 8.2 Update-1 and later: cloud.search.

    • Reporting service settings, including the address of the service and the thumbprint of the SSL certificate.

    Important

    Save these details because you will need them when you configure xDB on your Sitecore instances.

Note

This procedure describes how to prepare a local Sitecore environment. To prepare a standalone Sitecore instance, skip to the next section.

The Sitecore xDB Cloud service for 2.0 supports scaled Content Management (CM) and Content Delivery (CD) servers. You do not need to set the database connection strings at this stage because you do it later when you configure the xDB Cloud client and connection to the xDB Cloud service.

To prepare a local scaled on-premise Sitecore environment:

  1. Download the spreadsheet that lists of all the configuration files that you must enable or disable for each server type.

  2. Configure the CD servers, by following the instructions in the Configure a content delivery server topic. However, you must also: Configure a content delivery server

    • Go to the Configure a content delivery server section and follow the instructions. Skip the steps that require you to set the database connection strings for MongoDB.

    • In the Config enable disable spreadsheet, consult the Content Delivery (CD) column and ensure that the relevant configuration files are enabled and disabled.

    • Refer to the Changes to configuration file settings table and update the parameter values of your configuration files accordingly.

  3. Configure the CM servers, by following the instructions in the Configure a content management server topic. However, you must also: Configure a content management server

    • Go to the Configure a content management server section and follow the instructions. Skip the steps that require you to set the database connection strings for MongoDB.

    • In the Config enable disable spreadsheet, consult the Content Management (CM) column and ensure that the relevant configuration files are enabled and disabled.

Note

This procedure describes how to prepare a standalone Sitecore environment. To prepare a scaled on-premise Sitecore environment, see the previous section.

For development and demonstrations purposes, you can configure a standalone instance of Sitecore to use with xDB Cloud 2.0. Ensure that you use dedicated CD and CM instances in your production environment.

To use a Sitecore standalone instance with xDB Cloud 2.0:

  1. Ensure that the following configuration files are disabled or removed from your local installation by adding .disabled to the end of the file name.

    File path (relative to the website root)

    Configuration file name

    /App_Config/Include

    Sitecore.Analytics.Processing.Aggregation.Services.config

    /App_Config/Include

    Sitecore.Analytics.Processing.Services.config

    /App_Config/Include

    Sitecore.Analytics.Tracking.Database.ScaledCM.config

    /App_Config/Include

    Sitecore.MarketingProcessingRole.config

    /App_Config/Include

    Sitecore.PathAnalyzer.Processing.config

    /App_Config/Include/CES

    Sitecore.CES.DeviceDetection.CheckInitialization.config

    /App_Config/Include/ContentTesting

    Sitecore.ContentTesting.Processing.Aggregation.config

    /App_Config/Include/ExperienceAnalytics

    Sitecore.ExperienceAnalytics.Aggregation.config

    /App_Config/Include/ExperienceAnalytics

    Sitecore.ExperienceAnalytics.ReAggregation.config

    /App_Config/Include/ExperienceAnalytics

    Sitecore.ExperienceAnalytics.StorageProviders.config

    /App_Config/Include/ExperienceAnalytics

    Sitecore.ExperienceAnalytics.Reduce.config

  2. Follow all of the instructions in the Configure a content management server to use a remote Reporting Service servertopic. Ensure you enable and disable your configuration files according to the table in the Configure Path Analyzer section.Configure a content management server to use a remote Reporting Service server

To upgrade the xDB Cloud components, you must connect to xDB Cloud and then use the wizard to install the package:

  1. To connect to xDB Cloud 2.0, upgrade the xDB Cloud client components on your Sitecore installation.

  2. In the xDB Cloud Service compatibility tables, check the Compatible xDB Cloud Client versions to ensure the relevant xDB Cloud Client version is installed on your server.

  3. To install the Cloud components package, in the XdbCloud folder (Website/App_Config/Include), delete the following files (iIf they already have the .disabled extension, it is a good idea to delete them at this point).

    • Sitecore.Cloud.Xdb.config

    • Sitecore.ContentSearch.Cloud.Index.Analytics.config

    • Sitecore.ContentSearch.Cloud.Default.IndexConfiguration.config

    Note

    XdbCloud Website / App_Config / Include

  4. Use the Sitecore Installation Wizard to install the package.

    Note

    Sitecore Experience Platform 8.2 rev. 160729 (8.2 Initial Release) includes xDB Cloud client files and does not require a separate download of the xDB Cloud client package.

When the CD and CM instances are installed and configured, the next stage is to configure them to communicate with dedicated Azure services of Sitecore xDB Cloud.

To configure the xDB Cloud client and connection:

  1. In the ConnectionStrings.config file (Website/App_Config), configure the following MongoDB database connection strings using the connection strings from the response that you received from Sitecore Support. Database connection strings for configuring servers

    Note

    For a CD instance, you do not require the tracking.history connection string. After completing step 1, you can skip to step 4.

    The MongoDB connection strings,

    • analytics

    • tracking.live

    • tracking.history

    • tracking.contact

  2. In the ConnectionStrings.config file (Website/App_Config),

    • For Sitecore 8.2 Update-1 and later: add the Search index and Reporting API key connection string from the response that you received from Sitecore Support. For example:

    <add name="cloud.search" connectionString="[ cloud.search connection string ]"/>

    <add name="reporting.apikey" connectionString="[ reportingapikey ]"/>

    • For versions prior to 8.2 Update-1: add the Cloud Search index connection string from the response that you received from Sitecore Support. For example:

    <addname="analytics.cloud.index" connectionString="[ analytics.cloud.index connection string ]"/>

    Note

    You must use the actual connection strings from the response you received from Sitecore Support.

  3. In the ConnectionStrings.config file (Website/App_Config), ensure the following connection string is removed:

    <add name="reporting" connectionString="Data Source=…"/>

  4. For versions 8.2 Update-1 and later, enable the following configuration files:

    • Website/App_Config/Include/XdbCloud/Sitecore.Cloud.Xdb.config

    • Website/App_Config/Include/Sitecore.ContentSearch.Azure.Index.Analytics.config

    • Website/App_Config/Include/Sitecore.ContentSearch.Azure.DefaultIndexConfiguration.config

  5. For versions prior to 8.2 Update-1, enable the following configuration files:

    • Website/App_Config/Include/XdbCloud/Sitecore.Cloud.Xdb.config

    • Website/App_Config/Include/XdbCloud/Sitecore.ContentSearch.Cloud.DefaultIndexConfiguration.config

    • Website/App_Config/Include/XdbCloud/Sitecore.ContentSearch.Cloud.Index.Analytics.config

  6. Disable the following configuration files in the Xdb Cloud folder:

    • Website/App_Config/Include/Social/Sitecore.Social.Lucene.Index.Analytics.Facebook.config

    • Website/App_Config/Include/Sitecore.ContentSearch.Lucene.Index.Analytics.config or Website/App_Config/Include/Sitecore.ContentSearch.Solr.Index.Analytics.config

  7. In the Sitecore.Cloud.Xdb.config file (Website/App_Config/Include/Xdb Cloud), configure the reporting service by using the actual Service URL and SSL certificate thumbprint from the response that you received from Sitecore Support. For example:

           <httpTransportFactory patch:instead="httpTransportFactory" type="Sitecore.Cloud.Xdb.CloudBasedTransportFactory, Sitecore.Cloud.Xdb" singleInstance="true">
                <param desc="serviceUrl">[reporting service URL]</param>
                <param desc="certificateThumbprint">[SSL certificate thumbprint]</param>
            </httpTransportFactory>
    

xDB Cloud uses Cloud Search, an index for analytics that is separate from the indexes and search provider that you use for content indexing.

You must configure your content search differently depending on whether you use Solr or Lucene. As a guide, use Solr if you are using multiple content delivery servers. Lucene is more suitable for single content delivery server environments.

To configure Lucene with the Cloud Search index:

  • Enable the following configuration file by removing the .disable extension from the file name:

    • Website/App_Config/Include/Sitecore.ContentSearch.Lucene.DefaultIndexConfiguration.config

Sitecore enables Lucene configuration files, and disables Solr configuration files, by default. Therefore, to configure Solr and Cloud Search, you must:

  1. Disable all Lucene files by adding the .disabled extension to the file name.

  2. Configure Solr.Walkthrough: Setting up Solr

  3. Enable the following Solr configuration file by removing the .disabled extension from the file name:

    • Website/App_Config/Include/Sitecore.ContentSearch.Solr.DefaultIndexConfiguration.config

To complete the xDB Cloud client configuration and connection to the xDB Cloud service, you must deploy marketing definitions.

Note

If you are using the Sitecore Experience Database (xDB) functionality, you must first set the Xdb.enabled and Xdb.Tracking.Enabled parameters to true. If you do not do this, you cannot deploy marketing definitions.

To deploy marketing definitions:

  1. Enable the following configuration file by removing the .disabled extension from the file name.

    • Website/App_Config/Include/Sitecore.Xdb.Remote.Client.MarketingAssets.config

  2. On the Sitecore Launchpad, click Control Panel, Analytics, Deploy marketing definitions.

  3. In the Deploy marketing definitions dialog, select all of the definitions and taxonomies and click Deploy.

Note

If you do not deploy marketing definitions, the binary data stored in the Data column in the definition tables (CampaignActivityDefinitions, GoalDefinitions), might not be compatible with Sitecore XP 8.2 rev. 170407 (Update-3).