PUSH Information

Use the following APIs and functions client-side (frontend JavaScript, as executed in a website visitors browser) to set or push information to the JENTIS Consent Engine. You can activate, change or apply consent status to any tool based on your websites requirements and services.

All of the following functions are in context of jentis.consent.engine, ie. you must call "jentis.consent.engine.setNewVendorConsents()" accordingly.

setNewVendorConsents

Use this function to set the current consent status.

This requires knowledge of the vendor identifiers as of the configuration of the according JENTIS Tag Manager container. For example if you intend to use “Google Analytics” with JENTIS and it is connected to the according vendor (with the ID “google_analytics”) this key must be used case sensitive. You will find all those vendor IDs when logged in to your JENTIS Data Capture Platform in the main navigation: Legal Hub: Vendors and when selecting an individual tools vendor.

Parameter (Input)

Object with the vendor-id as key and one of the following values:
- true (Bool or String): if the consent was granted to this vendor.
- false (Bool or String): if the consent was denied.
- ncm (String): activate the Essential Mode (JENTIS Essential Mode ) fallback for the given vendor.
to identify the correct id key you must navigate to your JENTIS account and open the “Legal Hub: Vendors” settings. There you can select a vendor and retrieve the ID of this vendor.

JS

{
  "ga"       : true,
  "facebook" : false,
  "hotjar"   : true
}

Returns

(String) The ConsentId that was used to store the new consent status or false, if something went wrong.

Example

JS

var sConsentId = jentis.consent.engine.setNewVendorConsents({
  "ga"  : true,
  "adw" : "false",
  "fb"  : "ncm"
});

setConsentData

Use this function to set custom data that will be stored in the consent documents (JENTIS internal data model). Data is stored with the same settings as all consent informations (consent identifiers) and can be later retrieved from the JENTIS system for consent related purposes (export).

Input Parameter

Object of key-value pairs with any relevant data.

Return

void

Example

JS

jentis.consent.engine.setConsentData(
{
   key1: "value1",
   key2: "value2"
});

AcceptAll

Use this function to set a positive consent to all vendors.

Parameter

none

Return

The ConsentId which was used to store the new consent status or false, if something went wrong

Example

JS

var sConsentId = jentis.consent.engine.AcceptAll();

DenyAll

Use this function to deny the consent to all vendors.

Parameter

none

Return

The ConsentId which was used to store the new consent status or false, if something went wrong

Example

JS

var sConsentId = jentis.consent.engine.DenyAll();

DEPRECATED - userShowSettings

This function was dedicated to the JENTIS internal visual Consent Management Platform that was deprecated.

Original description:

You must use this function if the user requests the setting page containing the vendors and consents. You can use this function to open the setting page from your consent bar and you must use it if you want to provide a link for example in your data protection description page or in your footer for the user to evaluate or reset his decisions.

Parameter

none

Return

none

Example

CODE

jentis.consent.engine.userShowSettings();