Back

This article describes how to manage profile libraries in iQ Tag Management (TiQ).

In this article:

How it Works

Libraries are used to manage configurations that are shared across multiple profiles. Consider the following points before you begin working with libraries:

  • A profile can load one or more libraries, but libraries cannot load profiles or other libraries.
  • A library is almost identical to a profile with the exception that a library can be imported into another profile.
  • After an element from a library is imported into a profile, it cannot be edited.
  • You can modify the tag configuration of an imported tag, as changes to tag configuration take precedence over library settings.
  • After saving and publishing a profile with imported libraries, the resulting version and utag.js file  represent the entire profile configuration.

Creating a Library

Though all users in an account can see all libraries, only users with the Manage Profiles permission can create a profile library.

Use the following steps to create a new library:

  1. In the user admin menu click Manage Profiles.
    The Manage Profiles window displays with all libraries and profiles for your account on the left.
  2. Next to Libraries, click Add.
    The Create Library dialog displays.
  3. In the Name field, enter the name for your library.
    As a best practice, devise a naming convention to differentiate your libraries from your profiles. For example, adding "lib-" in front of your library names makes it easy to determine if you are working with a library or a profile. Profiles and libraries cannot share names.
    WhiteUI_TiQ_Managing Profile Libraries_Create a Library.jpg
    Library names have the same limitations as profile names: no spaces, lowercase letters, numbers, periods, and dashes only.
  4. Select one of the following checkboxes to determine if the library is optional or required:
    • Require All profiles to include library
      All profiles include this library automatically.
    • Optionally include this library in other profiles
      You specify which profiles include this library.
  5. In Copy Elements From, check one or more boxes to select the specific elements you want to include from the profile or library you selected. The elements you select are copied from the profile/library that you are currently logged into. If you select none, you will create a blank library.
    • Variables
    • Extensions
    • Consent Manager
    • Load Rules
    • Publish Settings
    • Tags
    • Users
  6. Click Create Library.
    Wait for the library to publish and display a success message.
  7. Click Apply.
    You must log into the library by selecting it from the account/profile menu and clicking Load Version.

Editing a Library

Use the following steps to edit a library:

  1. In the user admin menu click Manage Profiles.
    The Manage Profiles window displays with all libraries and profiles for your account on the left.
  2. Click the library you want to view and select the correct profile from the Profiles drop-down list and then click Edit.
    WhiteUI_TiQ_Managing Profile Libraries_Edit Library.jpg
  3. Select Require All profiles to include library or Optionally include this library in other profiles and click OK.
    When editing a library, the changes go into effect immediately.

    Although changing a required library to an optional library does not affect the profiles that are linked to it, changing an optional library to a required library automatically links the library to each profile.

  4. Click Apply to exit the window.

Saving a Library

Consider the following before saving your library:

  • You may only perform a Save as action with a library.
  • As a best practice develop a naming convention to keep track of your library versions. 
  • Changes to a library do not automatically propagate to all the profiles that load it. You must re-publish each profile to include the changes to the library.

Use the following steps to save a library:

  1. Click Save/Publish.
    Only the Save As option displays.
  2. Enter a title using your naming conventions.
  3. Enter descriptive notes about this version.
  4. Click which environments to publish to.
    WhiteUI_TiQ_Managing Profile Libraries_Publish Library.jpg
  5. Click Publish.

Next, load the profiles that are linked to the library to import the latest changes and save the profile.

Linking a Library to a Profile

You may link a library to profile, or a profile to a library. After you create a link between a library and a profile, the next time you load the profile, the contents of the library will be imported.

To link a library to a profile:

  1. In the user admin menu click Manage Profiles.
    The Manage Profiles window displays with all libraries and profiles for your account on the left.
  2. Select the profile to which you want to link a library from the profiles list on the left.
    You can optionally select a library to which you want to link a profile.
  3. Select the library from the drop-down list at the top of the window.
    WhiteUI_TiQ_Managing Profile Libraries_Link to Library.jpg
  4. Click + Link to Library.
    The library selected displays.
  5. Select the publish environment (Dev, QA, Prod) of the library you want to link to the profile.
    WhiteUI_TiQ_Managing Profile Libraries_Link to Library_Select Publish Environment.jpg
  6. To remove a link, click Remove Link.
    You cannot remove a link to required libraries.
  7. Click Apply.

Publishing Linked Profiles

Regardless of whether the library is optional or required, additions of new libraries or changes to existing libraries require that you publish a new version of the linked profiles to import the latest library configurations. You must publish each profile individually.

Use the following steps to determine which profiles are linked to a library:

  1. In the user admin menu click Manage Profiles.
    The Manage Profiles dialog displays.
  2. Under the Libraries section, click the library to inspect.
    The profiles to which this library is linked display in the main window on the right. The Library Version column displays which publish environment of this library the profile is linked to.
    WhiteUI_TiQ_Managing Profile Libraries_View Library Version.jpg
  3. Click Cancel to close the window.

Identifying Library Elements in a Profile

Consider the following when identifying library elements in a profile:

  • Elements added from a library receive a label that indicates which library each element belong to.
  • Tags added to a profile through a library receive a unique ID for that profile. This unique ID may be different than the ID that a tag receives when added to the library.
  • Any tag, load rule, or extension added in a library will display as 'ON' in the profile that loads the library. You cannot turn off a library-loaded element from a profile that loads the library.
  • You cannot remove data layer variables imported from a library.

Deleting a Library

Deleting a library is an irreversible action. Tealium recommends that you phase out the use of a library across all affected profiles prior to deleting. To delete a library, contact your account manager.