Consent Manager setup

Consent Manager setup

Introduction

This article provides instructions for admin users on how to set up and use

Consent Manager

for website cookie banners, cookie scan detection, and cookie maintenance.

This article also covers the legislation and regulation requirements to help website owners know which compliance level to target.

Consent Manager features:

• Custom and accessible branding
  Design a cookie acceptance banner to meet legislation and regulation requirements. Customize the banner to match the company brand and meet accessibility standards.
• Consent analytics
  Get real-time data about your visitor cookie acceptance trends.
• Consent log
  See a log of visitor consent choices. Visitor consent is properly and anonymously logged and stored, as required by GDPR.

Instructions

This section provides instructions for site admins on how to set up the cookie banner and how to categorize cookies.

Note

If your website uses Google Tag Manager, configure your setup through Google Tag Manager. Visit Google Tag Manager Deployment for instructions.

1. Navigate to the Domain Overview page.

2. Click Action on the same row as the domain and select Edit Domain from the expanded list of options.

   The system opens the Edit a domain page.

3. Locate the Features section.

4. Click to turn the Consent Manager switch to ON.

   

5. Save. 

   The system closes the Edit Domain page and the Admin settings page reopens.

6. Click Action on the same row as the domain and select Script Setup Guide from the expanded list of options.

   The system opens the Set up your domain page.

7. Click to turn the Add Acquia Web Governance Consent Manager switch ON.

   

8. Click the Open consent manager script settings link.

   The Consent Manager Script Settings page opens.

Cookie banner setup

This section provides information on how to configure the cookie banner.

Consent Manager pop-up setup section

Click on the mini window to select the location for the cookie banner pop-up to appear on the website landing page. The options are:

• Top left
• Top center
• Top right
• Middle left
• Middle right
• Bottom left
• Bottom center
• Bottom right

Consent Manager configuration section

This section provides instructions on how to set up the cookies to comply with CCPA or GDPR standards.

• Privacy regulation: Select the compliance regulation for your geographical location or intended audience.

  Tick to select:

  • CCPA
  • GDPR
  • Both CCPA & GDPR
  Note

  The fields that expand with each selection are not the same. Continue for instructions on each selection.

  For more information, visit GDPR and CCPA.

CCPA setup

California Consumer Privacy Act

• Opt out link: Click in the input field and enter the link to the company opt-out page.

• Link to Privacy Policy: Click in the input field and enter the link to the company Privacy Policy.

  Tip: The link should begin with http:// or https:// and can contain a maximum of 100 characters.

  For more information, visit Cookie and privacy policies.

• Cookie Overview:

  • Manage: Select this option if you choose manage the cookies with the scan.

    

    See Manage Cookies below for instructions on how to add and manage the cookies.

  • Link: Select this option if you have already done the work of categorizing your cookies, and wish to add a link to an external Cookie Overview page.
• Add empty callbacks: Add empty callbacks to the boilerplate (sections of nearly identical code that are reused in many places).
  • Add empty EventListeners: Add event listeners to the boilerplate (detects sections of nearly identical code that are reused in many places).

  • Add web overlay lock: Lock the website behind the banner, so that users cannot interact with the website before they accept cookies.

For more information, visit GDPR and CCPA.

GDPR setup

Select this option to access the following fields.

• Per category consent: Select this option to give users more control over which cookie categories they can choose to accept. The choices that website users can choose from when this option is selected are:
  • Marketing: Toggle the switch OFF to reject marketing cookies, or ON to accept marketing cookies.
  • Statistics
    : Toggle the switch

For more information, visit GDPR and CCPA.

Both GDPR & CCPA

Select this option for a combination of GDPR and CCPA regulations. See the previous article sections for explanations of the regulations.

Widget design section

• Choose an icon: Click to select the appearance of the cookie icon. The choices are:
  • Chocolate chip cookie
  • Chocolate chip cookie with a bite taken out of it
  • Gingerbread cookie
  • Peanut butter cookie
• Icon shape: Click the drop-down list to select an icon shape. The choices are Circle and Rounded Box.

• Text color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).

  

  Tip! The Acquia Color Contrast Checker is a quick way to test the color combinations on websites and pages.

• Button color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
• Color contrast ratio: This number shows the contrast ratio of the selected colors for the buttons and the button text. The contrast can be Bad (0-3.99) or Good (4 and above). Bad contrast options cannot be saved, to meet accessibility requirements.

1. Save the changes.
2. Copy the script and add it to the website HTML code.

