Tealium Learning Center

john_tyler_gran · ‎05-16-2016

Tealium Addon for Hybris Setup Guide Prerequisites A Tealium IQ account. hybris v5.0.1+ extracted and built, including the B2C Commerce Accelerator. Definitions Universal Data Object (UDO) = The Data Layer object of key/value pairs. This object is generated in the page as the global JavaScript object utag_data. The Tealium utag.js uses utag_data as the base Data Layer for your Tags. Tealium Account = The account assigned to your purchase of Tealium iQ. Tealium Profile = The specific web property name for your website. Installing Addon Github repo: https://github.com/Tealium/integration-hybris Place the "tealiumiqaddon" directory into ${HYBRIS_BIN}/custom. This directory is in the /hybris/bin/custom/ folder in the repo. Add <extension dir="${HYBRIS_BIN}/custom/tealiumiqaddon"/\> to your config/localextensions.xml. Add "tealiumiqaddon" to yacceleratorstorefront by using: - sudo ant addoninstall -Daddonnames="tealiumiqaddon" - DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront" Update Files: ${HYBRIS_BIN}/ext-template/yacceleratorstorefront/web/webroot/WEB-INF/tags/desktop/te mplate/master.tag by adding: <%@ taglib prefix="tealiumiqaddon" tagdir="/WEB-INF/tags/addons/tealiumiqaddon/shared/analytics" %> at the top of the file. <tealiumiqaddon:sync/> after the <head> tag. <tealiumiqaddon:tealium/> after the <body> tag ${HYBRIS_BIN}/custom/tealiumiqaddon/project.properties.template by changing: tealiumiqaddon.account,tealiumiqaddon.profile, and tealiumiqaddon.target to your Tealium IQ account-specific information. Modify tealiumiqaddon.utagSyncEnabled = 1 if you want to enable utag.sync.js injection into the <head> of your HTML page. This feature is optional and disabled by default. Adding Custom Data By default, the add on provides a comprehensive list of standard e-commerce variables. If these default values are not sufficient for your installation, you can extend the default page types as well as create new custom page types. Create a new class implementing the interface "com.tealium.dataconnector.hybris.HybrisDataConverter.HybrisCustomDataConverter" and implement all methods of the interface. package com.tealium.dataconnector.hybris; import com.tealium.dataconnector.hybris.HybrisDataConverter.HybrisCustomDataConverter; import com.tealium.dataconnector.hybris.HybrisDataConverter.HybrisCustomPageTypeCustomData; import com.tealium.util.udohelpers.UDO; import com.tealium.util.udohelpers.exceptions.UDOUpdateException; public class TealiumCustomData implements HybrisCustomDataConverter { // ... add unimplemented methods of interface. } If you are NOT adding values to any of the methods of the interface, make sure to return the udo object. @Override public UDO homePage(UDO udo) { return udo; } To add or modify values to a default page, add to the override method for that page. @Override public UDO searchPage(UDO udo) { try { udo.setValue("page_name", "new search page name"); udo.setValue("custom_key", "custom_value"); } catch (UDOUpdateException e) { e.printStackTrace(); } return udo; } To add a new page type with values, add a static variable to your class and add new pages to the "addCustomPages" method: public class TealiumCustomData implements HybrisCustomDataConverter { private static Map<String, HybrisCustomPageTypeCustomData> customPagesMap; @Override public Map<String, HybrisCustomPageTypeCustomData> getHybrisCustomPageTypes() { return customPagesMap; } //... other methods @Override public void addCustomPages() { if (customPagesMap == null){ customPagesMap = new HashMap<>(); } customPagesMap.put("custom_one", new HybrisCustomPageTypeCustomData(){ @Override public UDO getCustomDataUdo(UDO udo) { try { udo.setValue("page_name", "custom page 1"); udo.setValue("custom_page1_key", "custom value"); } catch (UDOUpdateException e) { e.printStackTrace(); } return udo; } }); customPagesMap.put("custom_two", new HybrisCustomPageTypeCustomData(){ @Override public UDO getCustomDataUdo(UDO udo) { try { udo.setValue("page_name", "custom page 2"); udo.setValue("custom_page2_key", "custom value"); } catch (UDOUpdateException e) { e.printStackTrace(); } return udo; } }); } } Modify: ${HYBRIS_BIN}/custom/tealiumiqaddonweb/webroot/WEB-INF/tags/addons/tealiumiqaddon/shared/analytics/data.tag Replace CLASS_NAME with your class name (i.e. TealiumCustomData) Add your new class: <%@ tag import="com.tealium.dataconnector.hybris. CLASS_NAME "%> Register the new class with HybrisDataConverter: <%HybrisDataConverter.registerCustomDataClass("ID", new CLASS_NAME ()); %> Finish Rebuild and restart hybris. - sudo ant all - sudo ./hybrisserver.sh Default data sources All Pages page_name Contains a user-friendly page name site_region Includes values for region or localized version, e.g. en_US site_currency Contains the currency shown on site, e.g. USD page_type Contains a user-friendly page type, e.g. cart page Search Page search_results Contains the number of results returned with a search query search_keyword Contains the search query conducted by user Category Pages page_category_name Contains a user-friendly category name, e.g. appliances Product Page product_id Contains product ID(s); multiple values should be comma-separated product_sku Contains product SKU(s); multiple values should be comma-separated product_name Contains product name(s); multiple values should be comma-separated product_brand Contains product brand(s); multiple values should be comma-separated product_category Contains product category(s); multiple values should be comma-separated product_subcategory Contains product subcategory(s); multiple values should be comma-separated product_unit_price Contains product unit price(s); multiple values should be comma-separated Cart Page product_id Contains product ID(s); multiple values should be comma-separated product_sku Contains product SKU(s); multiple values should be comma-separated product_name Contains product name(s); multiple values should be comma-separated product_brand Contains product brand(s); multiple values should be comma-separated product_category Contains product category(s); multiple values should be comma-separated product_subcategory Contains product subcategory(s); multiple values should be comma-separated product_unit_price Contains product unit price(s); multiple values should be comma-separated product_quantity Contains product quantity(s); multiple values should be comma-separated Order Confirmation order_id Contains the order or transaction ID order_subtotal Contains the order payment type order_payment_type Contains the order payment type order_total Contains the order total value order_discount Contains the order discount (if any) order_shipping Contains the order shipping value order_tax Contains the order tax amount order_currency Contains the currency associated with the transaction, e.g. USD' order_coupon_code Contains the order coupon code order_type Contains the order/cart product_id Contains product ID(s); multiple values should be comma-separated product_sku Contains product SKU(s); multiple values should be comma-separated product_name Contains product name(s); multiple values should be comma-separated product_brand Contains product brand(s); multiple values should be comma-separated product_category Contains product category(s); multiple values should be comma-separated product_subcategory Contains product subcategory(s); multiple values should be comma-separated product_unit_price Contains product unit price(s); multiple values should be comma-separated product_quantity Contains product quantity(s); multiple values should be comma-separated customer_email Contains the customer email Customer Info Page customer_name Contains the customer username customer_email Contains the customer email gender Contains the customer gender based on salutation

john_tyler_gran · ‎04-08-2016

Tested on Sitecore version 8.2 rev161221 released in Feb 2017. Latest release is in github here: https://github.com/Tealium/integration-sitecore Older versions available from Sitecore here: https://marketplace.sitecore.net/Modules/Tealium_Tag_Management.aspx?sc_lang=en

john_tyler_gran · ‎04-07-2016

IBM Websphere Commerce's Tealium Extension is designed to help you integrate Tealium iQ Tag Management within your IBM Websphere solution. Using this extension you will be able to add Tealium's Universal Data Object (UDO) into your site's data layer.

Date Registered	‎09-01-2015 05:03 PM
Date Last Visited	‎05-16-2016 10:20 AM
Total Messages Posted	10

Tealium Learning Center

Hybris Integration

Integrating Sitecore and Tealium iQ

IBM WebSphere Commerce Integration Guide

Products

Company