Ensighten FAQs

The Ensighten Swift library in combination with the Ensighten Mobile Platform and Ensighten Mange can be used to track when your users open your app through a deep link or universal link. In addition you can further extract data from these links in order to track information like marketing ids, user information, or any other data passed through the URL.

App Setup

In order to begin tracking deep links, you must first add support for these features in your app. You can follow this guide from Apple to enable Universal Links. And use this guide to enable Deep Links. Once you have set these up and implemented the methods in your AppDelegate, Ensighten will automatically hook into these methods and add lifecycle tracking events when these methods are called. No additional setup is needed in the app. All data about the url being opened will be passed to Ensighten Swift where any custom event code will be run and passed to the tag, which we will cover in the next section.

Ensighten Mobile Setup

Login to manage.ensighten.com and navigate to the Mobile product using the switcher in the top left.

Once inside the mobile product, click on your app.

Next click "Add Event"

On the next page select "Lifecycle Event" then select "Deep Link Opened".

Press "Next" on the next step.

Then press "Save & Commit"

On the App Overview page publish your new event

Manage Setup

Switch back to Manage and go to "Tags" on the left

Select "Add Tag"

Select a "Custom JavaScript" tag

Inside the code editor insert this code:

new Image().src = "https://nexus.ensighten.com/debug/message.gif?deeplinkURL=" + Bootstrapper.getMobileToken("URL");

This is simply a debug function to display the captured URL when listening to your app through a proxy such as Charles. In this section you can take the URL and pull out any values you need and process them as necessary.

In step 2 under "Tag Space" select the space you used to set up your mobile app.

Select the events filter and find the deep link event you created in mobile.

Save, commit, and publish your tag.

This tag will now fire when your deep link event fires. You can now use this workflow to track how your users open your app from deep and universal links.

Welcome to Ensighten Manage!

Log In

When you receive a welcome email, you have 24 hours to use the link activate your Manage account. Should the link expire, navigate to the Ensighten log in page and:

Click the Forgot Your Password? link.

Type your account name.

Type your user name.

ClickReset Password to receive a new email with an updated activation link.

For more information about logging in and passwords:

See the Manage FAQ article How Do I Reset My Password.

For help creating a password, see the article Choosing your Password.

Learn the Basics

Once logged in to Manage, navigate to online help (click account name and choose Help) andget started using the platform.

Ensighten Support Coverage

New administrative users can get a clear picture of Ensighten permissions, system security, and more in the Admin section.

See also:

Click New to Ensighten at the top of the left-side menu bar for a list of links to learn how to use Ensighten products, security features, and, reporting.

See release notes for information about changes and updated features.

Manage -> Essentials -> The Technology: Learn about the key technology behind Manage.

Manage -> Essentials -> The Platform: Learn the common functions that will help you become successful using the Manage platform.

Tags:Learn how to select and customize your first tag.

Conditions: Understand the power of conditions and thenwalk through creating one.

Return toonline help oftenfor the latest release notes, workflow updates, and user tips.

Next Steps

After you've mastered the basics, come back here to the Support Portal. Interact with the knowledgebase to find answers to frequently asked questions, use cases, sample code, find best practices, and known issues. As you excel in your journey through Ensighten products, share your successes or join a conversation in the Community.

Visitthe online video training section of the Ensighten website and explore advanced topics at your own pace:

SiteCatalyst Implementation via Manage covers implementation through QA and troubleshooting.

Inform Training helps you set up automated tests to monitor the quality of your tag implementations.

SUPPORT

If you have EnsightenPremium Support, contact your designated support representative for assistance.

We strongly recommend that you carefully test and QA all of you projects, tag deployments andconditions well in advance of holidays and weekends.

Standard Support:

If you have a question that is not time sensitive, send an email to Ensighten Support ([email protected]). This opens a case with our global support team. Be sure to provide as much informationas possible, and, to get your case assignedfastest, let us know if your issue is:

AGeneral Inquiry, such as, where is the...".

About the Platform, such as,"how do I...".

An Implementation, such as, "why did my...".

Create a Support Request using the online form on the Support Portal.

