Connecting CMP Preferences with Universal Consent & Preference Management Profiles

You can save CMP preferences of known users on a data subject profile in the Universal Consent & Preference Management (UCPM) module, such as consent to targeting cookies. This functionality allows you to seamlessly connect CMP user preferences with their broader set of UCPM preferences, centralizing all of them in one single profile.

Additionally, you can now trigger integration workflows to send these preferences to downstream systems, keep a main record for each user profile, and manage their preferences through a single unified Preference Center, streamlining the user experience.

Note:

Cross-Domain and Cross-Device Consent must be set up to reflect CMP preference changes on your websites and applications. For more information, see Cross-Domain and Cross-Device Consent and Setting Up Cross Device Consent Using the Cross Device Consent API.

For more information on Managing Known Users, see Unified Profile in the Developer Portal.

How it Works

Step 1: Select the identifier

  1. On the Universal Consent & Preference Management menu, select Setup > Data Elements.

  2. Select your user identifier from the Data Elements screen. If it does not exist yet, you can create and customize a new data element clicking the Add New button. The Create Data Element modal appears.

    Note:

    Ensure that the Can be used as an identifier check box is selected. For more information, see: Managing Data Elements.

Step 2: Configure CMP settings

  1. On the Cookie Consent menu, select Setup > Geolocation Rules. The Geolocation Rule Groups screen appears.

  2. Click the link in the Geolocation Rule Group column for a Geolocation Rule Group. The Geolocation Rule Group Details screen appears.

  3. Navigate to the Geolocation Rules tab. The settings for the Geolocation Rule Group appear.

  4. Click the Edit button.

  5. Enable the Capture Records of Consent setting.

  6. Enable the Create data subject profiles for known users setting.

    Note:

    Verify that your Universal Consent & Preference Management license has enough capacity to store the new data subjects that are going to be created.

    Note:

    If the Trigger integration events setting is enabled, consent receipts will trigger Data Subject Profile Updated events. Make sure that your existing workflows are able to manage additional traffic before enabling it. For more information, see Consent Integration Events.

    If you are triggering integration workflows when connecting CPM preferences with UCPM profiles, ensure that suitable trigger filters are configured to mitigate unintended CMP preferences updates. If filters are not applied, this may result in undesired downstream data propagation

  7. Click the Save button.



Once you have enabled this setting and published the script for your domain, you can proceed with your website or mobile app configuration.

Note:

In addition to Cookie Consent, the Consent Rate Optimization feature must be enabled in order to configure Cross-Domain and Cross-Device consent. Contact your OneTrust account representative if you require the Consent Rate Optimization feature or click here to learn more.

If Cross-Domain and Cross-Device Consent has not been configured yet, complete the following steps:

  1. On the Cookie Consent menu, select Setup > Consent Groups. The Consent Groups screen appears.

  2. Click the link in the Group Name column for a Consent Group. The Consent Group Details screen appears.

  3. Navigate to the Assignment tab. The current members of the Consent Group will appear.

  4. Click the Add Members button.

  5. Select the Websites and Mobile Apps you want to include in the Consent Group.

  6. Click the Add button.

    Note:

    The Republish Warning modal will appear reminding you to republish the newly added Websites and Mobile apps.

Step 4: Configure settings on Websites and Mobile Apps

Note:

If you are already using Cross-Domain and Cross-Device Consent, minimal adjustments are required.

  1. Authenticate the user

    Identify the user in order to convert it to a known user using your preferred method to gather an identifier, such as an email. You can now communicate the identifier with OneTrust CMP following the On Web or On Mobile procedures below:

  2. Generate a JWT token (optional)

    The JWT token is only required in those cases where you aim to synchronize user preferences across multiple websites and apps.

    For more information about how to generate a JWT token, see Cross-Domain and Cross-Device Consent.

  3. On Web

    For optimal performance, it is advised to pass the identifier and other parameters on page load, prior to executing the OneTrust SDK script.

    If Cross-Domain and Cross-Device Consent has been set up, no script changes are needed. Enter the identifier of the actual user under id and optionally insert the JWT token, if synchronizing user profiles. If you want to override the default identifier set in geolocation rules, you can do so by adding the identifierType value as well.

    JSON 
    <script>
	var OneTrust = {
		dataSubjectParams: {
			id: "[Insert User ID Here]",
      identifierType: "[Insert the identifier name here]",      
			isAnonymous: false,
			token : '[Insert JWT Token Here]'
		}
	};
