Skip to main content

Documentation

Getting started

  • Introduction

    Corporate Tools integrates valuable tools that make everyday IT life easier into YOOtheme Pro. Namely, these tools are:

    Consent Tools

    • Usercentrics
    • Cookiebot (coming soon)
    • Cookie Consent (coming soon)

    Usercentrics

    Corporate Tools integrates the Usercentrics Consent Management Platform into YOOtheme Pro. This way you can collect consents from your website visitors. To protect the privacy of your visitors there is a feature called YOOtheme Data Protector which handles third-party services that come with YOOtheme Pro and controls them according to the GDPR. YOOtheme Data Protector follows a zero-connection approach which means: No requests are made to third-party servers unless the user has given his consent.

    Read more

  • Installation

    Requirements

    Make sure to meet the requirements for installing the Corporate Tools plugin:

    • PHP 8.0+
    • Joomla! 4.0+
    • YOOtheme Pro 4.0+

    Installation

    Download the Corporate Tools plugin and install it using the offical Joomla installation instructions. Note that the plugin must be enabled before it will work. This is usually done by the installation script. When enabled, you will see a new section in the Website Builder called "Corporate Tools". If the section does not appear please check the plugin status in the backend and enable the extension manually if necessary.

    Download ID

    To enable 1-click updates for the Corporate Tools plugin you need to enter your Download ID. For more information please read the paragraph about "Updating".

  • Updating

  • Changelog

