This documentation portal explains how to ingest, manage, orchestrate, and onboard Ingest Labs on to your website.

The Tag Manager forms the main product in Ingest Labs and comprises the following modules.

Related Topics

Introduction

Add a New Project is the first step in the entire Tag Management process soon after you launch the Ingest Labs application.

Procedure

To add a new Project, perform the following steps:

Step 1: On the dashboard, in the Easily access your products section, locate Tag Manager, and then click Launch.

Step 2: On the Project screen, in the top-right corner, click Add Project.

Step 3: On the New Project screen, in the Name field, enter an appropriate name.

Step 4: In the Description field, enter a relevant description.

• Note: The Name and Description fields are mandatory. If not provided, an error message This value is required. appears below the respective fields.

Step 5: Under Project Type, select an option based on your project:

• Website: Select this option if the project is website-based.

• Mobile App: Select this option if the project is a mobile application.

Step 6: If you select Website, the Demand-Side Platform (DSP) section appears.

Note: By default, Website is selected.

Step 6.1: Check the Enable DSP integration checkbox.

DSP Integration: DSP integration is the process of connecting a Demand-Side Platform (DSP) with other systems to deliver targeted ads efficiently by using customer data, campaign insights, and inventory sources.

Step 6.2: In the Select Provider drop-down, select the appropriate provider.

Note: DSP integration is enabled only if required by the client.

Step 7: If you select Mobile App, the Select Mobile App Platform section appears.

Step 7.1: In the Select Mobile App Platform drop-down, select the appropriate platform:

• Native – Select this option if the app is developed using native programming languages such as Swift (for iOS) or Kotlin/Java (for Android).

• React Native – Select this option if the app is built using React Native, a cross-platform framework that allows you to develop apps for both iOS and Android using JavaScript and React.

• Ionic – Select this option if the app is built using Ionic, a framework that enables the development of hybrid mobile applications using web technologies like HTML, CSS, and JavaScript.

Step 8: Click Create Project.

Result: This creates the project successfully and adds it to the project list.

This section explains the different tabs available on the Ingest Labs UI screen.

Click the User Icon to edit the profile or log out of the application.

Products

The Products section includes the list of products available for a particular Ingest Labs project.

Notification Groups

A Notification Group allows you to add multiple email addresses to receive alerts for alarms and product updates. Notifications are set at the client level, ensuring that only the relevant people receive alerts at the right time.

Info

The Info section displays the information related to the product.

Users

The Users section displays the number of users accessing the Ingest Labs product and the roles allocated for a particular user.

Add a New User

To add a new user, perform the following steps:

1. Click Users.

2. Click Add User on the top-right corner of the screen.

1. Enter the e-mail in the E-mail field.

2. Enter the Full Name in the Full Name field.

3. Enter the Last name in the Last Name field.

Note: Provide email ID, first name and last name to add a user. If any field is left blank, the screen displays a warning.

Step Result: Once you add a user, the user receives an e-mail notification to activate the account.

Note: If the user cannot activate and reset the password, the admin may select the Re-invite User option to trigger the e-mail notification again.

Delete User

You can delete a user using the delete icon to the right of the user.

To delete a user, perform the following steps:

1. Navigate to Users section.

2. Select the user and click the three dots to the right of the user.

3. Click Delete.

4. Click Yes on the confirmatory message.

1. You will receive a success message after the user is deleted.

Clear Cache

Delete the user cache using the clear cache option to the right of the user. User roles are cached for a short duration on the backend server to facilitate Role-Based Access Control (RBAC). When a user's role changes, delete the user's roles and permissions from the cache using the Clear Cache feature. This ensures that the updated roles and permissions take effect immediately.

To clear the cache of a particular user, perform the following steps:

1. Navigate to Users section.

2. Select the user and click the three dots to the right of the user.

1. Click Clear Cache.

Roles

The Roles section displays the multiple roles assigned to the particular user.

Assign the Roles

Following are the steps to assign the roles to the user:

Using Users Section

1. Navigate to the Users section on the top.

2. Select the respective user and click Edit.

3. Select the roles for the user from the drop-down list.

1. Click Save.

Note: You will receive an e-mail notification for any edits or modifications.

Using the Roles Section

1. Navigate to the Roles section on the top.

2. Select the role to edit.

3. Under the List of Users associated with this role, enter the user's e-mail ID.

Delete the Roles

You can delete the roles using the Delete icon at the right-hand corner of the screen.

To delete the roles in the User section, perform the following steps:

1. Navigate to Users section.

2. Select the user and click Edit on the top right corner of the screen.

3. You must clear the roles of a particular user and click Save.

Usage

The Usage option includes the real-time metrics and the data collected based on the number of days. By default, the data for the last seven days appears. However, you can modify the number of days to view the metrics for a particular category.

To view the usage details, select Product -> Project -> Category.

Note: The Projects option is available only in Tag Manager. By default, All Projects is selected under Products tab.

If there is no data available, then the following message appears: “Metrics data is currently unavailable.”

The following are the default user options:

You can view the following details with the usage in each category:

The same categories are listed under the All Categories drop-down for a detailed view of the metrics. For example, to view the Collector API calls from the previous week, click Collector API Calls from the All Categories drop-down and select Last One Week. To view the graphical representation for the last month, select Last One Month and click Refresh.

Notifications

The Notifications option displays the notifications triggered for a particular user. You can add any number of e-mail IDs for a Notification Group. The Notifications are triggered at the client level for alarms and other products.

Note: While creating alarms, you can set a notification group e-mail for each alarm. The two types of alarms that are triggered under Tag Manager are: • Tag Anomaly Detection Alarm • Tag Expiration Alarm

To add a new notification group, perform the following steps:

1. Click Add Notification Group on the top-right corner of the screen.

1. In the Info screen, add the Name in the Name field.

2. Enter the Description.

3. Enter the e-mail ID in the Add New User field under the Destinations section.

1. Click Save.

Step Result: The new notification is added.

Integrations

The Integrations section describes the third-party integrations using the Authorization token. You can set the token expiry to 1 hour, 12 hours, and 72 hours accordingly.

Introduction

A newly created dashboard can be set as the default dashboard.

Procedure

Follow these steps to set a newly created dashboard as your default dashboard:

Step 1: Select Make Default from the newly created dashboard drop-down menu.

