Usercentrics - PUBLIC

Usercentrics + Joomla! Implementation Guide (CMP v1 and v2)

Owned by Elizabeth Johnson (Unlicensed)
Last updated: Jul 21, 2021
4 min read

Here you will find the documentation you need to manually implement and enable Usercentrics CMP v1 or CMP v2 to your Joomla website manually by Script Tag 

  1. Login to your admin section of your Joomla website

  2. Select “Template” under “Configuration” in the left side menu

  3. Select “Templates” on the left and find your current theme and select it by clicking the link in the template column.

  4. Once in your current theme, select “index.php”on the left menu and then in the <head> section, at the very end, enter your script tag. 

 

In your Settings dashboard you can find your personal script with your Settings-ID under „General“ (CMP v1) or “Implementation” (CMP v2) 

Code for CMP Version 1

<script type="application/javascript" src="https://app.usercentrics.eu/latest/main.js" id="XXXXXXXXX"></script>

Code for CMP Version 2

<script id="usercentrics-cmp" data-settings-id="XXXXXXXX" src="https://app.usercentrics.eu/browser-ui/latest/loader.js" async></script>

Copy your unique script from the Admin Interface or replace “XXXXXXXXX” with your personal Settings-ID in the above relevant code example.

 

5. Select save in the top right corner

 

Part 3: Do not forget: Manually Block Your Third Party Services! 

Do you have third party services, such as Google Analytics? If you are unsure, you can find out by using our DPS Scanner in your Admin Interface

If you have third party services, you will need to block each of them until a user gives consent. In order to block third party services and cookies until the user has given consent, you will need to follow the steps below for each third party. 

Using Google Analytics as a third party service example, you can follow the steps below:

Step 1: Add Google Analytics Code to Joomla manually

Add your Google Analytics code to the head section of the current theme under the Script Tag. You can get to the head section of your current theme by following the steps

  1. Select “Template” under “Configuration” in the left side menu 

  2. Select “Template” on the left side  and find your current theme and select it by clicking the link in the template column.

  3. Once in your current theme, select “index.php”on the left menu and then in the <head> section, at the very end, enter your Google Analytics Script Tag. 





Step 2: Adjust the Existing Google Analytics Script

Once the Usercentrics tag script has been integrated into your website, all existing scripts need to be customized. This step is mandatory to ensure scripts are only executed after a consent has been given.

Change script type – “text/javascript” becomes “text/plain”

To customize your scripts, two small adjustments are necessary. The first one refers to the script type. Change the type from type="text/javascript" to type="text/plain" in your scripts.

If your script does not explicitly specify type="text/javascript" as it can be interpreted by the browser without naming it, you still have to adjust it to type="text/plain".

This adjustment is mandatory to ensure the script is not automatically interpreted and executed by the browser when the page is called.

Assign a data attribute

The scripts of the data processing services that you‘re using need to be given a custom data attribute. It is used to connect to our Consent Management Platform and to query consents.

The syntax of this data attribute is data-usercentrics="Name Data Processing Service", where “Name Data Processing Service” corresponds to the exact name of the Data Processing Services you created in your Settings dashboard under “Data Processing Services“.

As an example, we're going to adjust the Google Analytics script.

Here is the original script:

Once adjusted, it becomes:

From now on, upon page load, the Google Analytics script will only be executed if your visitor has given consent to Google Analytics.

⚠️ Note: If a user revokes consent after a service was already loaded, then you must ensure the service is disabled or not used anymore. For example, you can force a page reload which will stop data processing services without consent from being executed.

Repeat the steps above for any other third party services you have. 

 

CMP v1: For questions about third party services using GTM, please see our documentation for CMP v1 here 

CMP v2: For questions about third party services using GTM, please see our documentation for CMP v2 here

Do you need further help?

How can I get help with questions on the Usercentrics CMP?

Usercentrics - PUBLIC