Call Ensighten Support at +1 630 790 7099.

Onweekends, holidays, andafter hoursEnsightenSupport gives priority to online requests that impact business revenue or instances where Managebecomes unusable, you must be able to reproduce the steps that caused the problem. See the Support Severity Guideline s article andfor details.

Retrieve the value of a specified consent cookie.

PARAMETERS

@param1 {string}-The name of the Privacy Consent Category specified in the Privacy UI

EXAMPLES

Bootstrapper.gateway.getCookie('Marketing');

OUTPUTS

"0": Visitor is opted-out of specific category.

"1": Visitor is opted-in to specific category.

"": Visitor has not saved any opt-in/out preferences.

The callback function will be called with a consents object as the parameter. The callback is called only after consent is obtained from the UI or existing cookies.

PARAMETERS

@param1 {string}- Command to run in the IAB Consent Framework API

@param2 {array}- List of consent IDs to gather data for. Set as an null for all IDs.

@param2 {function}- Callback function once the data is returned. Note that the callback function only happens after *explicit* consent has been given (a user has clicked Save on the cookie modal).

EXAMPLES

__cmp('getConsentData', null, function(result) { console.log(result);});

The vendorIds array contains the vendor ids (as identified in the Global Vendor List) for which consent is being requested. If vendorIds is null or empty, the operation will return consent status for all vendors in the vendor list. The callback function will be called with a VendorConsents object as the parameter. If vendorIds is provided and not empty, then VendorConsents.vendorConsents will only included IDs from vendorIds. The callback is called only after consent is obtained from the UI or existing cookies.

The consent will be returned false ("No Consent") for any invalid vendorId. The boolean success parameter passed to the callback indicates whether the call to getVendorConsents() was successful.

PARAMETERS

@param1 {string}- Command to run in the IAB Consent Framework API

@param2 {array}- List of IDs to gather data for. Set as an empty array for all IDs.

@param2 {function}- Callback function once the data is returned. Note that the callback function only happens after *explicit* consent has been given (a user has clicked Save on the cookie modal).

EXAMPLES

_cmp('getVendorConsents', [], function (obj, success) { console.log(obj);})

The IAB Transparency and Consent Framework utilises the API directly from the IAB which can be found here - https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/CMP%20JS%20API%20v1.1%20Final.md.

Every consent manager MUST provide the following API:

__cmp(Command, Parameter, Callback)

In addition, an event handler will handle postMessage events with a __cmpCall key in the event data (see below), for calling the CMP from iframes.

The gateway configuration object can be modified prior to initialization by adding a custom function. This will allow customizations and enable advanced features that are not configurable in the standard UI.

EXAMPLES

Disable the Privacy XHR Support (Allow all XHR requests)

Bootstrapper.privacy ={};Bootstrapper.privacy.onBeforeInit = function(config) { config.featureToggles.disableXHRManager = true;};

Add a whitelist override to an environment

Bootstrapper.privacy ={};Bootstrapper.privacy.onBeforeInit =function(config) { config.environmentConfigs[0].whitelist = { 'default': [{ 'tag':'localhost' }, { 'tag':'whitelist.com' }, { 'tag':'maps.googleapis.com' }, { 'tag':'google.com' }, { 'tag':'gstatic.com' }, { 'tag':'0.0.0.0' }], 'Performance': [{ 'tag':'vimeo.com"', 'displayName':'Vimeo', 'purpose': ['marketing','performance']}, { 'tag':'vimeocdn.com', 'displayName':'Vimeo CDN', 'purpose': ['marketing','performance'] }], 'Analytics': [{ 'tag':'ens.gw.anametrix.com', 'displayName':'Anametrix', 'purpose': ['marketing','performance']}], 'Social': [{'tag':'twitter.com','displayName':'Twitter','purpose': ['marketing','performance']}] };};

Generates the IAB TCF query string parameters that can be added to beacons so that a previous proof of consent is relayed to the vendor.

Services that are called using a URL from the user's browser, like cookie staplers, user id associators, and tracking pixels (called the 'callee') should be passed the following parameters. The creator of the URL should ensure these parameters are added only once, and are passed to services which are expecting them and can handle them properly.