</script>
    Note:

    This payload can optionally be configured and should only be used to override the default identifier type set in geolocation rules.

  4. On Mobile

    Once the user is known, it is advised to re-initialize the SDK by passing the necessary values in the dataSubjectParams parameter on initialization.

    iOS SDK

    JAVASCRIPT 
    // Swift
let profileSyncParam = OTProfileSyncParams()
profileSyncParam.setSyncProfile("true")
profileSyncParam.setSyncProfileAuth("JWT token")
profileSyncParam.setIdentifier("userId")
profileSyncParam.setIdentifierType("typeOfId")

    Android SDK

    CODE 
    OTProfileSyncParams.OTProfileSyncParamsBuilder.newInstance() 
	.setSyncProfile("true") 
	.setSyncProfileAuth("JWT token") 
	.setIdentifier("userId");
	.setIdentifierType("typeOfId");

OTProfileSyncParams otProfileSyncParams = otProfileSyncParamsBuilder.build();

Setting Up Known Users Configuration Models

Known user configuration models refer to the different ways in which you can personalize and adjust settings within the application. These are the four different types of configuration that you can set up depending on your needs:

Full Authenticated Experience

Note:

Both Universal Consent & Preference Management and Consent Rate Optimization licenses are needed.

In this scenario, users can authenticate themselves on your website or app. Preferences are synchronized at a local level, ensuring that websites and apps will always retrieve the most recent user preferences stored in OneTrust.

A UCPM data subject profile will be maintained, allowing users to log into a UCPM Preference Center and activate their preferences through integration workflows, keeping a main record of the data subject's information.

Synchronize Cross-Domain and Cross-Device without Maintaining a Profile Record

Note:

Only the Consent Rate Optimization license is needed.

In this context, users can proceed with authentication on your website or app. Preferences are synchronized at a local level and the most recent user preferences stored in OneTrust can be retrieved by websites and apps. However, it is not required to have a UCPM profile for the data subject. Activation of their preferences using integration workflows is not necessary either.

Maintain a User Profile without Synchronizing across Domains and Services

Note:

Only the Universal Consent & Preference Management license is needed.

In this configuration, users have the opportunity to authenticate on your website or app. Locally managed preferences are saved into the UCPM profiles database and these can be potentially propagated to other systems using integration workflows.

Synchronizing preferences across websites and apps is not the purpose in this case. Therefore, websites and apps will not retrieve the latest user preferences from OneTrust. Preferences will only be modified locally, on each website and app.

Unknown Audience

In the last configuration model, the user identity remains unknown during their session on your website or app. Preferences are exclusively managed at a local level, stored on the user's device. This represents the default behavior of OneTrust CMPwhen the current user is unknown and has not undergone authentication.

Consent Strings

Consent strings are standardized carriers of consent information, such as the TC String and the GPP String. These encoded strings provide valuable data that you can send to third-party systems and vendors via API or triggering integration workflows, instead of using standard purposes. When using an IAB TCF template or Global Privacy Platform (GPP) in the Cookie Consent module, consent strings are automatically stored in consent receipts. If Unified Consent Profile for Known Users is enabled, consent strings will also be saved on the data subject profile.

Note:

For more information, see Configuring the Global Privacy Platform Settings and IAB TCF 2.2: Detailed Overview and FAQ.

  1. On the Universal Consent & Preference Management menu, select Data Subjects > Profiles. The Data Subjects screen appears.

  2. Click the link in the Data Subject column to view and manage details for the selected data subject. The Profile tab on the Data Subject Details screen appears.

  3. Click the Purposes tab to view the consent stored for the data subject against the defined Purposes of processing.

    Note:

    For more information, see Managing Data Subjects.

  4. In the Consent Strings section, click the View button for the consent string you want to view. The GPP String modal appears.

  5. Copy the consent string and paste into an online decoder to read its content.

  6. Click the Close button.

Data Subject Details Screen Reference



GPP String Modal Reference



Note:

Only the latest string of each type will be stored on the Purposes tab of the Data Subject Details screen.

  1. On the Universal Consent & Preference Management menu, select Data Subjects > Receipts. The Receipts tab on the Receipts screen appears.

  2. Click the link in the Receipt column for the consent receipt you want to view. The Receipt Details screen appears.

    Note:

    For more information, see Viewing Consent Receipts & Transactions.

  3. In the General Information section, click the Copy button under the Consent String field.

  4. Paste the consent string into an online decoder to read its content.

Receipt Details Screen Reference