TagManagement Module

Usage

The TagManagement module is a client-side implementation of the Universal Tag (utag.js) which uses a non-rendered WKWebView instance to execute JavaScript. This module is required in apps that make use of Tealium iQ Tag Management. It is automatically included in Carthage and CocoaPods framework builds.

Supported Platforms

• iOS

Requirements

• WebKit (WKWebView)

Install

Install the TagManagement module with Swift Package Manager, CocoaPods or Carthage.

Swift Package Manager (Recommended)

Supported in version 1.9.0+, the Swift Package Manager is the recommended and simplest way to install the Tealium Swift library:

1. In your Xcode project, select File > Swift Packages > Add Package Dependency
2. Enter the repository URL: https://github.com/tealium/tealium-swift
3. Configure the version rules. Typically, "Up to next major" is recommended. If the current Tealium Swift library version does not appears in the list, then reset your Swift package cache.
4. Select the TagManagement module from the list of modules to install and add it each of your app targets in your Xcode project, under Frameworks > Libraries & Embedded Content

CocoaPods

To install the TagManagement module with CocoaPods, add the following pod to your Podfile:

pod 'tealium-swift/TagManagement'

Learn more about the CocoaPods installation for iOS.

Carthage

To install the TagManagement module with Carthage, following these steps:

1. Go to the app target’s General configuration page in Xcode.

2. Add the following framework to the Embedded Binaries section:

   TealiumTagManagement.framework
   

Learn more about the Carthage installation for iOS.

Initialize

To initialize the module, verify that it’s specified on the TealiumConfig collectors property

config.dispatchers = [Dispatchers.TagManagement]

Customizing the WebView Settings

App Bound Domains

If your app uses the WKAppBoundDomains feature to limit which domains webviews in your app can communicate with, you must pass a custom WKWebViewConfiguration and set its limitsNavigationsToAppBoundDomains property to true. Failing to do this will result in all tracking calls being dropped by the operating system. You must also include “tags.tiqcdn.com” in your Info.plist’s WKAppBoundDomains list, as well as the domains for any tags you have set up in Tealium iQ (for example “google-analytics.com”). Be aware that a maximum of 10 domains can be configured for the entire app, so if you use multiple client-side tags, you may easily exceed this.

 let config = TealiumConfig(account: "ACCOUNT",
                               profile: "PROFILE",
                               environment: "ENVIRONMENT",
                               datasource: "DATASOURCE")
 config.dispatchers = [Dispatchers.TagManagement]
 let wkWebViewConfiguration = WKWebViewConfiguration()
 wkWebViewConfiguration.limitsNavigationsToAppBoundDomains = true
 config.webviewConfig = wkWebViewConfiguration
 tealium = Tealium(config: config)
        

Process Pool

If your app uses its own WKWebView, to avoid cookie synchronization issues, pass a singleton WKProcessPool instance to be used by the Tealium webview, or a custom WkWebViewConfiguration that’s shared with other webviews in your app.

Learn about webviewProcessPool and webViewConfig.

Data Layer

The following variables are transmitted with each tracking call:

About WKWebView

Prior to version 1.7.0, this module used UIWebView which is now deprecated in favor of WKWebView. The OS requires that WKWebView always be attached to a UIView, even if it is not rendered. If it is not attached to a UIView, the OS severely throttles the performance and the JavaScript executes suboptimally. To accommodate this the Tag Management module attempts to attach the non-rendered WKWebView to the root UIView of your app.

If your app has a complex view hierarchy and the module is not detecting the rootViewController, initialize TealiumConfig with a view to attach to in viewDidLoad, viewWillAppear:, or viewDidAppear:.

Release 1.7.1 significantly improves the auto-detection of views and removes the need to specify a view in most scenarios. But you must test this in your app to verify that tracking calls are sent correctly. See Release Notes for full details.

If your app jumps to a UIViewController upon receiving a push notification, and has a different view hierarchy than when Tealium was initialized, you must update the current UIView using the following API method.

override func viewDidLoad() {
    super.viewDidLoad()
    // this view does not have a navigation controller
    if self.navigationController == nil {
          // update the current root UIView on the Tealium instance
        tealium?.updateRootView(self.view)
    }
    // Do any additional setup after loading the view.
}

See the sample app Swift-WKWebView for a full example.

The shouldAddCookieObserver method allows you to use your own cookie observer during cookie synchronization, which requires a cookie observer to retrieve cookies on the main thread after setting them. This issue is caused by bugs in WKWebView, which prevents your own observer from being called.