For more information, visit:

• Consent Manager attributes
• How to add the script
• Using Google Tag Manager with Web Governance

Add the script

This section provides instructions on how to add the script to your domains.

1. Create the script. For instructions, visit Add the script.

2. Click Copy Script (icon of two papers) to copy the script that is in the Script section.

   
   Important

   The script is unique for each domain. It will not work to copy/paste from one to another. Websites ending in .com and .eu, for example, are considered different domains and it does not work to copy/paste the script. The script needs to be configured separately for each domain.

3. Paste the script into the HEAD tag in your HTML editor so that it can detect the cookies.

4. Add HTML Attributes.

   HTML attributes must be added to content elements on your website if you only want them to load after the visitor makes their consent choices. For example, if you are using Google Analytics on your website and only want the script to load after a visitor has accepted Statistics cookies, you need to mark up the Google Analytics script with an HTML attribute. 

   For more information and instructions, visit Consent Manager Attributes.

Cookieless tracking

The Statistics feature normally applies a cookie to the visitor's browser. It is possible to remove this, so that the scan can still track the same data from visitors who refuse statistics cookies through the choices they make on the cookie banner.

For more information, visit:

• Cookieless tracking setup
• Add the script

Cookie Acceptance Rate

This page provides an overview of website visitor behavior regarding cookie acceptance on the website.

Select Cookie Acceptance Rate. The Cookie Acceptance Rate page opens and shows an overview of customer behavior towards cookies on the website.

• The Acceptance Rate by Category page shows acceptance rates by cookie categories.
• The Overall Acceptance Rate page shows a percentage of cookies accepted, as well as a graph chart with acceptance rates over time.

Note

The timeline becomes more accurate with time, as the first scan may not have much data to show.

Consent log

This page lists IP addresses that interacted with the cookies on the website, shown in chart format. The log is kept on the Acquia servers for two years.
The column headers are:

• IP Address: The IP address of the computer that browsed the site.

• UUID: The unique ID for the user device that received the cookie.

  Note

  This ID is gone from the user's device when the cookies on that device are deleted by the user. When the UUID is gone, the user can no longer request the record of the cookie consent.

• Location: The country of origin that the user accessed the site from.
• Data Regulation: The applicable regulation, GDPR, CCPA, or both.
• Accepted cookies: The cookie categories that the user accepted.
• Date: The date that the user accepted the cookies.

Cookie overview

The Cookie overview is where the website administrator handles the cookies. This section provides instructions for the website administrator on how to add cookies from the scan, add cookies manually, and categorize cookies.

1. Save the page and then save again.

   A dialog provides the option to edit the cookie settings. Click

   Data Privacy
   to update now, or click I'll do it later to exit without setting it up now.

2. The Data Privacy module opens. If you selected I'll do it later, navigate to the Privacy module with these steps:

• Include cookies: Enter the cookie information manually, or populate with the scan. Manually entered cookies have an icon of a person pointing.
• Automatic cookie scan: Start a manual scan for cookies, or toggle the switch to ON to scan for cookies automatically during the next scheduled scan. The icon spins while a scan is in progress.
• Script setup: To include the cookie overview on the webpage, create the overview. In the HTML editor, paste the script into the HEAD tag.

For more information, visit Add the script.

Note

This is not a required step. If no script is installed, the overview shows up as a pop-up window instead.

Additional resources

For documentation and advanced help files including SDK information for developers, visit:

• How to use Consent Manager
• Data Privacy setup
• Developers instructions

This article also covers the legislation and regulation requirements to help website owners know which compliance level to target.

Consent Manager features:

• Custom and accessible branding
  Design a cookie acceptance banner to meet legislation and regulation requirements. Customize the banner to match the company brand and meet accessibility standards.
• Consent analytics
  Get real-time data about your visitor cookie acceptance trends.
• Consent log
  See a log of visitor consent choices. Visitor consent is properly and anonymously logged and stored, as required by GDPR.

Instructions

This section provides instructions for site admins on how to set up the cookie banner and how to categorize cookies.

1. Navigate to the Domain Overview page.

2. Click Action on the same row as the domain and select Edit Domain from the expanded list of options.

   The system opens the Edit a domain page.

3. Locate the Features section.

4. Click to turn the Consent Manager switch to ON.

   

5. Save. 

   The system closes the Edit Domain page and the Admin settings page reopens.

