Frequently asked questions
Please log into your Usercentrics Admin Interface. You’ll see one of the following User Interfaces.
Admin Interface Version 1
This Settings-ID is using Version 1 of our Admin Interface. You can see this in the menu items General and Advanced which are located in another menu in version 2. If you would like to test version 2 right away, please get in touch with our support team.
Admin Interface Version 2
This Settings-ID has been running on version 2 right from the start. Here, you’ll see the menu item Implementation, which used to be located in a different menu in version 1.
To give you a quick overview of the migration process, here’s a handy checklist. Full details are in our videos or the linked documentation.
Checklist
-
Create a support ticket or contact your dedicated Customer Success Executive to enable the CMP v2 Admin Interface for your Configuration / Setting-ID.
Important
After this step has been completed by the support team or your personal CSE, the Admin Interface for the CMP v2 has been activated. Please note, that this does not automatically migrate your Usercentrics CMP to version 2. Further steps (outlined below) are needed to complete the migration on your website(s).
- Check your implementation for custom HTML (e.g. in the Banner Message, which was called Opt-In Message in v1) and remove it. Custom HTML is not supported with CMP v2.
- Adjust the styling of your CMP.
- Adjust the content (e.g. Banner Message).
-
Exchange the Usercentrics CMP script tag. Copy & paste the CMP v2 script tag from the v2 Admin Interface and replace your CMP v1 script tag with it.
Test in a staging environment or similar first.
- Adjust tags in your tag manager (new event + “once per page”). This process for CMP v2 is documented for Google Tag Manager (GTM) specifically.
For reference only (do not use with CMP v2): The CMP v1 GTM documentation. - Optionally, only if you’re using them, also adjust:
- API: Switch from using v1’s JavaScript API to v2’s Browser UI API
- Privacy Policy Embeddings: Switch from v1’s version to v2's version
- Event Listener: Switch from v1’s events to v2's events
- Privacy Link: If you’re using a Privacy Link (e.g. in the footer of your website) as your Privacy Trigger, this will need to be adjusted for CMP v2. You can get the HTML for the v2 Privacy Link in the v2 Admin Interface under Appearance → Layout tab → Privacy Trigger
- Adjust tags in your tag manager (new event + “once per page”). This process for CMP v2 is documented for Google Tag Manager (GTM) specifically.
Please note
Consents will be transferred automatically if the same Setting-ID is being used in the script tag.
Some settings in the Admin Interface (e.g. the Opt-In Message / Banner Message) apply to both version 1 and version 2 of the Usercentrics CMP. An overview of the settings is available.
If you are using the same Configuration / Setting-ID for v2 and you make changes in the Admin Interface for these settings, they are directly live on your current CMP version.
Possible next step
After your migration from v1 to v2, you can make use of v2’s Preview & Publish feature with future adjustments. It’s just one of the big improvements that come with the switch from version 1 to version 2 of the Usercentrics CMP.
If you are a customer currently on the CMP Version 1, you need access to the CMP Version 2 first before you can start the migration. Please log in to the Admin Interface to see if the following drop-down menu is visible:
Is it is visible, you can switch to the CMP v2 and start with your migration. If you are still on the CMO v1 and you don’t see this drop-down menu, please create a ticket for our Customer Service Team or contact your personal Customer Success Manager directly.
Provided that the Settings ID remains the same, previously obtained consents can be transferred over to v2. There is a script integrated in v2 that adjusts the local storage from v1 to v2.
Important
v2 is not backwards compatible, so converting consents from v2 to v1 is not possible.
Direct Implementation on the website
When changing to the new version of our CMP please replace the current Usercentrics script with the new script which you can find in your Usercentrics Admin Interface:
Documentation: Direct Implementation on the website.
Implementation via Google Tag Manager
Should you integrate data processing services using the Google Tag Manager, please adjust your tags’ existing variables and triggers: Usercentrics Documentation.
Nothing will change for data processing services which you have integrated directly into your source code. These can still be adjusted as described here.
Documentation: Implementation via Google Tag Manager.
Events and JavaScript API
When you switch to V2, the events and the call to our JavaScript API also change.
The logic that V1 provides on a website needs to be adapted to the new events and new calls of the JavaScript API in V2.
For example, instead of using “usercentrics” it’s used “UC_UI”.
Version 1
usercentrics.acceptAllConsents();
Version 2
UC_UI.acceptAllConsents().then(() 0 console.log('All consents are accepted'));
For more detailed steps for custom CMP functionalities, please also refer to our documentation:
Browser UI API V2.
The Browser UI (V2) provides different events that inform about consent changes or app initialization. These events can be used for Tag Manager and custom implementations.
For the individual steps, please follow the links below which will lead you to the corresponding documentation:
Version 2 of Usercentrics’ Consent Management Platform comes with a lot of enhancements, many of them only available in v2. Some of these include:
- Substantially reduced file size and faster loading times
- Performance optimized UI
- WCAG 2.1 AA web accessibility certification
- Cross-Device Consent Sharing
- Advanced Analytics Dashboard and Reporting
- A/B Testing
- Self-programmable UI and CMP behavior with Browser SDK
- Multi-configuration Bulk Editing
- Preview & Publish functionality
Please note that not all features may be available in your current plan. You can find an overview of all plans and features here.
To migrate to CMP v2, please replace the current Usercentrics script in your code with the new script available in your Usercentrics Admin Interface.
If you integrate Data Processing Services using the Google Tag Manager, please adjust your tags’ existing variables and triggers: Google Tag Manager configuration for CMP v2
If you use the following, they will also need to be changed, as they differ between v1 and v2:
- API
- Privacy Policy Embeddings
- Event Listener
- Privacy Link
Nothing will change for Data Processing Services that you have integrated directly into your source code. These can still be adjusted following the instruction in this guide: direct integration of the Usercentrics CMP into your website.
There are several reasons why the migration to CMP v2 requires manual effort:
- Depending on how you implemented the Usercentrics CMP, changes to the <head> section of your website and/or Google Tag Manager need to be made.
- The banner lay-out of CMP v2 looks different than the CMP v1 version and manual adjustments in the Admin Interface are necessary.
- Automatic changes might interfere with your current Usercentrics settings.
Comments
0 comments
Please sign in to leave a comment.