Usercentrics

  • Consent Management

    To set up the Consent Management Platform (CMP) please go to: YOOtheme ⇒ Corporate Tools ⇒ Consent Tools ⇒ Usercentrics ⇒ Settings.

    Setting ID

    To enable the CMP you need to enter your Setting ID. A Setting ID can be issued by

    • Usercentrics
    • eRecht24 (Usercentrics partner)
    • ruhe.potential (Usercentrics and eRecht24 partner)

    or some other partner you are working with. If you don't use eRecht24 and you don't have a partner yet you might want to subscribe to our Business Plan which includes a Usercentrics Setting ID and the professional integration into your Joomla! CMS. Please This email address is being protected from spambots. You need JavaScript enabled to view it. for more information.

    Privacy Policy / Imprint

    When entering the Setting ID the CMP shows up and won't disappear until you have made your decision. To be clear: You can't access your website's frontend without having made a privacy decision. However, your privacy policy and imprint should be accessible without having made any decision. In order to suppress the CMP on these sites you need to enter the links to these sites.

    You can choose the corresponding menu item by clicking on the link symbol, then choose the tab "Menu Items" and then search for the menu item if not listed yet. The link to the menu item will be pasted into the input field and should look like this: index.php?Itemid=101.

    Do not choose the article itself! Always choose the menu item that leads to the article, otherwise the CMP won't be suppressed correctly!

    Data Processing Services

    You might wonder that there is no possibility to define the external services you use on your website. The Usercentrics CMP is a Software-as-a-Service, thus the CMP and its configuration will be loaded from Usercentrics when opening your website. This is the reason why you cannot make any changes to the CMP in Corporate Tools.

    You need to register all data processing services that you use on your website. This can be done in the control panel of your Usercentrics dealer. Please contact your dealer for more information.
  • Data Protection

    Concept

    When using this plugin you don't block cookies but third-party technologies themselves: Entire services like Google Maps or YouTube won't be executed unless the website visitor has given his consent. If not, no external scripts are executed which implies that no cookies are set, too.

    Mode

    You might want to adjust how data protection works on your website. You can choose from these options:

    • Disabled
    • YOOtheme Data Protector
    • YOOtheme + Smart Data Protector

    While disabling data protection should only be used for troubleshooting you can extend the default protection of YOOtheme Data Protector. This might be useful if you use third-party services that don't come with YOOtheme Pro. Please look at the table below to decide if you need to extend YOOtheme Data Protector.

    Do not disable data protection on your production websites! Disabling is only meant for debugging to find out if there is an issue in the data protector or in the technology itself.

    YOOtheme Data Protector

    YOOtheme Data Protector is a short script that was explicitly invented for YOOtheme Pro. It handles third-party services that come with YOOtheme Pro and controls them according to the GDPR. Technically, this is done by preventing external scripts from being executed and from being preloaded from third-party servers - unless the user has given his consent. It already supports a small number of other Joomla! extensions and is being developed to support more and more extensions natively.

    Currently supported technologies:

    Service Supported Platform
    Google Analytics YOOtheme Pro
    Google Maps YOOtheme Pro, DPCalendar
    OpenStreetMap YOOtheme Pro, DPCalendar
    reCAPTCHA Visible Joomla!, RSForm!Pro*
    reCAPTCHA Invisible Joomla!, RSForm!Pro*
    Vimeo Joomla!, YOOtheme Pro
    YouTube Video Joomla!, YOOtheme Pro

    * Partially supported

    Smart Data Protector

    Smart Data Protector was invented by Usercentrics and prevents external services from being executed. Unlike YOOtheme Data Protector it cannot prevent external scripts from being preloaded from third-party servers. Moreover it doesn't handle external services that come with YOOtheme Pro properly, i.e. Google Analytics, Google Maps and OpenStreetMap. Nevertheless, it supports a wide range of third-party services and can be additionally enabled if needed. If you need a zero-connection solution please This email address is being protected from spambots. You need JavaScript enabled to view it..

    Currently supported technologies:

    See documentation

  • Advanced Mode

  • Technical Insights

    Block services instead of cookies

    We believe that blocking third-party technologies has advantages over just blocking cookies. If I am a website visitor with poor technical knowledge I cannot determine which cookies are "bad" and which are "not so bad". Instead, I have to decide whether I want to watch this video or not. And I will make my decision on plain information like: What data is collected? Who receives my data? And for what purpose? A Consent Management Platform can provide this information. And in case of consent the technology can be loaded asynchronously.

    Wrap external scripts into JS functions

    Loading technologies asynchronously or afterwards implies that associated external scripts must not be preloaded. To achieve this, the HTML document must be changed server-side. Otherwise, your browser will load these external scripts from Google, Facebook or whatever external service is embedded in the website you are visiting at the moment. Preloading files implies reporting personal data to your opposite like IP address or date and time of access. But at that moment you have not given your consent to this service yet. We can prevent this pre-connection by wrapping the link of the external ressource into a javascript function. By doing so the external ressources will only be loaded if you have given your consent and when you really need them.

    Asynchronous loading of technologies might cause some time delay until the technology shows up. We will probably implement new techniques in the future that will lower this small delay .

    Execute services when scripts are ready

    This is no special technique but crucial for third-party services when they use more than one script that is loaded asynchronously. In case of one script relies on another the dependent script must no be executed before the underlying object is loaded and ready for use. Otherwise, there will be errors and malfunctions.

    Corporate Tools for YOOtheme Pro assures that interdependent scripts are executed in the right order. This is crucial for services like Google Maps or OpenStreetMap that are used in the Map element of YOOtheme Pro.
  • Troubleshooting

    Q: My YOOtheme Pro style won't be applied to the CMP. What's going wrong?

    A: Nothing is going wrong. This is an expected behaviour. The Consent Management Platform (CMP) is a SaaS solution and uses its own Shadow DOM. Shadow DOMs separate their elements from any design specifications that have been made to the ordinary DOM.

    If you need the CMP with your own logo and design, you have to purchase a fully featured Usercentrics license starting at 50€ per month. For more information please This email address is being protected from spambots. You need JavaScript enabled to view it..

    Q: I have enabled the CMP but external services like Google Maps aren't blocked. What can I do?

    A: Have you registered all data processing services? The CMP needs to know which third-party services you use on your website. Otherwise the CMP won't control these services.

    Setting up the CMP also includes specifying the data processing services that you use on your website. Please ask your Usercentrics partner to do this setup for you or use your Usercentrics account to do this on your own.