A message pops up confirming, This dashboard has been marked as default.

Step 2: To revert the changes, select Remove as Default.

Note: You must be authorized to perform this action.

The Dashboard screen includes the following details:

By default, the Dashboard is set to an hourly session and displays the Default Dashboard. To apply the selected time range and update the dashboard data, click the Refresh button.

Custom Time Range

In the Custom Range section, you can select from the following predefined options in the dropdown menu:

• Today so far – Displays data from the start of the current day up to the present time.

• Last 3 hours – Shows data for the most recent 3-hour window.

• Last 6 hours – Displays data collected over the past 6 hours.

• Last 24 hours – Provides data for the past 24-hour period.

• Last 7 days – Retrieves data from the past 7 days, including the current day.

• Last 1 month – Displays data for the previous month from the current date.

Additionally, you can manually define a start date and end date to filter the dashboard data based on your requirements.

Note: Ingest Labs retains the Dashboard data for a maximum period of 24 months. After 24 months, the data is deleted. To view the Dashboard for a specific custom range, select the time range from the ~ 24 hours ago option and click Refresh.

Click the Refresh button to update the dashboard with the latest data.

Click the dropdown to switch the Dashboard display between the Staging and Production environments.

Introduction

A dashboard can be shared with multiple users, and existing users can also be removed from a shared dashboard as needed.

Procedure

Perform the following steps to share the Dashboard with other users:

Step 1: Select the Share Dashboard option from the newly created dashboard option.

Step 2: Enter the e-mail ID in the Add New User field and click Add User.

Note: A notification is triggered to the users about the dashboard details.

Perform the following steps to stop sharing a Dashboard with a user:

Step 1: Select the Share Dashboard option from the dashboard screen.

Step 2: Click the Delete icon against the user's e-mail ID to delete the user from the shared dashboard.

Step Result: The user details are successfully saved.

Introduction

You can delete the newly created dashboard using this option.

Procedure

To delete the dashboard, perform the following steps:

Step 1: Select Delete Dashboard from the newly created dashboard drop-down menu:

Step 2: A confirmatory dialog box appears with the message: Deleting the dashboard will also delete all widgets in it. Would you like to proceed?

Step 3: Click Yes to confirm the deletion.

Step Result: The Dashboard is deleted successfully along with the added widgets.

Introduction

You can change the Dashboard and revert to the Default dashboard.

Procedure

Step 1: From the Default Dashboard dropdown menu, select the Change Dashboard option.

Step 2: Click the Project's Default Dashboard option on the Dashboard screen.

Step Result: The default dashboard appears on the screen.

Step 3: While viewing the Default Dashboard, you can select and navigate to the specific Dashboard to display.

Introduction

The Report screen provides users with a detailed view of data, allowing them to filter and analyze information based on specific time ranges.

Procedure

Accessing the Reports

• Navigate to the left navigation panel.

• Click on Reports to open the Report screen.

Understanding Report Columns

• Tag Column: Displays the Tag name.

• Tag Fires Column: Shows the number of times the tag is triggered.

Adding a Filter

Click Add Filter.

Select the filter criteria as needed.

Default Time Range

• Reports are generated for a 24-hour period by default.

Filtering Reports by Time Range

• To view reports for a specific time range:

  1. Click the dropdown under Custom Range.

  2. Choose one of the available time ranges:

     • Today so far

     • Last 3 hours

     • Last 6 hours

     • Last 24 hours

     • Last 7 days

     • Last month

  3. The report will be displayed based on the selected time range.

Manually Selecting a Time Range

• You can manually select a start date and end date to filter the report data according to your requirements.

Note: You can also manually enter the date and time.

Refreshing the Report

• Each time you modify the time range selection, click the Refresh button to update the report accordingly.

Selecting the Environment

• Click the Environment dropdown and choose one of the following:

  • Production: Redirects to the Production environment.

  • Staging: Redirects to the Staging environment.

Adjusting Items Displayed per Page

• Click the dropdown to select the number of items displayed per page.

• The available options are:

  • 20 items per page

  • 50 items per page

  • 100 items per page

Note: Ingest Labs retains the metadata information for a period of 6 months at any given point. For customers who have Enterprise contracts with longer data retention needs, Ingest Labs retains and archives the data as agreed in contracts.

Tags are a collection of data elements, providers, qualification criteria, and privacy settings. Tags are used to build simplified data points and analyze and monitor the data in real-time to ease the marketing processes. You can use the code snippet or MediaPixel to configure the data, send data to providers, and simplify the marketing processes. The two types of Tag Management Solutions are Server-side Tagging solution and Browser/Client-side Tagging solution.

Server-side Tagging

In Server-side Tagging, the events are sent to Ingest Labs and based on the events and configuration of tags, the respective tags are triggered. Server-side tagging includes the marketing needs of the server-side ecosystem. You can collect the data in a first-party consented manner for better control over data collection and transfer the high-performance tag management and streaming to the customer. All integrations are performed using MagicPixel UI platform.

Client-side Tagging

In Client-side tagging, events are not sent to the server and all tasks are performed on the client directly. The tags are triggered on the browser or client website and not sent to the server. Ingest Labs collects the tag information and reports triggered through the SDK on the client website. However, the actual tags are triggered on the client.

Related Topics

The Tags section includes the following topics:

Introduction

This section outlines the steps to add a new filter to the Reports screen.

Procedure

Follow the steps below to add and apply a filter:

Step 1: Access the Filter Option

• Navigate to the Reports screen.

• Click Add Filter.

Step 2: Select Field Type

From the Select a Field drop-down menu, choose a field type based on your reporting needs.

Step 3: Choose an Operator

From the Operator drop-down menu, select a suitable operator:

• Is one of - This operator allows you to filter reports that match any of the selected values.

• Is not one of - This operator excludes the selected values from the results.

Step 4: Select applicable field types

• Select all the applicable field types from the drop-down.

The selected fields are displayed here for confirmation.

Step 5: Apply the Filter

Click Add Filter to apply the selected criteria.

Note: To remove the filter, click the small cancel icon next to the filter category.

Step Result

The Reports for the respective field types appear.

Step 6: Modify Column Settings

To customize the visible columns:

• Click the Settings icon on the top-right corner.

• Select the required columns to display.

Step 7: Submit Changes

• Click Submit to apply the column settings.

Final Result: The Reports with the selected columns appear on the screen.

