Configuration

 

Foreword

To facilitate integration of your tag, the Tag Composer application allows you to configure and download our SDK.

These configuration variables are listed in the tracker’s defaultConfiguration.xml file.

 

Editing the configuration

At any moment, you may change your tag’s configuration.

When creating a tracker:

 

Via use of the tracker’s SetConfig method:

Please note, the setConfig method is an asynchronous method. To ensure that the configuration was successfully applied, a callback indicating that the configuration was successfully applied is available.

1. Modification of a configuration key:
   
   C#

   tracker.SetConfig("identifier", "deviceId", this);

   1 2 3

   tracker.SetConfig("identifier", "deviceId", this);

   
   
   C#

   public void TrackerReady() { System.Diagnostics.Debug.WriteLine("config set"); }

   1 2 3 4 5 6

   public void TrackerReady() {      System.Diagnostics.Debug.WriteLine("config set"); }

   
   
   C#

   public sealed partial class MainPage : Page, TrackerReadyHandler

   1 2 3

   public sealed partial class MainPage : Page, TrackerReadyHandler

   
    
2. Replacement of certain configuration keys:
   

   Only keys passed as parameters will be modified or added to the existing configuration

   C#

   Dictionary<string, string> config = new Dictionary<string, string>() { {"site", "YOURSITEID" }, {"secure", "false" }, {"identifier", "winId" }, }; tracker.SetConfig(config, false, this);

   1 2 3 4 5 6 7 8 9

   Dictionary<string, string> config = new Dictionary<string, string>() {       {"site", "YOURSITEID" },       {"secure", "false" },       {"identifier", "winId" }, }; tracker.SetConfig(config, false, this);

    

3. Complete change of configuration:
   

   The existing keys will be deleted and replaced by the new keys passed as parameters

   C#

   Tracker specificTracker = SmartTag.Instance.Tracker("mySpecificTracker", new Dictionary<string, string>() { { "log","YOURLOG" }, { "logSSL","YOURSSLLOG" }, { "domain","YOURDOMAINLOG" }, { "site", "YOURSITEID" }, { "pixelPath","/hit.com" }, { "secure","false" }, { "identifier","winId" }, { "storage","required" }, { "hashUserId","false" }, { "campaignLastPersistence","false" }, { "campaignLifetime","30" }, { "sessionBackgroundDuration","10" } } ); specificTracker.SetConfig(config, true, this);

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

   Tracker specificTracker = SmartTag.Instance.Tracker("mySpecificTracker", new Dictionary<string, string>()     {         { "log","YOURLOG" },         { "logSSL","YOURSSLLOG" },         { "domain","YOURDOMAINLOG" },         { "site", "YOURSITEID" },         { "pixelPath","/hit.com" },         { "secure","false" },         { "identifier","winId" },         { "storage","required" },         { "hashUserId","false" },         { "campaignLastPersistence","false" },         { "campaignLifetime","30" },         { "sessionBackgroundDuration","10" }     } ); specificTracker.SetConfig(config, true, this);

    

 

Since 1.2.0 version, it’s possible to use helpers and constants to simplify configuration management.

1. Samples to use helpers
   
   C#

   // Log SmartTag.Instance.defaultTracker.SetLog("YOURLOG", this); // Secured log SmartTag.Instance.defaultTracker.SetSecuredLog("YOURSSLLOG", this); // Site id SmartTag.Instance.defaultTracker.SetSiteId(YOURSITEID, this);

   1 2 3 4 5 6 7 8 9 10

   // Log SmartTag.Instance.defaultTracker.SetLog("YOURLOG", this);   // Secured log SmartTag.Instance.defaultTracker.SetSecuredLog("YOURSSLLOG", this);   // Site id SmartTag.Instance.defaultTracker.SetSiteId(YOURSITEID, this);

   
    
2. Samples to use constants (all constants are available in TrackerConfigurationKeys class)
   
   C#

   // Log SmartTag.Instance.defaultTracker.SetConfig(TrackerConfigurationKeys.LOG, "YOURLOG", this); // Secured log SmartTag.Instance.defaultTracker.SetConfig(TrackerConfigurationKeys.LOG_SSL, "YOURSSLLOG", this); // Site id SmartTag.Instance.defaultTracker.SetConfig(TrackerConfigurationKeys.SITE, "YOURSITEID", this);

   1 2 3 4 5 6 7 8 9 10

   // Log SmartTag.Instance.defaultTracker.SetConfig(TrackerConfigurationKeys.LOG, "YOURLOG", this);   // Secured log SmartTag.Instance.defaultTracker.SetConfig(TrackerConfigurationKeys.LOG_SSL, "YOURSSLLOG", this);   // Site id SmartTag.Instance.defaultTracker.SetConfig(TrackerConfigurationKeys.SITE, "YOURSITEID", this);

 

List of variables

Name	Default value	Description
log	–	Sets the hit collect log
logSSL	–	Sets the secure hit collect log
domain	xiti.com	Sets the domain of the collect log
pixelPath	–	Sets the path of the transparent pixel
site	–	Sets the site ID
secure	false	Enables use of SSL mode
identifier	deviceId	Sets type of user ID (deviceId, guid)
storage	never	Sets mode of hit storage (required, never, always)
hashUserId	false	Enables hashing of user ID (sha256)
persistIdentifiedVisitor	true	Enables storage of identified user information (numerical or text)
campaignLifetime	30	Sets campaign lifetime (by default: 30 days)
campaignLastPersistence	false	Sets the mode of prior attribution (by default, subsequent actions will be attributed to the first campaign detected)
sessionBackgroundDuration	60	Sets the duration, in seconds, between two sessions after the app enters in background

Last update: 09/06/2017