Web Companion

Web Companion

by on ‎02-25-2016 04:52 PM - edited on ‎03-26-2018 10:27 PM by kathleen_jo (6,209 Views)

Web Companion is a browser tool that allows you to check your iQ installation, inspect data on your site, and create and test new configurations quickly and easily.

In this article:

Table of Contents Placeholder

Install Web Companion

  1. Click on your name in the top-right corner of Tealium iQ console to drop-down the Account Admin settings. Click Web Companion.
    web_companion_account_admin1.png
  2. A pop-up window containing instructions to install Web Companion will appear on your screen.

    Enable the Bookmarks Bar in your browser before the next step.

  3. Drag the "Tealium Web Companion" link from the message box on to your browser's bookmark bar.
     web_companion_pop_up.png

Another version of Web Companion can be installed as a custom Tealium Tool. Learn more about the Tealium Tool: Web Companion.

Launch Web Companion

  1. Navigate to your site where Tealium iQ is installed.
  2. Locate “Tealium Web companion" on your browser's bookmarks bar and click to launch it.tealium_web_companion.png

Using Web Companion

Web Companion is organized into three screens (or tabs): Overview, Data, and Tools. The following sections describe what is available on each tab.

Overview

Account Information

The current account, profile, version, and environment that the page is running is displayed under this tab. None of this information can be modified from Web Companion. To do so, you must go through the Tealium iQ Console.

Target Environment

The default environment will be outlined in orange. The currently viewed environment will be highlighted in blue. You may view any of the three environments, but switching between them will require you to reload the webpage and Web Companion.
NOTE: Allow the webpage to finish loading before restarting Web Companion.

Tags & Extensions Tabs

This tab will show which Tags loaded and whether they successfully sent requests. The Extensions that are successfully completed will also be displayed.

Load rules

This tab shows all load rules that are active in your profile. (This feature is under construction.)

Timers

The load and send times of each Tealium JavaScript library are displayed at the bottom of the tab.

Saving Changes

Changes applied to the profile through the Web Companion are queued at the bottom of the bookmarklet and will not be committed until you click the "Save..." button. If you do not wish to commit a change, you may also remove that change from the queue by clicking on the X button next to the appropriate change.

saving_changes_web_companion.png

Data

You can expand the range of data that you wish to capture by adding them as data sources to your profile. Data tab allows you to choose from 4 different types of data:

  • HTML Metadata: Information about the webpage, author, title and other meta elements of the HTML document.
  • Querystring Parameters: The name and value of a parameter located within the query string of the URL.
  • Cookies: Small files that store visitor and session information.
  • JavaScript Variables: Container to hold data of a specific type.
  • Universal Data Object

data_tab.png

To add a data type,

  1. Click Data tab in the Web Companion bookmarklet and select a data type that you wish to add to your profile. This action drops down a list of variables under that data type.
  2. Locate your desired variable and click the '+Add' button.

added_data_variables.png

The blue Added button indicates that the data source has been added to your Tealium iQ account.

Universal Data Object

universal_data_object_type.png

Universal Data object (UDO), or utag_data, is a key component of the Data Tab. It is the source of much of the data Tealium sends to the tags of your third-party vendors. Serial menu tabs display the value and total count of variables present on the webpage. For more information about Universal Data Object, please visit Tealium's guide to UDO.

Tools

This tab allows you to target a webpage element and manipulate it by employing tools like extensions and load rules.

tools_tab.png

An extension or load rule added to your account via Web Companion is not active until you revisit the console to activate them.

On-Page Element Selector

Select an element on the webpage and apply Content Modification Extension and (or) jQuery Live Handler Extension to it. Click "Queue" and save the extensions to your profile.

on_page_element_selector.png

Load Rule Helper

Create a new load rule to determine the location and instant a Tag should load. Click "Add to Queue" and save the load rule to your profile.

load_rule_helper.png

Custom Target Environment

Publish to a custom environment instead of the 3 default environments (Dev, QA, and Prod). Enter the name of the target environment in the text-box and click "Set Environment".

set_target_environment.png

Adobe Test and Target

Add this extension to modify your desired content on the page. Configure the extension and click "Add to Queue" to save it to your profile. For more details, please visit Tealium's guide on Adobe Test and Target Extension.

adobe_test_and_target.png