You can add a tag using any of the following options:

• Browser: For the conventional method of tagging using the browser.

• Server: For backward compatibility and support to create new tags on the server.

In Ingest Labs, you can create media tags for client-side and server-side seamlessly and quickly using the following steps. For browser-side tagging creation, the conventional method of tagging is applicable.

The following elements are mandatory to add a new tag:

Introduction

When you select a Project, the default Dashboard opens automatically. However, if you want to create a new Dashboard, follow these steps.

Procedure

Step 1: From the Default Dashboard drop-down menu, click New Dashboard.

Step Result: The New Dashboard screen appears.

Step 2: Enter the Name and Description in the relevant fields.

Note: Ensure that the number of characters in the name field is five or more. Else the following message appears: Name must be longer than or equal to 5 characters.

Step 3: Click Save to save the changes.

Step Result: The new Dashboard is added successfully.

Note: You cannot edit the Default Dashboard as the project is configured with the default settings.

Introduction

This section describes the Tags screen UI elements.

Procedure

Tags (50 of 127) – This option indicates the number of Tags currently displayed out of the total available Tags.

You can adjust the number of Tags displayed per page using the dropdown menu located at the top-right corner of the screen.

• 50 per page: Displays up to 50 Tags on the current page.

• 100 per page: Displays up to 100 Tags on the current page.

• 200 per page: Displays up to 200 Tags on the current page.

Refresh Button

The Refresh button allows you to reload the Tags screen. If you create new Tags or update their properties and the changes are not immediately visible on the main UI screen, clicking the Refresh button will reload the page to display the most up-to-date information.

More Options

When you click on the three-dot menu (⋯), the following options are displayed:

• Clone: This option allows you to create a duplicate of the selected Tag. When you click Clone, a new Tag is created with the same properties as the original, which you can then modify as needed. It's useful for quickly setting up similar Tags without re-entering all the details.

• Delete: This option permanently removes the selected Tag from the system.

Filter Tags

Filter the tags based on the following types:

• Filter By Name: Filters tags based on their names.

• Filter By Attribute Value: Filters tags based on their attribute values.

• Filter By Metadata Attribute: Filters tags based on their metadata attributes.

All Provider Types

• All Provider Types: Displays a list of all available provider types.

• Image Tags: Displays a list of image-based tags.

• JS Tags: Displays a list of JavaScript-based tags.

Tag Status

The Tag Status defines whether a tag is currently active (Enabled) or inactive (Disabled).

Enabled

• The tag is active and available for use.

• Select Enable from the drop-down menu.

• The list of enabled tags is displayed.

Disabled: The tag is inactive and hidden from active use. Instead of deleting a tag when it is not needed, you can disable it and re-enable it later if required.

• Select Disable from the drop-down men.

• The list of disabled tags is displayed.

Filter By Providers

The Filter By Providers option filters the tags based on the providers.

Click Filter by Providers.

The Choose Providers panel opens on the right.

Select a provider from the list or use the search bar to find one.

Note: You can select one or multiple providers.

Click Done.

Step Result: All the tags associated with the Provider Name appear on the screen.

Filter by Qualification Criteria

The Filter by Qualification Criteria option allows you to filter tags based on a predefined qualification criteria list.

Click on Filter by Qualification Criteria.

The Choose Qualification Criteria dialog box appears on the right side of the screen.

Select the applicable qualification criteria from the list.

Alternatively, enter the name of the criteria in the Filter by Name field to search for a specific criterion.

Click Done to apply the filter.

Step Result: Click a tag. Under Qualification Criteria, the selected qualification criteria is displayed.

Filter by Triggers

This option allows you to filter tags based on specific trigger conditions.

Click on Filter by Triggers.

The Choose Triggers panel opens on the right side of the screen.

Select one or multiple triggers from the list, or use the search bar to find specific triggers.

Click Done to apply the filter.

To view the selected trigger(s), click on the tag. the associated triggers will be displayed under the Triggers section.

Filter by Data Elements

The Filter by Data Elements option allows you to filter tags based on predefined Data Elements.

Click on Filter by Data Elements.

The Choose Data Elements dialog box appears.

Select one of the following options:

• Default Data Elements

• User-Defined Data Elements

Enter the name of the Data Element in the 'Filter by Name' field to search for a specific element. You can either type the name or select it from the list.

Click Done to apply the filter.

Step Result: All the tags associated with the Data Elements appear on the screen.

Reset Filters

The Reset Filters option resets the applied filter settings.

The following are the additional fields that appear on the Tags screen

The Dashboard is the visual representation of data as soon as you log in to the Ingest Labs application. The Dashboard showcases a graph of all the information about tags in a singular view. The Dashboard is available for both Staging and Production environments.

Related Topics

The Dashboard section includes the following topics:

Introduction

The dashboard details of the newly created dashboard can be edited.

Procedure

To edit the Dashboard details, perform the following steps:

Step 1: Select Edit Dashboard from the newly created dashboard drop-down menu.

Step 2: Edit the details in the Update Dashboard.

Step 3: Click Save.

Step Result: The dashboard details are updated.

Procedure

Perform the following steps to create widgets in the Dashboard:

Before you begin

Before adding a widget, ensure that a new dashboard is created. Follow the steps in Create a New Dashboard to create a dashboard. Once the dashboard is created, the New Widget option becomes available.

Step 1: Click Add Widgets.

Step 2: The following visualization types are available:

• Line Chart: Displays data trends over time by connecting individual data points with a line.

• Tags Fired Counter: Counts and displays the number of times specific tags have been triggered.

• Pie Chart: Represents data proportions as slices of a circular chart, showing relative sizes.

Select the appropriate chart type.

Step 3: Under the Select Aggregation Attribute section, click the Select Attribute dropdown. The following options will be displayed:

• Browser

• Device Type

• Language

• Tag Fire Status

Step 4: Click Add Filter and select the various criteria to filter information.

Note: This step is optional and can be skipped if no filtering is needed.

Step 5: Click the Operator dropdown.

The following options will be available:

• Is one of: Select this operator to filter data where the field matches any of the values in the specified list.

• Is not one of: Select this operator to filter data where the field does not match any of the values in the specified list.

Step 6: When you select the Operator , a tab opens below. Click the arrow in the tab to select the filter for a specific field type.

