AgilOne Webtag Setup Guide
This article describes how to set up the AgilOne tag in your Tealium iQ Tag Management account.
- Authentication Key (required for authenticating API calls to AgilOne)
- Tealium Event Extension (optional but highly recommended)
First, go to Tealium’s Tag Marketplace and add the AgilOne Web Tag Tag to your profile (how to add a Tag?).
After adding the Tag, configure the below settings:
- Tenant ID (Required): The tenant ID you received from AgilOne.You may specify the ID in this field or set it dynamically using Data Mappings.
Load Rules determine when and where to load an instance of this Tag on your site.
Recommended Load Rule: Load on all pages
Mapping is the process of sending data from a Data Layer Variable to the corresponding destination variable of the vendor Tag. For instructions on how to map a Variable to a Tag destination, see Data Mappings.
The destination variables for the AgilOne Web Tag Tag are built into its Data Mapping tab. Available categories are:
|Tenant ID||(Required) Tenant ID|
|Authentication Key||(Required) Authentication Key Value|
|Search Term||The keyword used for searching the site|
|Event Name||Name of the event you want to trigger. Recommended for triggering events that are not already offered in the Tealium Event Extension.|
|Event Entity URL||URL of the page on which the event is happening|
|Event Entity Time||(Optional) timestamp of when the event is triggered. AgilOne recommends sending this value ONLY if the timestamp does not equal the time when the event is sent.|
|Event Entity Custom Data*||Additional data to send with the Event Entity|
The Event Entity Custom Data is not the same as the Event Custom Data category.
Since the AgilOne Web Tag Tag is e-commerce enabled, it will automatically use the default E-Commerce Extension mappings. Manually mapping in this category is generally not needed unless:
- you want to override any Extension mappings
- your desired ecommerce variable is not offered in the Extension
|Destination Name||Description||E-Commerce Extension Variable|
|Order ID||Unique Order ID||
|Order Total||Total value of order||
|Order Subtotal||Subtotal amount of the order||
|Shipping Amount||Shipping Amount||
|Tax Amount||Amount of Tax||
|Order Organization ID||Order Organization ID||NA|
|Order Invoice Date||Invoice Date for the Order||NA|
|Order Custom Data||Custom Data for Order||NA|
|Customer ID||Unique customer ID||
|List of Product IDs||Array of Product IDs||
|List of Transaction Item IDs||List of Transaction Item IDs||NA|
|List of Names||Array of Product Names||
|List of SKUs||List of SKUs||
|List of Brands||List of Brands||
|List of Categories||Array of Product Categories||
|List of Quantities||Array of Product Quantities||
|List of Prices||Array of Product Prices||
|List of Discounts||List of Discounts||
|List of Organization IDs||List of Organization IDs||NA|
|List of Product Types||List of Product Types||NA|
|List of Product Subtypes||List of Product Subtypes||NA|
|List of Product Shipping Revenues||List of Product Shipping Revenues||NA|
|List of Product Organization IDs||List of Product Organization IDs||NA|
|List of Product Ship Dates||List of Product Ship Dates||NA|
|List of Product Invoice Dates||List of Product Invoice Dates||NA|
|Product Custom Data||Product Custom Data||NA|
|Customer Email||Customer’s email address|
|Customer UUID||Customer’s UUID|
|Customer Preference DNE||Email opt-out value|
|Customer Preference DNM||Postal opt-out value|
|Customer Preference DNC||Phone opt-out value|
|Customer Custom||Custom data about the customer|
Map to these destinations to send data for the current cart items.
|Current Cart ID||Unique cart identifier|
|Current Cart Quantity||Quantity of each item in the cart|
|Current Cart Custom Data||Custom data associated each item in the cart|
To send data for cart updates (addition or removal), use the
_cprod E-Commerce mapping. Refer to the Sending Cart Updates section for more.
Event Custom Data
Use these mappings to send additional data for standard events only.
|Event Custom Data for Product View||Event Custom Data for Product View|
|Event Custom Data for Search||Event Custom Data for Search|
|Event Custom Data for Category View||Event Custom Data for Category View|
|Event Custom Data for Brand View||Event Custom Data for Brand View|
|Event Custom Data for Cart Update||Event Custom Data for Cart Update|
|Event Custom Data for Checkout||Event Custom Data for Checkout|
Triggering Standard Events
Standard events supported by AgilOne are triggered through the Tealium Events Extension. That means you don’t have to map the event name or trigger value for any event that is supported through the Extension. The Extension introduces standardized event names into your solution, along with a new Data Layer Variable called
tealium_event. Each event is assigned a custom condition that matches your data layer implementation. When an event condition evaluates to
tealium_event is set to a pre-defined event value. Tealium’s AgilOne Webtag template reads the predefined value and accordingly fires the event. For example, when the condition for “Add to Cart” evalutes to
tealium_event will be set to
cart_add and the cart event fires on the cart page.
Full list of events supported for AgilOne through Tealium Events Extension:
|Event Name||tealium_event Variable Value||Supporting Extension|
|Search Page View||
|Product Detail Page View||
|Category Page View||
|Add to Cart||
|Remove from Cart||
To send additional custom data with a standard event, map in the Event Custom Data mappings under Standard Category.
Triggering Non-standard Events
If the event you want to trigger is not offered in the Tealium Events Extension, there is an alternative. You may use the Set Data Value Extension instead to set the event trigger and event condition. Then, map the trigger variable to the Event Name destination (under Standard Category).
The Brand View event is an example of a non-standard event. Follow these steps to trigger the event:
Add and configure a new Set Data Values Extension from the Extension marketplace.
Scope it to AgilOne Webtag.
event_nameData Variable to the text
brand_view. Remember: the
brand_viewvalue is predefined in the template and cannot be changed.
Add an event condition to evaluate the customer’s brand view action. For example,
If you don’t find the Variable you are looking, you may add it on the fly.
- Go to the Tag’s Data Mappings tab and map the
event_nameVariable to the Event Name destination (Standard category).
Sending Cart Updates
Adding and removing items from a cart are treated as standard events and, therefore, easily triggered via the Tealium Events Extension. Sending data for the final cart (including the added or removed items) is a three-step process:
- Configure the Tealium Events Extension to trigger the cart addition/removal event.
- Go to the Tag’s Current Cart mappings and map to the desinations of choice.
- Go to the E-Commerce Extension and map the newly added or removed cart item to
_cprod. This will capture the updated cart items separately.
When the add-to-cart/remove-from-cart event fires on a page, our Tag template will automatically piece together the added/removed item(s) with the current cart data and send the complete cart list.
To correctly identify a removed cart item, you must map it to both E-Commerce
cprod and Current Cart.
Thank you for your feedback!
This page was last updated: August 21, 2017