print

Integrating TRUENDO CMP with Joomla

Introduction#

Welcome to the comprehensive guide on integrating the TRUENDO Consent Management Platform (CMP) into your Joomla website using the TRUENDO CMP Injector Joomla Plugin. This plugin seamlessly injects the necessary CMP script and sets global JavaScript variables, ensuring compliance with data privacy regulations like GDPR and enhancing user experience by effectively managing user consent.

1. Prerequisites#

Before installing and configuring the TRUENDO CMP Injector plugin, ensure that your environment meets the following requirements:

  • Joomla Version: Joomla 4.x is recommended for optimal compatibility.
  • Administrator Access: You must have administrator privileges to install and configure plugins.
  • TRUENDO Joomla Plugin File: Download the TRUENDO Joomla plugin from here.

2. Downloading the Plugin#

Download the TRUENDO Joomla plugin by clicking here. Save the truendo.zip file to an easily accessible location on your computer.

3. Installing the Plugin#

Follow these steps to install the TRUENDO CMP Injector plugin via the Joomla Administrator backend:

Step 1: Log In to Joomla Administrator

  • Open your web browser and navigate to your Joomla administrator login page, typically at https://yourdomain.com/administrator.
  • Enter your Username and Password, then click "Log in".

Step 2: Navigate to the Extensions Manager

  • Once logged in, click on "Extensions" in the top menu.
  • From the dropdown, select "Manage" and then "Install".

Step 3: Upload the Plugin Package

  • On the Install page, ensure you are under the "Upload Package File" tab.
  • Click on the "Choose File" button or drag and drop to select the truendo.zip file you downloaded.

Step 4: Install the Plugin

  • After selecting the file, click "Upload & Install".
  • Joomla will process the installation. A success message should appear once completed.

Troubleshooting Installation Errors:

  • Ensure Correct ZIP Archive: Verify that the ZIP archive is correctly structured.
  • Check Permissions: Confirm that you have sufficient permissions to install extensions.
  • Consult Error Logs: If errors persist, consult the Error Logs (see Troubleshooting).

4. Enabling the Plugin#

After installation, the plugin needs to be enabled to function correctly.

Step 1: Navigate to Plugin Manager

  • Click on "Extensions" in the top menu.
  • Select "Plugins" from the dropdown.

Step 2: Locate the TRUENDO CMP Injector Plugin

  • Use the search bar at the top right and type "Truendo" or "TRUENDO CMP Injector" to filter the list.
  • Locate "System - TRUENDO CMP Injector" in the list.

Step 3: Enable the Plugin

  • Check the Status column next to the plugin.
  • An enabled plugin is indicated by a green checkmark.
  • If the plugin is disabled (red "X"), click the icon to toggle it to Enabled.

5. Configuring the Plugin#

Once enabled, you need to configure the plugin to set the necessary parameters for the CMP script and window variables.

Step 1: Open Plugin Configuration

  • In the Plugin Manager, click on the plugin name "System - TRUENDO CMP Injector" to open its settings.

Step 2: Configure Plugin Parameters

You will see a "Plugin Parameters" section containing the following fields:

  • Accessibility Mode: Enable or disable accessibility features.
  • Autoblocking Disabled: Enable or disable autoblocking.
  • Site ID: Enter your specific Site ID provided by TRUENDO.
  • Transparency: Enable or disable transparency features.
  • No Font: Enable or disable custom font settings.

Setting Boolean Fields:

  • Each of the boolean fields is represented by a checkbox.

    • Checked: Represents true.
    • Unchecked: Represents false.

Step 3: Save Configuration

  • After setting all parameters, click "Save" or "Save & Close" to apply the changes.

6. Verifying the Installation#

After installation and configuration, it's essential to verify that the plugin is functioning as intended.

Step 1: Clear Joomla Cache

  • Go to "System" > "Clear Cache".
  • Select all cache items and click "Delete".

Step 2: Check the Frontend

  • Open your website's frontend in a browser.

View Page Source

  • Right-click on the page and select "View Page Source" or press Ctrl+U (Cmd+U on Mac).
  • Locate the <head> section.

Verify Script Injection

  • Ensure that the TRUENDO CMP script is the first script in the <head> section.
  • Confirm that the window variables are set correctly based on your configuration.
<head>
    <!-- TRUENDO CMP Script -->
    <script src="https://cdn.priv.center/pc/truendo_cmp.pid.js"></script>
    <script>
        window.accessibility_mode = true;
        window.autoblocking_disabled = false;
        window.siteid = "YOUR_SITE_ID";
        window.transparency = true;
        window.nofont = false;
    </script>
    <!-- Other head elements -->
</head>

Step 3: Use Browser Developer Tools

  • Open Developer Tools in your browser (F12 or Ctrl+Shift+I / Cmd+Option+I).
  • Navigate to the Console tab.
  • Execute the following commands to verify the window variables:
console.log(window.accessibility_mode); // Should log: true or false
console.log(window.autoblocking_disabled); // Should log: true or false
console.log(window.siteid); // Should log: "YOUR_SITE_ID"
console.log(window.transparency); // Should log: true or false
console.log(window.nofont); // Should log: true or false
  • Ensure that the logged values correspond to your plugin configuration.

7. Troubleshooting#

If you encounter issues during installation, configuration, or verification, follow these troubleshooting steps:

A. Plugin Not Visible or Not Clickable

  • Ensure Correct Installation:

    • Verify that all plugin files are correctly placed in the plugins/system/truendo/ directory.
    • Reinstall the plugin if necessary.

  • Check Joomla Version Compatibility:

    • Ensure you are using Joomla 4.x. Older versions may not support the plugin correctly.

  • Verify User Permissions:

    • Ensure your user account has administrator privileges to manage plugins.

B. CMP Script Not Injected Correctly

  • Verify CMP Script URL:

    • Ensure the CMP script URL in the plugin configuration is accurate and accessible.

  • Check for JavaScript Errors:

    • Open the browser console and look for any JavaScript errors that might prevent script execution.

  • Clear Browser and Joomla Cache:

    • Sometimes, cached content can prevent new scripts from loading. Clear both Joomla and browser caches.

C. Window Variables Not Set Correctly

  • Review Plugin Configuration:

    • Ensure that all checkboxes are set according to your requirements.
    • Confirm that the Site ID is correctly entered.

  • Inspect Page Source and Console:

    • Verify that the window variables are present and have the correct values.

D. General Issues

  • Enable Joomla Debug Mode:

    • Go to "System" > "Global Configuration" > "System" tab.
    • Set "Debug System" to "Yes" and save.
    • Reproduce the issue and check for error messages.

  • Consult Joomla Logs:

    • Navigate to "System" > "System Information" > "Logs".
    • Review any recent error logs related to the plugin.

  • Seek Community Support:

    • Visit the Joomla Forums to ask questions or search for similar issues.

E. Contacting Support

If you've exhausted troubleshooting steps without resolution:

  • Contact TRUENDO Support:

    • Reach out to the TRUENDO support team at support@truendo.com or use the chat feature on our website.

  • Hire a Joomla Expert:

    • Consider engaging a professional Joomla developer for personalized assistance.

8. Support and Additional Resources#

For further assistance with the TRUENDO CMP Injector plugin or Joomla in general, refer to the following resources:

9. Conclusion#

Regularly updating and reviewing your plugin configuration will help maintain compliance as regulations evolve.

Thank you for choosing TRUENDO CMP for your consent management needs.

End of Guide

This documentation was last updated on October 15, 2024.

×