Cross-Domain Plugin

This plugin forces the visitor identifier to be used across domains in order to achieve cross-domain reporting. This allows the visitor to be represented as a single user no matter what domain they visited (assuming the plugin is used on both sites) This plugin adds either a query parameter or hash tag to the URL that is taking the visitor off the current site. The query parameter or hash contains the visitor identifier, and the new site will see the parameter and re-session the cookie in the new site to use the same visitor ID.

Plugin options

The plugin is loaded with the following properties available to be set via the configuration object:

Parameters Description Data Type Default Value

enable

Enable or disable the plugin 

Boolean

false

addHash

Flag to add a hash to the link that contains the sessionization data.

Boolean

true

addParam

Flag to add a query parameter to the link that contains the sessionization data. 

Boolean

false

autoSelect

Flag. If enabled, the tag will automatically decide, if it should use a hash or query parameter. If enabled, then addParam and addHash are ignored. If enabled, the tag will use hash by default but will switch to the query parameter, if the link has hash already.

Boolean

false

encode

Forces the sessionId to be base64 encoded 

Boolean

true

blockCollect

This option forces the Oracle CX Tag to wait until the plugin loads before data collection can begin.

Boolean

 

whiteListSelector

CSS selector to be used in determining what links to bind to. Standard CSS selectors can be used to target certain domains or links if desired. 

'whiteListSelector': 'A',

Whitelist sites selector white list all foo.com and bar.com links

'whiteListSelector': 'A[href*="foo.com"], A[href*="bar.com"]',

String

'A'

blackListSelector

If set to 'localhost' and onsite domains are defined on the tag config, the onsite list is used to form a blackList selector with all the domains listed, and 'A[href*="javascript:"]' is appended to the selector. If onsite domains are not defined, the selector is equivalent of ([href*="' + location.host + '/"],A[href*="javascript:"])' 'blackListSelector': 'localhost', 'blackListSelector': 'A[href*="google.com"], A[href*="facebook.com"]',

String

localhost

ignoreOnsiteDoms

Sets the plugin to not add the onsite-doms to the blacklist selector. 

Note: By default uses the _onsiteDoms setting from the CX Tag configuration, so you can specify what domains you consider locally.   By default it uses the domain the tag is loaded on.

Boolean

false

guard

Guard character to be added after the hash in case someone tries to add more data after the hash. Used to determine the end of the sessionId hash parameter. 

Note: This does not need to be changed. 

String

~

Learn more

Infinity Module Plugins