PARAMETERS

@param1 {boolean}- true ifGDPR applies

@param2 {boolean}- true if contains personal data

EXAMPLE

Bootstrapper.gateway.generateTCFUrlQueryParams(true, false);

EXAMPLE OUTPUT

gdpr=1&gdpr_consent=BOjk2B0Ojk2GqAAAAAAACbAAAAAo2AAA&gdpr_pd=0

PARAMETERS CLARIFICATIONS

Parameter Name

Value

Description

gdpr

0 / 1

0=GDPR does not apply 1=GDPR applies. If not present, website owner should do a geo IP lookup to determine if website visitor is in a GDPR country (within the EU).

gdpr_consent

URL-safe base64-encoded GDPR consent string. Only meaningful if gdpr=1

Encodes the purposes and vendor consent string based on the website visitor's opt-in/out preferences.

gdpr_pd

0 / 1 (optional, default: 1)

for generic URL parameters, gdpr_pd=0 indicates none of them contain personal data (from the perspective of the callee). For "defined" URL parameters, their definition should define whether they include personal data.

Manually block a specific tag URL irrespective of any cookie consent. This can also be used to undo a previous allowed tag.

EXAMPLES

Bootstrapper.gateway.blockTag({ "displayName": "Google Maps", "tag":"maps.googleapis.com"});

Bootstrapper.gateway.blockTag({ "displayName": "Google Analytics", "tag":"(.*google-analytics\\.com.*$|.*doubleclick\\.net.*)"});

Manually allows a specific tag URL irrespective of any cookie consent. This can also be used to undo a previous blocked tag.

EXAMPLES

Bootstrapper.gateway.allowTag({ "displayName": "Google Maps", "tag":"maps.googleapis.com"});

Bootstrapper.gateway.allowTag({ "displayName": "Google Analytics", "tag":"(.*google-analytics\\.com.*$|.*doubleclick\\.net.*)"});

Retrieve the list of allowed or blocked domains based on whether a user is opted in or out of specific Privacy categories.

EXAMPLES

Bootstrapper.gateway.getList();

Manually updates the visitor's Privacy preferences- this is only really needed if modifying cookie values through the JavaScript API and you wish the changes to take effect immediately rather than on the next page load.

EXAMPLES

Bootstrapper.gateway.updatePreferences();

Retrieve the available Privacy opt-in/out categories.

This will return an array of the available Privacy categories for your configuration.

EXAMPLES

Bootstrapper.gateway.getCookieTypes();

Set the domain that Privacy sets cookies on.

PARAMETERS

@param1 {string}- A string containing the domain to set the cookies related to Privacy on. By default, Privacy sets this as TLD+1 - top level root domain (e.g. "mydomain.com", "mydomain.co.uk", etc.)

EXAMPLES

Bootstrapper.gateway.setCookieDomain('mydomain.com');Bootstrapper.gateway.setCookieDomain('sub.mydomain.com');

Set the opt-in/out values of multiple consent cookies.

PARAMETERS

@param1 {object}- An object containing key-value pairs with the key being the Privacy category and the value being the opt-in/out value.

EXAMPLES

Bootstrapper.gateway.setCookies({ 'Marketing': '1', 'Analytics': '0', ...});

Set the opt-in/out value of a specified consent cookie.

PARAMETERS

@param1 {string}-The name of the Privacy Consent Category specified in the Privacy UI

@param2 {string}- "1" if a user should be opted-in to the category, "0" if the user should be opted out.

EXAMPLES

Bootstrapper.gateway.setCookie('Marketing', '1');

Override the register environment function with a new custom function.

PARAMETERS

@param1 {function}-A function that executes upon registering the Privacy environment

EXAMPLES

Bootstrapper.gateway.registerEnvironmentChangeCallback(function() { alert('Your Privacy Environment has changed!');});

Retrieve all available Privacy locales.

Bootstrapper.gateway.getAvailableLocales();

Retrieve the active Privacy locale.

Bootstrapper.gateway.getActiveLocale();

Retrieves the active Privacy environment.