Step 7: Click Add Filter to add the filter conditions.

Step 8: Enter the Widget Name and Description under the Widget Info section and click Save.

Step Result: The new widget is added successfully.

The Dashboard screen displays the required filtered information for a default period of 24 hours. You can also specify a time range to display the information for a specific period and click Refresh.

Note: You can perform the same steps as explained in this procedure for the Tags Fired Counter and Pie Chart.

Introduction

Server-side tagging lets you shift tag execution from your website or app to a secure server environment. Instead of loading multiple tags in the browser, data is sent to a server where tags are triggered. This improves site speed, enhances data accuracy, and gives you more control over what data is shared with third parties.

Procedure

To add a new server-side tag, perform the following steps:

Step 1: Select Tags from the left navigation panel.

Step 2: Click the Add Tag dropdown select For server.

Step 3: The Select Provider panel opens on the right side. Select a provider from the list or use the search bar to find and select a provider.

Step Result: The New tag screen appears.

Step: 4: Trigger.

Step 4.1: Click Choose Triggers.

Step 4.2: The Choose Triggers panel opens on the right side. Choose a trigger from the list or use the search bar to find and select a trigger, then click Done.

Note: You can select multiple triggers if needed.

Step Result: The tag is triggered for the respective trigger data.

Step 5: Set Qualification Criteria (Optional).

Step 5.1: Click Qualification Criteria (Optional).

Qualification Criteria of a tag are conditions/triggers that inform Ingest Labs when to trigger a particular tag. You can add multiple Qualification Criteria and these criteria are layered.

Note 1: This step is optional.

Step 5.2: The Choose Qualification Criteria panel opens on the right side. Select an option from the dropdown or use the search bar to find and select a criterion, then click Done.

Note 2: You can select multiple qualification criteria if needed.

Step 6: Set Tag Info

This is the step where you set a name and validity period for the tag. The default validity period is one year for any new tag that is created and can be set to any desired date.

Step 6.1: Name: The Tag name.

Step 6.2: Validity Period: Denotes the validity period of the tag including Start Date and End Date.

Note : If you don't enter the tag name, an error message appears: This value is required.

Set Validity and Tag Expiry

While creating a tag on Ingest Labs, you can set the validity period of a particular tag and define tag expiry. The default validity period is one year for any new tag that is created and can be set to any desired date. When the expiry date is closer, you will receive reminder e-mail notification about the expiry of the tag. If no action is taken, the tag stops triggering post the set validity period. You can find all expired tags in the “Paused State” in the Publish section and you can remove the expired tags to reduce the size of your SDK.

Set Tag Query Parameters

The Query parameters include the set of dynamic values that are included along with the Base URL while executing the query. These parameters appear in the Attributes section as well along with the values.

Step 7: Set Provider Attributes

The Provider is a mandatory setting while adding a new tag. You can add any number of Provider attributes using the Key-Value pair and configure the settings using the Settings option. The user can view the providers attributes added from Provider side configuration.

For a particular Provider attribute, you must set the value either from the Data Elements or Transformers.

After selecting either from the Data Element or Transformer, the value appears in the Value column.

Step 7.1: Add Attributes

To add Attributes, select Add Attributes and set the following values.

Step 7.1.1: Name: Set the Attribute name. For example: visitor_id, user_id, and so on.

Step 7.1.2: Value: Set the value either for the Data Element or Transformer.

Step 7.1.3: JSON: Enter the Attribute name and value, and configure the Settings.

• Mandatory - Denotes the value to be mandatory.

• Ignore If Empty - Ignore the field if empty.

• Hash (SHA256) - denotes the value in the HASH format.

Step 7.1.4: Static: Denotes the static Value that is known.

Step 7.1.5: Attribute Settings:

Enter the Attribute Settings.

Tool-tip! Select the Mandatory check box to display the Fatal check box.

Step 7.1.6: Set the Data Type Conversion using the following options.

Step 7.1.7: Select one the following Transformer types and click Confirm.

Step 7.1.8: Select the Ignore Redaction checkbox to display the data elements. Redaction is a setting for each data element, which allows the server-side processing to apply the redaction strategy - like anonymize for email.

Step Result: The Provider Attribute is created.

Step 7.1.9: To delete the Provider Attribute, select the Delete icon at the right-hand corner of the screen.

Step 7.1.10: Click Save to save the settings.

Step Result: The new tag is created.

Introduction

You can edit the Tag details of a particular tag.

Procedure

To edit the tag, perform the following steps:

Step 1: Select the tag that you want to edit.

Step 2: From the Actions drop-down menu on the top right corner, select Edit.

Step 3: Edit the tag details and click Save on the top-right to save the changes.

Edit Metadata

Step 1: Click Metadata and click edit

Step 2: Add the Key and the value.

Step 3: Click Add to add more keys and values.

Step 4: Click Save to save the Metadata.

Reports displays the details similar to the Dashboard in a list format. You can display reports either for the Staging or Production environment.

While tag details are accessible in the Live Debugging and Dashboard sections, Reports offer critical data for debugging. They provide insights into the tags triggered during a session, including their frequency and associated metrics for data analysis. This information is crucial for diagnosing errors at various levels—whether related to the tag itself, the provider, transformation functions, configuration issues, or missing attributes. Using Reports, users can pinpoint specific problems and missing data that may lead to tag failures.

Related Topics

The Reports section includes the following topics:

Introduction

A deleted tag can be restored with all its settings using the Restore option.

Procedure

To restore a deleted tag, perform the following steps:

Step 1: Select a deleted tag.

Step 2: Click the Actions button drop-down and select Restore.

Step 3: Click Yes in the Restore confirmatory dialog box that appears.

Step Result: The tag is restored successfully.

Introduction

You can enable tag details for a specific tag.

Procedure

To enable a enable tag, perform the following steps:

Step 1: Select the tag that you want to enable from the list of tags.

Note: A disabled tag can be identified by its faded or lighter color. When you hover over it, a tooltip appears indicating that the tag is disabled.

Step 2: Go to Tag Status, click the dropdown, and select Disabled from the list.

It will display a list of disabled tags. Select the tag you want to enable.

Step 3: From the Actions drop-down menu on the top right corner, select Enable.

Step Result: The tag is enabled successfully.

Introduction

You can disable the details of a particular tag.

Procedure

To disable a tag, perform the following steps:

