Content Templates

How to create the content to display in Capture Points

Overview

A DataGuard Content Template is a simple way to bundle together the key elements of permission transactions and preference submissions. A templateId is required in order to allow customers to manage their permissions using our Collection Points.

Creating a Capture Template

To create a new Template, navigate to the 'Content Templates' section of the Admin UI. This screen will display all of your organisation's Templates, split into 2 tabs; Active and Archived.

Click the '+ Create a new content template' button. A template must contain a Privacy Policy, a name & reference (see the 'Document Management' section here).

Each template must contain at least one valid block from the below options:

The UI is set up with drag & drop components so you are able to arrange the blocks in any order you wish, and can be used to arrange elements within each block (e.g. to set the order of the permission options).

Statement Block (Permissions)

Permission Statement

In order to add Permission Options, you must first add the Permissions Statement that they relate to. This must be done using a statement link (see the 'Document Management' section here).

Permission Options

You can now add the Options that relate to the Permission Statement. Each option must be given a label, which is what will be displayed to the customer if viewing via a Capture Point, the other fields shown below are optional.

Option Description (optional)

This description will be shown to customers in the Capture Point, and is used to provide more clarity on what they are agreeing to (example below).

Value Cards (optional)

These statements will be shown to customers in the Capture Point if they toggle on/off individual permissions. The intention is to use this dynamic display to draw attention to the value lost by saying no to allow customers to understand the consequence of their choice. Using the all/none toggles will not display this text to avoid teh capture point become cluttered unnecessarily.

See below for how this looks in a capture point with default DataGuard styling applied:

Preference Block

Clicking '+Add preference' will give you the ability to either select from any preference sets that have already been created using the Preferences Configuration Management UI, or to create a new one.

The steps for creating preferences are the same as in the Preferences UI.

Text Block

You can add HTML text blocks to your templates. These text blocks can be used to improve Capture Point layout and convey additional information to your customers.

By default, the text blocks offer some basic formatting options, however they also accept HTML tags, allowing you to easily alter their layout and styling.

These text blocks are protected against any possible outside manipulation (e.g. the execution of scripts). As a result, images aren't currently supported.

The UI has a WYSIWYG input to assist creating the correct content without needing to use the API.

Token link to another Capture Point

You can add a link into your text block to point the customer to another Capture Point (e.g. from a granular unsubscribe flow with a single option displayed to a 'My Account' page to manage all). To do this ensure the URL in the link has the token variable included in the query string in this format: token=${token}.

Editing Templates

To manage existing Templates, simply navigate to the 'Content Templates' section of the Admin UI and select the Template you wish to update. You can change every aspect of a Template from this screen.

To Archive or Unarchive existing Templates, adjust the Archived/Active toggle within the Template view screen. Remember to click the 'Save Template' button to save any changes.

❗️

Changes Could Break Your Capture Point

Changes made to existing templates can and will affect existing Capture Points which reference them. Please ensure that you are confident with any changes before saving.