Skip to main content

Customer Support

Documentation

Getting started

  • Introduction

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

    Consent Tools

    • Consent Overlays
    • Consent Management
      • Usercentrics

    Consent Overlays do not only block cookies but external services themselves. There is no connection to any third-party servers unless the user has given his consent to load the service.

    Usercentrics is a leading provider of Consent Management Platforms (CMP) that helps you obtain, manage and document the consent of your visitors.

  • 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

  • Getting started

    With Consent Overlays you can inform your visitors about external services and request their consent before loading the service. Consent Overlays are highly customizable and fully adapt to your YOOtheme Pro style. You can even show thumbnails of your map and video content which will be automatically fetched and cached by this extension. The visitor's privacy is still protected until the consent is given.

    Services & Data Protection

    Consent Overlays do not only block cookies but external services themselves. There is no connection to any third-party servers unless the user has given his consent to load the service. Currently, this high level of data protection applies to these services (with integrators in braces):

    • Google Analytics (YOOtheme Pro)
    • Google Maps (YOOtheme Pro, DPCalendar*)
    • OpenStreetMap (YOOtheme Pro, DPCalendar*)
    • reCAPTCHA (Joomla!, RSForm!Pro)
    • Vimeo (YOOtheme Pro, Joomla!)
    • YouTube (YOOtheme Pro, Joomla!)

    If you are missing some popular service or integrator, you can inform us. However, there is no garantuee that a certain service will be integrated in future versions. There are many services and an even more combinations of services x integrators that won't all be covered.

  • Overlays

    Consent Overlays are highly customizable and fully adapt to your YOOtheme Pro style. You can create an overlay, text or banner for each external service. Depending on the service different templates are used:

    Overlay

    The Overlay template applies to Google Maps, OpenStreetMap, Vimeo and YouTube. It handles map and video content that is embedded in YOOtheme Pro Pages. The Overlay template uses the following content blocks:

    • Title
    • Content
    • Info Button
    • Consent Button
    • Withdrawal Button
    You can disable each block by removing the content from its associated customizer field. However, it's not recommended to disable any of the buttons if you want to comply with the GDPR.

    The Content block is the most flexible one. You can display a single paragraph or create a custom layout as well. You can even render custom text as Info Button or Consent Button by using the shown syntax.

    The Info Button is a link to your privacy policy in order to fully inform your visitors about the data processing service. If you prefer to link to a certain section of your policy you can append its #id to the link.

    The Consent Button is connected to a special function. When clicked the user's consent will be set in the browser storage and the external service will be enabled.

    The Withdrawal Button only appears when the consent is given. It is connected to a special function as well. When clicked the user's consent will be removed from the browser storage and the external service will be disabled.

    Text

    The Text template applies to reCAPTCHA. The Text template uses the following content blocks:

    • Content
    • Withdrawal Button

    The Content block is used to show a paragraph with Info Button and Consent Button incorporated. You have to use a special syntax to render custom text as buttons. You will find an instruction underneath the editor field.

    The Withdrawal Button works the same as described in the Overlay template.

    Banner

    tbd.

  • Thumbnails

    Consent Overlays can automatically fetch and show thumbnails of your map and video content (i.e. Google Maps, OpenStreetMap, Vimeo and YouTube). To enable thumbnail generation you need to insert your API key for the corresponding service.

    Maps Static API

    This API is used to generate static images for your Google Maps map. Once you have entered your API key our extension fetches thumbnails based on your center coordinates and zoom settings. 

    Geoapify

    This API is used to generate static images for your OpenStreetMap map. Once you have entered your API key our extension fetches thumbnails based on your center coordinates and zoom settings. 

    Vimeo oEmbed v2

    This API is used to request the link for the thumbnail with highest resolution. You don't have to enter an API key. Thumbnails are fetched based on the video ID.

    YouTube Data API v3

    This API is used to request the link for the thumbnail with highest resolution. Once you have entered your API key our extension fetches thumbnails based on the video ID.

    Thumbnail generation is secured by hashes to block unauthorized requests to your server and the APIs. However, please make sure that you have configured your API with access restrictions (such as IP address of your website, usage limits per day, ...). If you still encounter too many or fraudulent requests, activate the "Limit API requests" checkbox in the Advanced settings. This will instruct our extension to fetch exactly 1 image with maximum dimensions. Downside is that the copyright text might not be visible any more depending on the HTML element's dimensions on your website.
  • Multilingual Sites

    Consent Overlays can be used on multilingual sites to display your content in different languages. To achieve this, create your own language constants, place them in the corresponding customizer fields and translate your constants using language overrides.

    Translatable fields

    All content blocks recognize language constants and will translate them into language strings. You can use language constants within these fields:

    • Title
    • Content
    • Image Alt
    • Info Button Text
    • Consent Button Text
    • Withdrawal Button Text
    Note that you can also use special elements like [custom text](consent) in your language strings. Make sure you write them exactly as you would do in the text editor code view.

    How to translate

    We will show you an example how to use language constants and translate them in Joomla!.

    1. Go to Joomla! Backend → YOOtheme Pro → Corporate Tools → Consent Tools → Consent Overlay → reCAPTCHA → Content.
    2. Switch the editor to Code view and enter exactly the following language constant
      CORPORATE_CONSENT_RECAPTCHA_CONTENT.
    3. Go to Joomla! Backend → System → Language Overrides.
    4. Select your frontend language, for example English (United Kingdom) - Site.
    5. Click New in the toolbar.
    6. Into the Language Constant field, enter exactly
      CORPORATE_CONSENT_RECAPTCHA_CONTENT.
    7. Into the Text field, enter your translated language string with respect to special syntax elements. Your language string could look like this:
      <strong>We need your consent to load the reCAPTCHA service!</strong> We use reCAPTCHA to check your entered information. This service may collect data about your activity. Please <strong>[review the details](info)</strong> and <strong>[accept the service](consent)</strong> to proceed.
    You can freely choose the name of your language constant. Make sure to use a unique name with a common prefix like CORPORATE_CONSENT. Don't use whitespaces in constant names. Learn more about language overrides in the official Joomla! documentation.
  • 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 local 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.
  • Privacy & GDPR

    Consent Overlays help you comply with the GDPR in a technical way. They do not help you create an appropiate privacy policy and inform your website visitors by linking to it. As a site owner you are fully responsible for an appropiate setup of this plugin and its contents.

    Local Consent Storage

    One principle of GDPR is to limit the collection of personal data to what is really necessary in order to accomplish a purpose. The purpose of this module is to enable/disable external services based on the visitor's decision.

    Therefore, this module only saves the consent status in the LocalStorage of the visitor's browser. This is done for each single service. Downside is that consent decisions are not stored for documentation purposes. If you need to store consent decisions securely for such purposes, you can extend Consent Overlays by enabling a Consent Management Provider such as Usercentrics.

    A Usercentrics license is not part of the subscription and has to be purchased separately.

    Proxy Data Processing

    When requesting a thumbnail for an external services, a connection to an API will be established and an IP address will be transmitted. Thus, personal data will be processed without any prior consent. If the visitor's browser made that request this would result in a violation against the GDPR.

    With Consent Overlays you run your own proxy server that listens to visitor requests, fetches the desired thumbnail from the API and delivers it to the visitor. Thus, your visitors will only connect to your own website and no personal data will be transmitted to any third-party servers.

    To prevent unauthorized proxy requests, each thumbnail request is secured server-side by hashes. Thus, it's not possible to create thumbnails from any other maps or videos than the ones you show on your website. Nevertheless, keep an eye on your API requests and limit them wisely.

Usercentrics

  • Getting started

    Usercentrics is a leading provider of Consent Management Platforms (CMP) that helps you obtain, manage and document the consent of your visitors. Corporate Tools integrates the CMP into YOOtheme Pro for a seamless experience.

    A Usercentrics license is not part of the subscription and has to be purchased separately.

    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:

    • YOOtheme Data Protector
    • YOOtheme + Smart Data Protector

    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 supports a small number of other Joomla! extensions as well.

    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.

    However, 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

  • 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 15€ 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.