Step 1: Select the tag that you want to disable.

Step 2: From the Actions drop-down menu on the top right corner, select Disable.

Step Result: The tag is disabled successfully.

Introduction

You can add a new tag to capture browser or client-side data. This helps in tracking specific user interactions or behaviors based on browser activity.

Procedure

To add a new Tag for browser/client-side, perform the following steps:

Step 1: Select Tags from the left navigation panel.

Step 2: Click the Add Tag dropdown in the top right, then select For Browser from the list.

Step 3: The Select Provider panel opens on the right side. You can choose a provider from the list or use the search bar to find and select a provider.

After selecting a provider, the Tags screen opens.

Step 4: Select Trigger

Step 4.1: In Triggers, click Choose Trigger.

Step 4.2: The Choose Triggers panel opens with two tabs:

• User-Defined: Displays custom triggers created by users.

• Default: Contains predefined system triggers.

Step 4.3: Select a trigger from the list or use the search bar to find and select a trigger.

Note: Multiple triggers can be selected.

Step 4.4: Click Done.

The selected trigger appears on the Triggers screen.

Note 1: You can remove the selected trigger by clicking the Clear button or click the small cancel icon next to each trigger to remove them individually.

Note 2: If mandatory details are not filled in, the following warning message gets triggered:

Step 5: Qualification Criteria (Optional)

The Qualification Criteria are the conditions/triggers that inform Ingest Labs when to trigger a particular tag. You can add multiple Qualification Criteria, and these criteria are layered.

Step 5.1: Click Qualification Criteria (Optional).

Step 5.2: The Qualification Criteria panel opens on the right side.

Select a qualification criterion from the list or use the search bar to find and select one.

You can select multiple qualification criteria.

Step 5.3: Click Done.

The selected qualification criteria appear on the Qualification Criteria (Optional) screen.

Note: You can click Clear to remove all selected qualification criteria at once, or click the small cancel icon next to each one to remove them individually.

Step 6: Tag Info

You can set the tag name and validity period. The default validity period is one year for any new tag and can be set to any desired date. To understand tag validity or expiry, see the section Set the Validity period and Tag Expiry.

Step 6.1: Name: The Tag name.

Step 6.2: Validity Period: Denotes the Tag Validity period including Start Date and End Date.

Set Validity and Tag Expiry

While creating a tag in Tag Manager, you can set the validity period of a particular tag and define its expiry. The default validity period is one year for any new tag and can be set to any desired date. When the expiry date is close, you will receive a reminder e-mail notification about the tag expiry. If no action is taken, the tag stops triggering post the set validity period.

See ExpirationAlarm for more information.

Step 7: Set Provider Attributes

The Provider is a mandatory setting while adding a new tag. You can add any number of Provider attributes using the Key-Value pair and configure the settings using the Settings option. For a particular Provider attribute, you must set the value either from the Data Elements or Transformers. The user can view the provider attributes added from Provider side configuration.

Step 7.1: If you do not set the mandatory values, the following message appears:

Step 7.2: After selecting either from the Data Element or Transformer, the value appears in the Value column.

Step 8: Set Tag Attributes

To add Attributes, select Add Attributes and set the following values.

Step 8.1: Name: Set the Attribute name. For example: visitor_id, user_id, and so on.

Step 8.2: Value: Set the value either for the Data Element or Transformer.

JSON: Enter the Attribute name and value, and configure the Settings.

• Mandatory - Denotes the value to be mandatory.

• Ignore If Empty - Ignore the field if empty.

• Hash (SHA256) - denotes the value in the HASH format.

Static: Denotes the static Value that is known.

Step 8.3: Attribute Settings

Enter the Attribute Settings.

Step 8.4: Tool-tip! Select the Mandatory check box to display the Fatal check box.

Step 8.5: Set the Data Type Conversion using the following options.

Step 8.6: Select one of the following Transformer types and click Confirm.

Step 8.7: Select the Ignore Redaction checkbox to display the data elements. Redaction is a setting for each data element, which allows the server-side processing to apply the redaction strategy - like anonymize for email.

Step Result: The Provider Attribute is created.

To delete the Provider Attribute, select the Delete icon at the right-hand corner of the screen.

Step 9: Denote the Script.

The Script denotes the code script if available for the tag. Select the No Script check box if the script is unavailable.

Data Elements are the core components you define while creating the tags. Data elements act as components that intelligently fetch information from across your digital property. You can create any number of custom Data elements for a particular Data type and define the elements in the tags as per client requirements. Some of the Data types include Server Header, Server Cookie, Magic Pixel Data Layer, URL Parameter, Custom JavaScript, Custom event, and so on.

Related Topics

The Data Elements section includes the following topics:

To edit the Data Element in Ingest Labs, perform the following steps:

Step 1: Select the Data Element you want to edit.

Step 2: From the Actions drop-down menu on the top right corner, select Edit.

Step 3: Edit the Data Element details and click Save on the top-right to save the changes.

For Server-side configuration, all the information is fetched from the server.

Perform the following steps to create the Data elements on browser:

Step 1: Click Add Data Element (For Server) on the top right corner of the screen.

Step 2: Enter the following details in the New Data Element screen that appears. Update the Info section on the top-left corner of the screen.

Step 3: Enter the following fields:

The following screen appears if you select Server Cookie:

Step 4: Enter the Cookie name.

Step 5: Select the Default Value from the drop-down. If the value for a particular data element is unavailable, the default value is used.

• Undefined: If the data element is not supposed to be used then select Undefined.

• Empty String: Denotes that the data element is a string value.

• Null: Denotes the Null data type for the data element.

• Custom Value: Denotes the static value for the Data Element.

The following screen appears if you select Server Header:

Select the Default Value from the drop-down. If the value for a particular tag is unavailable, the default value is used.

• Undefined: If the data element is not supposed to be used then select Undefined.

• Empty String: Denotes that the data element is a string value.

• Null: Denotes the Null data type for the data element.

• Custom Value: Denotes the static value for the Data Element.

The following screen appears if you select Json Path:

• Add the Query Json path.

• Select the Default Value from the drop-down. If the value for a particular tag is unavailable, the default value is used.

• Undefined: If the data element is not supposed to be used then select Undefined.

• Empty String: Denotes that the data element is a string value.

• Null: Denotes the Null data type for the data element.