Bootstrapper.gateway.getActiveEnvironment();

EXAMPLE OUTPUT

{ "name": "US", "purposes": { "marketing": "x-Marketing", "analytics": "x-Analytics", "social": "x-Social", "advertising": "x-Advertising", "performance": "x-Performance", "personalization": "x-Personalization" } . . .}

Check if a specific Privacy environment exists.

PARAMETERS

@param1 {string}-A string value containing the environment locale

Bootstrapper.gateway.environmentExists('en_us');

Get the current Privacy environment details

Bootstrapper.gateway.environment

Override the open modal function with a new custom function.

PARAMETERS

@param1 {function}-A function that executes upon opening the Privacy Consent Modal

EXAMPLES

Bootstrapper.gateway.setOpenModal(function() { alert('Privacy Modal Opened');});

Opens the Privacy consent options modal.

Bootstrapper.gateway.openModal();

Closes the Privacy notification banner.

Bootstrapper.gateway.closeBanner();

Opens the Privacy notification banner.

Bootstrapper.gateway.openBanner();

Customer Success Portal and the Ensighten Learning Community (ELC) areresources for you to access technical documentation, create, review, and update your support tickets, and engage with the Ensighten community.

FORUMS

The Ensighten Customer Success team has created resources with the answers tosome of your most common questions as well as somemore advanced topics. We add new contentall thetime, and encourage you to keep submitting requests and suggestions. Sign in toaccess the latest content in the Ensighten Learning Community forum.

COMMUNITY SUPPORT

At Agility this year we listened toyour need for best practices and understoodyour need to learn how other customers are advancing their businesses with Ensighten. Now, you can get answers from Ensighten customers and partners from across the globe.

SUPPORT

Ifyou use email to work with ourTechnical Support team, now you can update and check the status of your requests, as well as look up other requests across your organization. To access all of our available resources, please send a request to [email protected].

FEATURE REQUESTS

Contact our Product Management team directly by submitting your feature requests online. You can also see requests made by other customers and either vote or comment on the ones mostimportant to you.

Your feedback is important to us and we encourage you to comment on this or any other article to communicatewith Ensighten staff.

Thanks!

Don't wait, register now!

If you are viewing any of our videos and want to improve their playback performance, please follow these best practices:

Videos require the Adobe Flash Player (at least version 9). Get the latest Adobe Flash Player.

Videos play on any browser that supports either Adobe Flash or HTML5.

Internet connection speed should be at least 5 megabits per second.

If you are experiencing slow response:

Clear browser cache

Make sure your web browser and Flash player are up to date.

While you are watching the video, right-click in the video and choose either Switch to HTML5 or Switch to Flash in the dialog box. The video will restart.

Participate in customer community forums and have access to loads of Ensighten best practices and training material, please register to our Customer Success Support site.

It's easy to register! Follow the simple steps below:

Register to Ensighten CS Support

1. Click on Sign-in.

How to Reach Ensighten Support

2. Click on Sign up.

3. Using your corporate email, fill out the form and click Sign up.

Follow-up Read:

Ensighten Support can help you get the most from your Ensighten experience. This article explains how to submit a request for support. When creating a support request, make sure to give us as much information as you can so we can provide answers as quickly as possible. Tell us about:

How can we help you, for example, do you need help using platform features or do you have a general question about the platform, other Ensighten products, or about the support portal.

How is the issue affecting your business, for example, tell us:

Is your live website affected?

Has the platform stopped responding?

Has a feature stopped working as expected?

Do you have a suggestion for a new feature?

When describing an issue, include the symptoms you observed, and the steps you took before you observed the problem. Include urgency and the product you are using such as Manage, Inform, Mobile, and so on.

Include screen shots or use a screen recorder such as Screencast to record onscreen activities and the error or unexpected result.

For product resolution timelines, see the Severity Guidelines article.

For support coverage, see the Support Coverage article.

Create an Online Request

Log in to the portal or register for an account to access the form and expedite your request.

Use the online form to create a support ticket:

Email: type your complete business email address, that is, the email address associated with your Ensighten account.