6. Click Action on the same row as the domain and select Script Setup Guide from the expanded list of options.

   The system opens the Set up your domain page.

7. Click to turn the Add Acquia Web Governance Consent Manager switch ON.

   

8. Click the Open consent manager script settings link.

   The Consent Manager Script Settings page opens.

Cookie banner setup

This section provides information on how to configure the cookie banner.

Consent Manager pop-up setup section

Click on the mini window to select the location for the cookie banner pop-up to appear on the website landing page. The options are:

• Top left
• Top center
• Top right
• Middle left
• Middle right
• Bottom left
• Bottom center
• Bottom right

Consent Manager configuration section

This section provides instructions on how to set up the cookies to comply with CCPA or GDPR standards.

• Privacy regulation: Select the compliance regulation for your geographical location or intended audience.

  Tick to select:

  • CCPA
  • GDPR
  • Both CCPA & GDPR
  Note

  The fields that expand with each selection are not the same. Continue for instructions on each selection.

  For more information, visit GDPR and CCPA.

CCPA setup

California Consumer Privacy Act

• Opt out link: Click in the input field and enter the link to the company opt-out page.

• Link to Privacy Policy: Click in the input field and enter the link to the company Privacy Policy.

  Tip: The link should begin with http:// or https:// and can contain a maximum of 100 characters.

  For more information, visit Cookie and privacy policies.

• Cookie Overview:

  • Manage: Select this option if you choose manage the cookies with the scan.

    

    See Manage Cookies below for instructions on how to add and manage the cookies.

  • Link: Select this option if you have already done the work of categorizing your cookies, and wish to add a link to an external Cookie Overview page.
• Add empty callbacks: Add empty callbacks to the boilerplate (sections of nearly identical code that are reused in many places).
  • Add empty EventListeners: Add event listeners to the boilerplate (detects sections of nearly identical code that are reused in many places).

  • Add web overlay lock: Lock the website behind the banner, so that users cannot interact with the website before they accept cookies.

    Note

    This setting is not advised, as some interpretations of the regulations prohibit this behavior.

  • Consent Manager Language: From the list, select all of the languages that are used on your website. This is the language that the cookie banner shows. The scan detects the page language and displays in the appropriate language.
  • Default Language: Click the drop-down arrow and select a default language that is used for any page in a language that is not supported.

For more information, visit GDPR and CCPA.

GDPR setup

Select this option to access the following fields.

• Per category consent: Select this option to give users more control over which cookie categories they can choose to accept. The choices that website users can choose from when this option is selected are:
  • Marketing: Toggle the switch OFF to reject marketing cookies, or ON to accept marketing cookies.
  • Statistics
    : Toggle the switch OFF to reject Statistics cookies, or ON to accept Statistics cookies.
• Preferences: Toggle the switch OFF to reject Preferences cookies, or ON to accept Preferences cookies.
• Explicit reject option: Select this option to change the text on the banner button from ‘Only Essential Cookies’ to ‘Explicit Reject’.

• Link to Privacy Policy: Click in the input field and enter the link to the relevant privacy policy. The link should begin with HTTP:// or HTTPS:// and can not have more than 100 characters.

  For more information, visit:

  • Cookie and privacy policies
  • General Data Protection Regulation
  Note

  Cookies are dynamic and often change. Update the cookie policy regularly to ensure up-to-date information.

• Cookie Overview: Click Manage Cookies to add cookies manually. The Include Cookies window opens. See the Manage Cookies section below for full instructions on how to add cookies manually. In the cookie list, an icon of a person pointing indicates a manually-added cookie.

  Note

  To use the scan to set up cookies with the script, click Data Privacy (the lock icon) on the top toolbar of the page to navigate to the Data Privacy module.

• Add empty callbacks: Tick to add empty callbacks to the boilerplate (sections of nearly identical code that are reused in many places).
• Add empty EventListeners: Tick to add event listeners to the boilerplate (sections of nearly identical code that are reused in many places).
• Consent Manager Language: Select all of the languages that are used on your website. This is the language that the cookie banner shows. The scan detects the page language and displays in the appropriate language.
• Default Language: Click the drop-down arrow and select a default language that is used for any page in a language that is not supported.

For more information, visit GDPR and CCPA.

Both GDPR & CCPA

Select this option for a combination of GDPR and CCPA regulations. See the previous article sections for explanations of the regulations.

Widget design section

• Choose an icon: Click to select the appearance of the cookie icon. The choices are:
  • Chocolate chip cookie
  • Chocolate chip cookie with a bite taken out of it
  • Gingerbread cookie
  • Peanut butter cookie
