Important Updates to the Sync File (utag.sync.js)

Tony_Taliaferro
Tealium Employee

We have expanded and simplified how you manage code in the utag.sync.js file. A new extension scope named utag Sync associates an extension to the utag.sync.js file. The utag Sync scope is available for the JavaScript Code or Advanced JavaScript Code extensions.

What's New

Previously, the utag.sync.js file could only be updated by editing the tag template. This method was inflexible, prone to error, and limited to users with the permission to manage templates. The new scope allows you to manage the contents of the utag.sync.js file with all the conveniences of extensions.

How It Works

Use the utag Sync scope to publish code from a JavaScript Code extension into utag.sync.js instead of editing the tag template. Add a JavaScript Code or Advanced JavaScript Code extension and set the scope to utag Sync. When the profile is published, the placeholder ##UTSYNC## in utag.sync.js is replaced by the code from the scoped extensions.

Benefits

Convenience of Extensions
Enjoy the convenience of extensions while managing utag.sync.js. Enable or disable the code in utag.sync.js by turning on or off the associated extensions and easily publish utag.sync.js to different environments using publish locations.

Support for Inheritance and Libraries
Create and manage shared utag Sync extensions with libraries, which will be inherited to child profiles. This allows you to easily manage common sync code across profiles.

Support for Publishing Approval and Environment Lock

Advanced and Basic JavaScript extensions can be restricted from publishing to specific environments, which provides you with more control over the environments to which you deploy your sync changes.

GitHub Integration
Increase efficiency and code quality by using the GitHub integration with the Advanced JavaScript Code extension to publish code from an external repository into the utag.sync.js file.

How do I enable the feature?

To enable this feature, toggle on the Generate utag.sync.js File option in your Publish Configuration settings, as follows:

  1. Click Save/Publish.
  2. Click Configuration Publish Settings.
  3. From the General Publishing tab, scroll down to the Implementation section and toggle the Generate utag.sync.js File option to On.
  4. Click Save.
  5. Save and Publish your changes to the desired environments.

Additional Information

2 Kudos
Public