Subject: type a brief description, give us an idea about the issue. Example: "My tag isn't firing" or "general question about conditions".

Description: tell us as much as you can about the issue, include the symptoms you observed, and the steps you took before observing the problem. Our teamdepends on this information to help you resolve therequest quickly.

Product: choose the product you are using such as Manage, Inform, etc.

Support Type: tell us the priority of your question, choose normal for general questions and urgent if the platform stops responding.

Attachments: provide screen shots showing error messages or unexpected results. You can either click Add File and search for the file or drag and drop the file into the form.

Send an Email Request

To contact Ensighten Customer Support by email, send a request to Support at the email address: [email protected]. This opens a case with our Support team.

Call Ensighten Support

If you cannot access to the website or email, contact Ensighten Customer Support by telephone at +1 630 790 7099 during US non-business hours.

Ensighten non-business hours:Weekdays 7pm PST 7am PST and Weekends.

Ensighten Support canhelp you with any questions that mightcome up with your Ensighten experience.

For the surest way to reach us, review the HOW TO REACH ENSIGHTEN SUPPORT articleandbecome familiar with the SUPPORT REQUEST BEST PRACTICES.

Severity Guidelines

Use the following guidelines to help identify the severity level and their resolution timelines when you are submitting your request.

Severity

Priority

Guidelines

Target Response Time

SEV 1

Urgent

Live website is down

Application UI freezing or not responding

Critical website functionality notworking

Revenue is impacted

Above normal global response time

Assist Immediately within 1 - 2 hours.

SEV 2

High

Major site functionalitynot working,including interface problems

Tags not firing or unexpected behavior

Templates not loading

Locations not saving or loading

Rules not loading

Alertsnot working

Unable to sync

UI interrupting workflow

Assist Immediately within 2 - 4 customer business hours

SEV 3

Normal

Feature bug

Single user unable to use Manage

Login requests

Bootstrap creation

Implementation QA

Reporting not working as expected

UI slow

Rules not loading in a non-production site

Assist within 1customer business day.

SEV 4

Low

Feature request

questions

Training/user education using JavaScript

Assist within 1 customer business day.

Ensighten Customer Success Support canhelp you withmatters that come up with your Ensighten experience.

Standard Support

Ensighten Support provides 24/7 global support for Severity One (SEV 1) cases.*

We strive to answer all your support requests within your business hours (8am - 6pm).

For criticalseverity issues follow the instructions in the How to Reach Ensighten Support article and review and become familiar with the Reaching Support Best Practices for contactingus.

After Hours, Weekend, and Holiday Coverage

During the weekend, on holidays or after hours EnsightenSupport gives priority to online requests that cite business impacts such as revenue loss or the Ensighten product becoming unusable and include specific, reproducible steps.

We strongly recommend that you carefully test and QA new and modified projects, tag deployments or conditions before holidays and weekends.

Region Observing

Holiday

Date

ALL

New Years Day

Tuesday, January 1st 2019

APAC

[AU] Australia Day

Monday, January 28th 2019

AMERICAS

[US] President's Day

Monday, February 18th 2019

EMEA

[UK] Good Friday

Friday, April 19th 2019

EMEA & APAC

[AU | UK] Easter Monday

Monday, April 22nd 2019

APAC

[AU] Anzac Day

Thursday, April 25th 2019

EMEA

[UK] Early Bank Holiday

Monday, May 6th 2019

AMERICAS & EMEA

[US] Memorial Day[UK] Spring Bank Holiday

Monday, May 27th 2019

AMERICAS

[US] US Independence Day

Thursday, July 4th 2019

EMEA

[UK] Summer Bank Holiday

Monday, August 26th 2019

AMERICAS

[US] Labor Day

Monday, September 2nd 2019

AMERICAS

[US] Thanksgiving Day

Thursday, November 28th 2019

AMERICAS

[US] The Day After Thanksgiving Day

Friday, November 29th 2019

ALL

Christmas Day

Wednesday, December 25th 2019

APAC & EMEA

[AU | UK] Boxing Day

Thursday, December 26th 2019

ALL

New Years Day

Wednesday, January 1st 2020