Consent Management - Global Consent Parameters

Consent Management - Global Consent Parameters

by Community Manager ‎04-12-2018 09:50 AM - edited ‎05-02-2018 08:29 AM (1,804 Views)

Consent parameters are the variables used in the code that generates the consent prompt and preferences pop-ups. These parameters can be set at the account level to your profiles to inherit the same configuration. Only users with the Manage Account permission can access this feature.

In this article:

Table of Contents Placeholder

How It Works

The Consent Prompt Manager and the Consent Preferences Manager use parameters to represent translatable text that appears in the prompts. The prompts are generated using CSS, HTML, and JavaScript where these parameters are referenced using the syntax {{parameter_name}}. When the code is generated, each {{parameter}} is replaced by its configured value. These parameters and values can be defined at the account level or in each profile.

Additional languages can also be configured at the account level. This makes it easy to create translations of your parameters at the account level and make them available to all profiles within your account.

Parameters are set separately for the Explicit Consent Prompt Manager and the Consent Preferences Manager.

Managing Global Consent Resources

The global consent resources are accessed from the user menu at the top-right of the screen. Only users with the Manage Account permission have access to this feature.

To access the global consent resources click Consent Resources from the menu. The global consent resources window appears. From here select the tab for the feature you want to manage.

Setting Parameter Values

The consent features use the following built-in parameters:

  • Title  {{title}} 
    The main heading of the prompt.
  • Message  {{message}} 
    Your message to customers to inform them about your tracking intentions and links to other resources such as a privacy policy or contact form.
  • Opt-in/Opt-out  {{opt_in}} / {{opt_out}}
    The two options available: opt-in - grant consent, opt-out - deny consent.
  • Confirmation Button  {{confirmation_button}} 
    The label on the submission button.

Enter a value for any of these parameters and click Apply.

Adding Custom Parameters

Custom parameters can be added to further customize your prompts. These parameters can be referenced within the built-in parameters or within the CSS/HTML/JavaScript code.

Best Practice Avoid putting translatable text directly in the HTML or JavaScript. Instead, customize the code with {{parameters}} and define that content using custom parameters.

To add a custom parameter:

  1. Click +Add Parameter. The Custom Parameter dialog appears.
  2. Enter a name for the parameter.
  3. Click Apply. The new custom parameter will appear in the list.
  4. Enter a value for the new parameter. This value will be substituted whereever the parameter is referenced.
  5. Click Finish.

Adding a Language

The consent features are built with automatic language detection. They detect the language setting in the browser (two-character language code e.g. "de" for German) and present the corresponding version of the prompt (if that language has been configured). The prompts are configured in English ("en") as the default.

To add a language:

  1. In the Language side panel, click +Add. The Add Language dialog appears.
  2. Select the desired language and click Apply. The new language will appear in the Language side panel.
  3. Click the new language to configure its content.
  4. Enter the translated values in the parameter fields.
  5. Click Finish.

Save/Publish Workflow

The global consent parameters are saved at the account level, so a save/publish is not needed to save your changes. However, in order for those changes to be reflected at the profile level, a save/publish is needed in the profile.

This is the workflow for updating and publishing global consent parameters:

  1. In any profile, open the Global Consent Resources from the user menu.
  2. Make changes to the parameters and click Apply. It is not necessary to do a save/publish.
  3. Switch to the profile that you want to update.
    When the profile loads, the latest global consent parameters will be imported and the Save/Publish button will turn orange indicating that unsaved changes are present.
  4. To preview the latest global changes, go to the Consent Management screen and click Preview.
    Verify the updates and close the preview.
  5. Click Save/Publish and follow your normal release process for publishing to Dev/QA/Prod.

Steps 3-5 must be performed for each profile that  inherits the global consent parameters.