• Custom Value: Denotes the static value for the Data Element.

• Select the following checkboxes, if required:

Clean: Clears and trims any white spaces on the trailing and leading strings after collecting the data value. Lower-case: Denotes that the string needs to be in lower-case.

Step 6: Select redaction for the data element. It is applicable only for serverside tagging. Basically, when you set up a data element as sensitive, and set up a strategy, the backend server will scramble it while using the data element in a tag or provider.

This data classification setting allows the serverside processing to apply a redaction strategy - like anonymize for email ID, IP address, phone number and so on.

Step 7: Click Save to save the changes.

Introduction

For Client-side or Browser-side configuration, all the information is fetched from the webpage or browser.

Procedure

Perform the following steps to create a Data element for the browser:

Step 1: Click the Add Data Element dropdown and select Browser.

Step 2: Enter the following details in the New Data Element screen that appears. Update the Info section on the top-left corner of the screen.

Step 3: Under Data Element Type, there is a dropdown labeled Choose Data Element Type. The available options are:

• URL Parameter

• Launch Data Element

• Custom JavaScript

• Ingest Labs Data Layer

Step 3.1: URL Parameter:

Launch Data Element

Step 5: Enter the following fields in the Launch Data section of the screen.

Magic Pixel Data Layer

Step 6: Enter the following fields in the Magic Pixel Data Layer section of the screen.

Transformation Function

Step 7: Enter the following fields in the Transformation Function section.

Step 8: Select redaction for the data element. Basically, when you set up a data element as sensitive, and set up a strategy, the backend server will scramble it while using the data element in a tag or provider.

This data classification setting allows the serverside processing to apply a redaction strategy - like anonymize for email ID, IP address, phone number and so on.

Step 9: Click Save to save the changes.

Every tag includes a version number on the top-right corner of the screen. Once the tag is published, the version is set to 1. That is Version 1. After subsequent edits and only after publishing the version number keeps updating to the latest version such as version 2, version 3, and so on.

Note: Until the Tag is published, the status displays as Pending Publish. If the Tag is published in staging, the status is updated as Staging. If the Tag is published in production, the status is updated as Production.

Restoring a Tag Version

To restore a specific tag version, follow the steps below:

1. Navigate to the version you want to restore.

2. Click the Action dropdown button.

3. Select Restore to this version from the menu.

This section describes the Data Elements UI screen options.

Filter Data Elements

You can filter the Data Elements based on the following types:

• Filter By Name: Filters the tag based on the Tag name.

• Filter By Attribute Value: Filters the tag based on the Attribute Value.

• Filter By Metadata Attribute: Filters the tag based on the Metadata Attribute.

The following are the additional fields that appear on the Data Elements screen.

This option indicates the number of DATA elements currently displayed out of the total available DATA elements.

You can adjust the number of DATA elements displayed per page using the dropdown menu located at the top-right corner of the screen.

• 50 per page: Displays up to 50 DATA elements on the current page.

• 100 per page: Displays up to 100 DATA elements on the current page.

• 200 per page: Displays up to 200 DATA elements on the current page.

The Refresh button allows you to reload the DATA elements screen. If you create new DATA elements or update their properties and the changes are not immediately visible on the main UI screen, clicking the Refresh button will reload the page to display the most up-to-date information.

Default DATA Elements Checkbox

Select the Default Data Elements check box at the top to list the readily available default data elements. The specific default template will be used for the particular data elements.

Clearing the checkbox shows all available DATA elements.

This section describes the Providers screen UI elements.

Filter Providers

You can filter the Providers based on the following types:

• Filter By Name: Filters the providers based on the Provider name.

• Filter By Attribute Value: Filters the Providers based on Attribute Value.

• Filter By Metadata Attribute: Filters the Providers based on Metadata Attribute.

You can adjust the number of providers displayed per page using the dropdown menu located at the top-right corner of the screen.

• 50 per page: Displays up to 50 providers on the current page.

• 100 per page: Displays up to 100 providers on the current page.

• 200 per page: Displays up to 200 providers on the current page.

The following are the additional fields that appear on the Providers screen.

All Provider Types

The All-Provider Types drop-down menu displays the following provider types:

• All Provider Types

• Image Tags: Providers that use image-based tracking.

• JS Tags: Providers that use JavaScript for tracking.

Filter By Data Elements

The Filter By Data Elements option filters the Data Elements based on the Data Element selected.

Reset Filters

The Reset Filters option resets the applied filters.

Refresh Button The Refresh button allows you to reload the Providers screen. If you create new providers or update their properties and the changes are not immediately visible on the main UI screen, clicking the Refresh button will reload the page to display the most up-to-date information.

The Providers are the key components to be defined before you create tags. Providers include Media providers for implementing the server-side and client-side tags. You can select from the provider templates created and listed by Ingest Labs or add a custom provider template.

Related Topics

The Providers section includes the following topics:

You can delete a particular Data Element.

To delete a Data Element in Ingest Labs, perform the following steps:

Step 1: Select the Data Element you want to delete.

Step 2: From the Actions drop-down menu on the top right corner, select Delete.

Step 3: Click Yes on the confirmatory message that appears.

Step result: The Data Element is deleted successfully.

Note: You cannot delete a Data Element if there are any dependencies in the tag. Only after deleting the dependent categories, you can delete the Data Element successfully.

Even after deleting the dependencies, if you cannot delete the Data Element, then you must Publish the relevant categories first and then perform the delete operation.

All the information required for Client-side or Browser-side configuration is fetched from the webpage or browser.

To add a new Provider in Tag Manager, perform the following steps:

Step 1: From the left navigation panel, select Providers.

Step 2: Select Add Provider -> For Browser on the top-right corner of the screen.

Step 3: The Provider Template panel opens on the right side and choose a template from the list or use the Search bar to find a specific one.

To add a custom image provider, select Custom Image Provider from the Provider Template box.

You can also select other JS provider templates. Let us take an example of the Facebook JS provider template.

Step 4: Enter the Provider Details such as Provider Name and Description in the New Provider screen.

Step 5: The Script section includes both the Template script and Provider script.

You can enter the JavaScript in the Provider Script section and click Save to save the changes.

Step 6: The Attributes section lists the Attributes for Data Elements and Transformers. This is an Optional section.

Step 8: Select either User-Defined Data Element or Default Data Element.

