Configure Usercentrics

Edit on GitHub

Based on the tracking tools used in each of your Storefronts, you can define different sets of tracking tool configurations, called settings in the Usercentrics Admin Interface. Every configuration is identified by a unique setting ID. The setting ID lets you add a cookie consent dialog with the defined configuration to a store. By adding different setting IDs to different stores, you can comply with the legislation of different countries on a per-store basis. Each store can have only one setting ID, while the same ID can be used in different stores. For example, all European stores that need to be GDPR compliant can use the same setting ID.

To be GDPR compliant, you need to inject the Usercentrics cookies consent dialog into every page. Because there usually isn’t a single root place of injection available, if an external CMS is connected to your Spryker project, you need to separately inject the dialog into the pages in that system too.

Usercentrics supports some tracking tools and data processing services by default, but you can integrate custom ones too:

usercentrics-services

To integrate a custom service, you will need to manually configure it in the Usercentrics Admin Interface. Also, if you manually integrate Usercentrics into your Spryker project, you will need to adjust the integration to enable the custom service. For more information about custom services, see Usercentrics documentation on custom data processing services.

Once Usercentrics is set up, a cookie consent dialog similar to the follow is displayed on every Storefront page:

usecentrics-basic-cookie-consent-popup

When customers click on More in the dialog, they can consent to or reject each individual tool and service:

usercentrics-cookie-consent-details-popup

Prerequisites

Configure data processing services in Usercentrics

  1. In the Usercentrics Admin Interface, go to Service Settings > Data Processing Services.
  2. Under Data Processing Service, select a services used by your store.
  3. Apply additional configurations according to your use case.
  4. Repeat steps 2-3 until you define all the services used in your store.

Connect Usercentrics

  1. In the Back Office, go to Apps > Catalog.
  2. Click Usercentrics.
  3. Click Connect app. This displays a message about the successful integration of the app. The Usercentrics app’s status changes to Connection pending.

Integrating Usercentrics into frontend

There are three ways to integrate Usecentrics into frontend:

If you are not using a third-party tracking management tool, like Google Tag Manager, and want a code-free integration, we recommend integrating using the Smart Data Protector.

Integrating Usercentrics manually

ACP does not support a direct integration, so you won’t be able to manage Usercentrics in the Back Office.

To integrate manually, you need to do the following:

  • Inject the Usercentrics JavaScrip tag with the setting ID into your frontend. Example script tag for the direct integration:
<script id="usercentrics-cmp" data-settings-id="apXtrZ9ec" src="https://app.usercentrics.eu/browser-ui/latest/bundle.js" defer></script>

apXtrZ9ec is the setting ID that identifies configuration of the data processing services for your store in the Usercentrics Admin Interface.

  • Deactivate the JavaScript code of all the tracking tools on the shop pages and give tools the names that match those in the Usercentrics Admin Interface.

For more details about the manual integration, see Direct integration of Usercentrics into your website.

The Usercentrics Smart Data Protector blocks the data processing services and activates them only for customers that give their consent to do so.

With the Smart Data Protector, you don’t need to program the cookie consent dialogs or JavaScript code to each page. Instead, you can configure the dialog in the Usercentrics Admin Interface, and it’s automatically added to your store’s pages.

To integrate Usercentrics using Smart Data Protector, you need to inject the Usercentrics JavaScript tag with the setting ID and Smart Data Protector JavaScript code.

Integrating Usercentrics with Google Tag Manager

If Google Tag Manager is integrated, you can use Usercentrics to display a cookie consent dialog with the services and tools configured in Google Tag Manager.

To use Usercentrics with the Google Tag Manager, do the following:

  • In the Usercentrics Admin Interface, go to Service Settings > Data Processing Services and define the data processing services you have in Google Tag Manager.

  • In the Google Tag Manager UI, configure the variables and triggers to work with Usercentrics. For instructions, see Google Tag Manager Configuration.

Configure Usercentrics

  1. In the Usercentrics Admin Interface, copy the setting ID of your app.

usercentrics-setting-id

  1. In the Back Office, go to Apps.
  2. On the App Composition Platform Catalog page, click on the Usercentrics app.
  3. On the Usercentrics app details page, click Configure. This opens the Configure Usercentrics drawer.
  4. In the Configurations pane, select the needed integration method.
  5. Select the store and insert the setting ID you’ve obtained in step 1.
  6. Optional: To activate Usercentrics for the selected store, select Is active.
  7. Click Save.

usercentrics-configuration

The drawer closes with a success message displayed. On the App Composition Platform Catalog page, the app’s status changes to Connected. The cookie consent dialog should be displayed on every Storefront page.

Retain Usercentrics configuration after a destructive deployment

[Destructive deployment](https://spryker.com/docs/dg/dev/acp/retaining-acp-apps-when-running-destructive-deployments.html) permanently deletes the configuration of Usercentrics.

To run a destructive deployment, follow the steps:

  1. Disconnect Usercentrics.
  2. Run a destructive deployment.
  3. Reconnect Usercentrics.