Use patch files to customize Universal Tracker configuration

Current version: 10.0

You must use patch files to add or change configuration settings. Sitecore merges the patch files with the Sitecore configuration file to create the configuration that is used at runtime. 

Note

If you change the configuration for either the collection or processing service, you must restart the Universal Tracker service you have changed in order for the changes to take effect.

The configuration files in Sitecore make up the default configuration. When you add a patch file to adjust or add settings, you can copy the folder structure from the individual plugin (the folder path under sitecore) into the main applications and add your own configuration files to extend the configuration provided by any plugin.

For example, when you configure the SQL Server connection string, instead of editing the \sitecore\Sitecore.Tracking.SqlServer\Config\config.xml, you must use a patch file:

  1. Create a folder in the root of the application and name it config.

  2. Add a file to the folder and name it, for example, deployment.xml .

  3. Inside the deployment.xml file, add XML nodes which match those from the SQL plugin and fill in the ConnectionString node value:

    RequestResponse
    <Settings>
        <Sitecore.Tracking.SqlServer>
            <SqlServerTrackingInteractionCache>
                <ConnectionString>server=.\sql2016;database=Sitecore.Tracking;user id=sa;password=awesomecore</ConnectionString>
            </SqlServerTrackingInteractionCache>
        </Sitecore.Tracking.SqlServer>
    </Settings>

    This configuration is relevant for both the collection application and the processing application.

Do you have some feedback for us?

If you have suggestions for improving this article,