Step Result: The selected Data Element is visible in the Value section.

Step Result: The selected Transformer is visible in the Value section.

Step 10: Click cancel on the top right of the page to cancel the settings and view the the list of providers.

Click Save on the top right to save the new Provider (Browser).

Note: The page displays the following success message.

Every Data Element includes a version number on the top right corner of the screen. Once the Data Element is published, the Version is set to 1. That is Version 1.

After subsequent edits and only after publishing, the version number keeps on updating to the latest version such as Version 2, version 3, and so on.

Note: For the default Data Elements, the version is always set to “1” because these are populated from the template.

Until the Data Element is published, the status displays Pending Publish. When the data element change is published in staging or production environment, the status is updated with the corresponding environment in the Data Elements screen.

Deleted data elements can be restored using the Restore option.

To restore a deleted data element, perform the following steps:

Step 1: Navigate to the Data Elements screen to view the deleted Data Element.

Step 2: Select the Data Element and click Restore under the Actions drop-down on the top right corner.

Step 3: Click Yes in the Restore confirmatory dialog box that appears.

Step Result: The Data Element is restored successfully.

The Triggers indicate when a particular tag is to be triggered based on the data inputs. The triggers are associated with different actions and events while performing the tasks. Some of the examples for triggers include Product View, View cart, Add to cart, View price, View item, View Payment, and so on. Also, the Qualification Criteria provides the additional criteria to indicate more specific instances of when the tag must be triggered. While the Triggers are mandatory, Qualification Criteria is optional.

Related Topics

The Triggers section includes the following topics:

You can edit the Provider details of an existing Provider.

To edit the Provider in Ingest Labs, perform the following steps:

Step 1: Select the Provider that you want to edit.

Step 2: From the Actions drop-down menu on the top right corner, select Edit.

Step 3: Edit the Provider details and click Save on the top-right to save the changes.

This section describes the Triggers screen UI elements.

Filter Triggers

Using the Filter Triggers option, you can filter the triggers based on the following types:

Filter By Name: Filters the trigger based on the trigger name. • Filter By Attribute Value: Filters the trigger based on Attribute Value.

• Filter By Metadata Attribute: Filters the trigger based on Metadata Attribute.

This option indicates the number of Triggers currently displayed out of the total available Triggers. You can adjust the number of Triggers displayed per page using the dropdown menu located at the top-right corner of the screen.

• 50 per page: Displays up to 50 Triggers on the current page.

• 100 per page: Displays up to 100 Triggers on the current page.

• 200 per page: Displays up to 200 Triggers on the current page.

Filter By Data Elements

The Filter By Data Elements option allows to filter the triggers based on the Data Elements.

You can select either the User-defined Data Element or Default Data Element in the Choose Data Elements screen.

Reset Filters

The Reset Filters option resets the filter criteria applied.

Default Triggers

Select the Default Triggers check box if you are selecting the default triggers for a particular tag.

The following are the additional fields that appear on the Triggers screen.

You can delete a particular Provider using this option.

To delete a Provider in Ingest Labs, perform the following steps:

Step 1: Select the Provider that you want to delete.

Step 2: From the Actions drop-down menu on the top right corner, select Delete.

Step 3: Click Yes on the confirmatory message that appears.

Step result: The Provider is deleted successfully.

Note: You cannot delete a provider that includes provider dependencies with the other attributes. Only after deleting the dependent categories, you can delete the Provider successfully.

Even after deleting the dependencies, if you cannot delete the Provider, then you must Publish the relevant categories first and then perform the delete operation.

For Server-side configuration, all the information is fetched from the server.

To add a new Provider on Ingest Labs, perform the following steps:

Step 1: Select Add Provider -> For Server on the top-right corner of the screen.

Step 2: The Provider Template panel opens on the right side. Select a template from the list or use the Search bar to find a specific one.

Step 3: Let's take an example of the Facebook Conversion API provider template.

Step 4: Ingest Labs configures the Provider Name and Base URL.

Step 5: The values such as the API version and the Pixel Id are specific to every provider. You need the API version, Pixel ID, and Access token before you add a Facebook Conversion API template.

Step 6: To add a Facebook Conversion API Template, perform the following steps:

b. Follow the steps mentioned on the webpage.

Add Attributes The Attributes section consists of the following two sub-sections:

• User Data

• Custom Data

Step 7: Under the Attributes section, click Add Attribute at the bottom to add a new attribute. The Name, Value, and Settings information is visible.

Note: You can set the attribute to Mandatory, Ignore If Empty, Fatal, Hash (SHA256).

• Mandatory: This value is mandatory.

• Fatal: This value is mandatory.

• Ignore If Empty: This may be ignored if the value is not set.

• HASH (SHA256): The value is converted to HASH format.

You can see a list of parameters here:

Step 8: To add a new parameter from the Customer Information Parameters, for example, the subscription Id, perform the following steps:

a. In the JSON section, click Add Attribute.

b. Add the exact field name under User Data and configure it with a data element that returns a subscription Id.

Step 9: To modify the settings, click the Settings icon on the bottom-right corner of the screen.

Step 10: Enter the Attribute Settings and click Confirm to save the changes.

The following are the Data Type Conversions for the attributes.

Step 11: To delete the attribute, click the Delete icon.

Step 12: Enter the fields in the HTTP Headers section. This section is optional.

Step 13: Enter the fields in the Connectors section and click Save to save the changes.

Every Provider includes a version number on the top right corner of the screen. Once the Provider is published, the Version is set to 1. That is Version 1. After subsequent edits and only after publishing, the version number keeps on updating to the latest version such as Version 2, version 3, and so on.

Note: For the default Providers, the version is always set to “1” because these are populated from the template. Until the Provider is published, the status displays as Pending Publish. If the Provider is published in staging, the status is updated as Staging. If the Provider is published in production, the status is updated as Production.

You can edit the Trigger details of a particular Trigger that is already created.

To edit the Trigger in Tag Manager, perform the following steps:

Step 1: Select the Trigger that you want to edit.

Step 2: From the Actions drop-down menu on the top right corner, select Edit.

Step 3: You can edit the details in the Info section and Data Elements section.

Step 4: Click Save on the top right to save the changes.

Every Trigger includes a version number on the top right corner of the screen. Once the Trigger is published, the Version is set to 1. That is Version 1. After subsequent edits and only after publishing, the version number keeps on updating to the latest version such as Version 2, version 3, and so on.

