TRUENDO CMP Injector Joomla Plugin


Welcome to the TRUENDO CMP Injector Joomla plugin documentation. This plugin is designed to seamlessly integrate the TRUENDO Consent Management Platform (CMP) into your Joomla website by injecting the necessary CMP script and setting global JavaScript variables. This ensures compliance with data privacy regulations and enhances user experience by managing consent effectively.


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.
  • The TRUENDO Joomla plugin



Downloading the Plugin#

Download the TRUENDO Joomla plugin here.


Installing the Plugin#

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

  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.
  2. Navigate to the Extensions Manager:

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

    • In the Install page, locate the "Upload Package File" tab.
    • Click on the "Choose File" button (or drag and drop) to select the truendo.zip file from your local machine. Click here if you have not already downloaded the plugin.
  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 that the ZIP archive is correctly structured.
    • Verify that you have sufficient permissions to install extensions.
    • If errors persist, consult the Error Logs (see Troubleshooting).

Enabling the Plugin#

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

  1. Navigate to Plugin Manager:

    • Click on "Extensions" in the top menu.
    • Select "Plugins" from the dropdown.
  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.
  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.

Configuring the Plugin#

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

  1. Open Plugin Configuration:

    • In the Plugin Manager, click on the plugin name "System - Truendo CMP Injector" to open its settings.
  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 font settings.
    • Setting Boolean Fields:

      • Each of the boolean fields is represented by a checkbox.
      • Checked: Represents true.
      • Unchecked: Represents false.
  3. Save Configuration:

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

Verifying the Installation#

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

  1. Clear Joomla Cache:

    • Go to "System" > "Clear Cache".
    • Select all cache items and click "Delete".
  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> <script src="https://your-truendo-cmp-url.com/truendo.js"></script> <script> window.accessibility_mode = true; window.autoblocking_disabled = false; window.siteid = "12345"; window.transparency = true; window.nofont = false; </script> <!-- Other head elements --> </head>
  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.


Troubleshooting#

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

1. 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.

2. CMP Script Not Injected Correctly

  • Verify CMP Script URL:

    • Ensure the CMP script URL in truendo.php 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.

3. Window Variables Not Set Correctly

  • Review Plugin Configuration:

    • Ensure that all checkboxes are set according to your requirements.
    • Confirm that the siteid is correctly entered.
  • Inspect Page Source and Console:

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

4. 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.

5. Contacting Support

If you've exhausted troubleshooting steps without resolution:

  • Contact the Plugin Developer:

    • Reach out to the developer or provider from whom you obtained the plugin.
  • Hire a Joomla Expert:

    • Consider engaging a professional Joomla developer for personalized assistance.

Support and Additional Resources#

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


Final Notes#

The TRUENDO CMP Injector plugin is a powerful tool to manage user consent and ensure compliance with data privacy regulations. By following this documentation, you can effectively install, configure, and verify the plugin's functionality on your Joomla website. Always ensure that you keep the plugin updated and regularly review its configuration to align with evolving compliance standards and your website's needs.

If you have any further questions or require additional assistance, don't hesitate to reach out through the support channels mentioned above.


This documentation was last updated on October 15, 2024.

×