• Icon shape: Click the drop-down list to select an icon shape. The choices are Circle and Rounded Box.

• Text color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).

  

  Tip! The Acquia Color Contrast Checker is a quick way to test the color combinations on websites and pages.

• Button color: Click in the input field to select a color with the color picker, or enter the RGB code for the color (usually a color that fits with the website theme).
• Color contrast ratio: This number shows the contrast ratio of the selected colors for the buttons and the button text. The contrast can be Bad (0-3.99) or Good (4 and above). Bad contrast options cannot be saved, to meet accessibility requirements.

1. Save the changes.
2. Copy the script and add it to the website HTML code.

For more information, visit:

• Consent Manager attributes
• How to add the script
• Using Google Tag Manager with Web Governance

Add the script

This section provides instructions on how to add the script to your domains.

1. Create the script. For instructions, visit Add the script.

2. Click Copy Script (icon of two papers) to copy the script that is in the Script section.

   
   Important

   The script is unique for each domain. It will not work to copy/paste from one to another. Websites ending in .com and .eu, for example, are considered different domains and it does not work to copy/paste the script. The script needs to be configured separately for each domain.

3. Paste the script into the HEAD tag in your HTML editor so that it can detect the cookies.

4. Add HTML Attributes.

   HTML attributes must be added to content elements on your website if you only want them to load after the visitor makes their consent choices. For example, if you are using Google Analytics on your website and only want the script to load after a visitor has accepted Statistics cookies, you need to mark up the Google Analytics script with an HTML attribute. 

   For more information and instructions, visit Consent Manager Attributes.

Cookieless tracking

The Statistics feature normally applies a cookie to the visitor's browser. It is possible to remove this, so that the scan can still track the same data from visitors who refuse statistics cookies through the choices they make on the cookie banner.

For more information, visit:

• Cookieless tracking setup
• Add the script

Cookie Acceptance Rate

This page provides an overview of website visitor behavior regarding cookie acceptance on the website.

Select Cookie Acceptance Rate. The Cookie Acceptance Rate page opens and shows an overview of customer behavior towards cookies on the website.

• The Acceptance Rate by Category page shows acceptance rates by cookie categories.
• The Overall Acceptance Rate page shows a percentage of cookies accepted, as well as a graph chart with acceptance rates over time.

Consent log

This page lists IP addresses that interacted with the cookies on the website, shown in chart format. The log is kept on the Acquia servers for two years.
The column headers are:

• IP Address: The IP address of the computer that browsed the site.

• UUID: The unique ID for the user device that received the cookie.

  Note

  This ID is gone from the user's device when the cookies on that device are deleted by the user. When the UUID is gone, the user can no longer request the record of the cookie consent.

• Location: The country of origin that the user accessed the site from.
• Data Regulation: The applicable regulation, GDPR, CCPA, or both.
• Accepted cookies: The cookie categories that the user accepted.
• Date: The date that the user accepted the cookies.

Cookie overview

The Cookie overview is where the website administrator handles the cookies. This section provides instructions for the website administrator on how to add cookies from the scan, add cookies manually, and categorize cookies.

1. Save the page and then save again.

   A dialog provides the option to edit the cookie settings. Click

   Data Privacy
   to update now, or click I'll do it later to exit without setting it up now.

2. The Data Privacy module opens. If you selected I'll do it later, navigate to the Privacy module with these steps:
   • From the main page, click to select the domain. The domain dashboard opens.
   • Click Data Privacy (a lock icon), on the top menu bar.

3. In the Data Privacy module, click Consent Overview and then select Cookie Overview.

   This page is where the website administrator handles the cookies. There are three panes:

• Include cookies: Enter the cookie information manually, or populate with the scan. Manually entered cookies have an icon of a person pointing.
• Automatic cookie scan: Start a manual scan for cookies, or toggle the switch to ON to scan for cookies automatically during the next scheduled scan. The icon spins while a scan is in progress.
• Script setup: To include the cookie overview on the webpage, create the overview. In the HTML editor, paste the script into the HEAD tag.

For more information, visit Add the script.

Additional resources

For documentation and advanced help files including SDK information for developers, visit:

• How to use Consent Manager
• Data Privacy setup
• Developers instructions

• From the main page, click to select the domain. The domain dashboard opens.
• Click Data Privacy (a lock icon), on the top menu bar.