Note: For the default Triggers, the version is always set to “1” because these are populated from the template.

Note: Until the Trigger is published, the status displays as Pending Publish. Once the Trigger is Published, the status is updated as Production.

For Server-side configuration, all the information is fetched from the server.

To add a new server-side trigger, perform the following steps:

Step 1: From the left navigation panel, select Triggers.

Step 2: Select Add Trigger -> For Server on the top-right corner of the screen.

Step 3: Enter the Trigger Name in the Name field in the Info section.

Step 4: Click Data Element to open the Select Data Element panel on the right side of the screen. This panel contains two tabs: User-defined and Default. You can either browse through the list or use the search bar to find a specific Data Element.

Step 5: Record Trigger

When you check the Enable checkbox, the Namespace field appears. Enter the appropriate namespace in this field.

Step 6: Click Save to save the trigger details.

For Client-side or Browser-side configuration, all the information is fetched from the webpage or browser.

To add a new Trigger, perform the following steps:

Step 1: From the left navigation panel, select Triggers.

Step 2: Select Add Trigger -> For Browser on the top-right corner of the screen.

Step 3: Enter the Trigger Name in the Name field in the Info section.

Step 4: Click Data Element to open the Select Data Element panel on the right side of the screen. This panel contains two tabs: User-defined and Default. You can either browse through the list or use the search bar to find a specific Data Element.

Step 5: Record Trigger

When you check the Enable checkbox, the Namespace field appears. Enter the appropriate namespace in this field.

Step 6: Click Save to save the trigger details.

A deleted trigger can be restored using the Restore option.

To restore the changes, perform the following steps:

Step 1: Navigate to the Triggers screen to view the deleted trigger.

Step 2: Select the Trigger and click Restore under the Actions drop-down on the top-right corner.

Step 3: Click Yes in the Restore Trigger confirmatory dialog box that appears.

Step Result: The Trigger is restored successfully.

For Client-side or Browser-side configuration, all the information is fetched from the webpage or browser.

To add a new Qualification Criteria in Tag Manager, perform the following steps:

Step 1: From the left navigation panel, select Qualification Criteria.

Step 2: Select Add Qualification Criteria -> For Browser on the top-right corner of the screen.

Step 3: Enter the Qualification Criteria Name in the Name field under Info section.

Step 4: Select the Data Element from the Data Element section.

Step 5: For each Data Element, the following criteria is to be met.

Step 6: Click Save on the top right to save the Qualification Criteria details.

The Qualification Criteria are similar to Triggers that are performed to trigger the tag for a specific condition. The Ingest Labs triggers the tag when the Qualification Criteria is met for either browser-side tags or server-side tags.

Note: The Qualification Criteria evaluates the conditions to trigger a tag. For a particular tag to trigger, the qualification criteria is optional. However, when the Qualification Criteria is provided along with the Triggers, then the conditions for Triggers and Qualification Criteria must return true. Only then the tag gets triggered.

Also, if the Qualification Criteria is not defined, the tag is triggered only when the triggers are invoked.

Related Topics

The Qualification Criteria section includes the following topics:

This section describes the Qualification Criteria UI screen elements.

This option indicates the number of Qualification Criteria currently displayed out of the total available Qualification Criteria. You can adjust the number of Qualification Criteria displayed per page using the dropdown menu located at the top-right corner of the screen.

• 50 per page: Displays up to 50 Qualification Criteria on the current page.

• 100 per page: Displays up to 100 Qualification Criteria on the current page.

• 200 per page: Displays up to 200 Qualification Criteria on the current page.

Filter Qualification Criteria

The Filter Qualification Criteria is based on the following types:

• Filter By Name: Filters the Qualification Criteria based on the trigger name.

• Filter By Attribute Value: Filters the Qualification Criteria based on Attribute Value.

• Filter By Metadata Attribute: Filters the Qualification Criteria based on Metadata Attribute.

Filter By Data Elements

The Filter By Data Elements option filters the Qualification Criteria based on the Data Elements.

You can select either the User-defined Data Element or Default Data Element in the Choose Data Elements screen.

Reset Filters

The Reset Filters option resets the filter criteria applied.

The following are the additional fields that appear on the Qualification Criteria screen.

Introduction

To monitor and capture events in your triggers, you can enable the recording feature. This will ensure that every event occurring within the triggers is saved and marked as recorded for future reference.

You can enable the recording feature for triggers by following these steps.

Navigate to Tag Manager > Triggers.

Note: You can create Record Triggers for both Server and Browser.

Step 1: Click Add Trigger.

Note: You can create Record Triggers for both Server and Browser.

Step 2: Click for Browser.

Step 3: Under the Info section, click the Name field and enter an appropriate name for your Record Trigger.

Step 4: Under Data Element, click Add Data Element. The Select Data Element panel will open on the right side. You can either search for a particular data element by typing its name in the search bar or select it from the available list.

Step 5: Under the Include these values section, click Add value to include list to give the appropriate value you want to include, and then click the plus symbol.

Step 6: After clicking the plus symbol, two checkboxes will appear:

· Case Sensitive and

· Exact Match

Click both checkboxes to apply these settings.

Note: Under Exclude these values, you can give values to exclude.

Step 7: Under the Record Trigger section, you will find the Enable checkbox. Check the box, and then the Namespace section will appear. Provide the appropriate namespace value.

Step 8: Click Save.

Step 9: Red color indicates that the trigger is actively being recorded.

Note: The same steps apply for server-side triggers.

The Transformers or the transformation functions are the main building blocks of data while implementing tags. The data layer value may return an object and needs to convert it into a variety of other formats to be used within tags or provider attributes.

The standard approach is to create multiple Data elements and format the value each time while creating other Tag Managers. This results in the same data being redefined in various occurrences. However, if the source data changes, then you must update all the instances where it is being read and transformed to different formats.

A transformation function can accept any number of data elements as inputs, format the data, and return it in a different format as required for a dynamic template parameter.

Related Topics

The Transformers section includes the following topics:

For Server-side configuration, all the information is fetched from the server.

To add a new Qualification Criteria in Tag Manager, perform the following steps:

Step 1: From the left navigation panel, select Qualification Criteria.

Step 2: Select Add Qualification Criteria -> For Server on the top-right corner of the screen.