Tracking Agent Configuration

Configuring Data Collection for Anonymous Users

CardioLog can identify anonymous users by logging their workstation IP address, or by creating a unique id and storing it in a browser cookie.

Using Unique Cookies

Pros - The most accurate method for identifying unique anonymous users, even when the visitor uses a proxy or VPN.

Cons - When a visitor deletes his cookies, the next visit will generate a new unique ID. When cookies are disabled, each visit generates a new unique ID. If a visitor uses multiple browsers, such as Internet Explorer and Firefox, a unique ID will be generated separately for each browser.

If you would like to use a unique ID for all anonymous users, configure the data collection by following these steps:

In [Installation directory]\CardioLogAgent\js\AgentEmbed.js, set the "SupportAnonymousUsers" parameter to "true":

In versions lower than 2.0.8.0:
In [Installation directory]\CardioLogAgent\AgentEmbed.aspx, set the "SupportAnonymousUsers" parameter to "true":

element.SupportAnonymousUsers = true;
In the file system, verify that the [Installation directory]\CardioLogAgent directory security allows access for anonymous users:
Right click on the [Installation directory]\CardioLogAgent directory, choose Properties > Security > Add > Add the ANONYMOUS LOGON user.
In IIS Manager, verify that the CardioLogAgent web application directory security allows Anonymous Access:
Click the CardioLogAgent web application in IIS, choose Authentication, enable Anonymous Authentication and disable Windows Authentication.
In [Installation directory]\CardioLogAgent\Web.config, set the "overwriteConnectedUser" parameter to "true":
<add key="overwriteConnectedUser" value="true" />

Note: By default, the user name will be a unique ID logged in the format "Anonymous_XXXX"

[Installation directory] - by default, the CardioLogAgent folder is located in the CardioLog Installation folder. If the CardioLog Analytics SharePoint feature is installed, the CardioLogAgent folder is located on all SharePoint WFEs (Web Front Ends) under the SharePoint website "_layouts" folder.

Using IP Addresses

Pros - Enables individual IP address reporting, and works even when browser cookies are disabled.

Cons - When using a proxy or VPN in order to access the internal network (Intranet portal), the CardioLog tracking agent will not be able to obtain the client workstation IP, and the registered IP will instead be recorded as the proxy IP. In this case the unique users metric is inaccurate.

Note: CardioLog always collects the workstation IP for reporting geographic location.

Perform the following steps in order to configure data collection for anonymous users, using the workstation IP address:

Follow the steps above for configuring data collection for anonymous users, using a unique ID cookie.
Edit the [CardioLog Installation Folder]\EventCollector\web.config file and set the value of the "UseIPAddressForAnonymousUserName" key to "true" like so:

<add key="UseIPAddressForAnonymousUserName" value="true" />

Monitoring Authenticated Users in an Anonymous Environment After They Sign In

CardioLog can identify authenticated users in an anonymous environment by retrieving their user name from SharePoint or using manual configuration.

Retrieving the SharePoint Signed-In User

CardioLog can identify authenticated users in an anonymous environment by retrieving the signed in user ID from SharePoint.

In order to extend the tracking code to retrieve the user ID from SharePoint:

Configure the tracking agent for anonymous users.
Edit the following key in the [Installation directory]\CardioLogAgent\web.config file under the <appSettings> section:
<add key="UseSPAuth" value="true"/>

In versions earlier than 2.0.8.0:

Configure the tracking agent for anonymous users.
Add the following key to the [Installation directory]\CardioLogAgent\web.config file under the <appSettings> section:
<add key="GetUserNameCustom" value=" function GetUsername() { __trace("GetUsername"); var currentUsername = __readCookie("_userid"); var currentUserId = __readCookie("spUserid"); if (typeof(_spPageContextInfo) != "undefined") { if (!currentUserId || currentUserId != _spPageContextInfo.userId) { currentUsername = null; __saveCookie("spUserid", _spPageContextInfo.userId, 1000, element.CookieDomain); } } var useridInput = this.document.getElementById("userid"); if (useridInput && useridInput.value != "") { currentUsername = useridInput.value; } else if (currentUsername == null || currentUsername == "") { if (typeof (getSPUserAccount) != "undefined") { currentUsername = getSPUserAccount(); } else { currentUsername = "Anonymous_"+Math.random()*100000; } } __saveCookie("_userid", currentUsername, 1000, element.CookieDomain); __trace("GetUsername return: "+currentUsername); return currentUsername; }"/>
Add the following code to the [Installation directory]\CardioLogAgent\SP20XX_1.2.js file (Where XX is 10 for SharePoint 2010; 13 for SharePoint 2013), OR if you are using MOSS 2007, the [Installation directory]\CardioLogAgent\MOSS2007_1.2.js file.
[Installation directory] - By default, the CardioLogAgent folder is located in the CardioLog Installation folder. If the CardioLog Analytics SharePoint feature is installed, the CardioLogAgent folder is located on all SharePoint WFEs under the SharePoint website "_layouts" folder.
Append the following code to the end of the file:

function normalizeSPUserAccount(userName) {
// return userName;
var splitedTokens = userName.split("|");
return splitedTokens[splitedTokens.length - 1].replace(" ", "");
}

//this function is used to retrieve user account for sharepoint online
function getSPUserAccount() {
var _current_user_name = "Anonymous_" + Math.random() * 100000;
var url = window.location.protocol + "//" + window.location.host;

if (typeof _spPageContextInfo !== "undefined") { //2010,2013,Online
url += _spPageContextInfo.webServerRelativeUrl;
}
else if (L_Menu_BaseUrl) { //2007
url += L_Menu_BaseUrl == "" ? "/" : L_Menu_BaseUrl;
}
url += "/_layouts/userdisp.aspx?Force=True&d=" + new Date().getTime();

var xmlhttp;
if (window.XMLHttpRequest) { // code for IE7+, Firefox, Chrome, Opera, Safari
xmlhttp = new XMLHttpRequest();
} else { // code for IE6, IE5
xmlhttp = new ActiveXObject("Microsoft.XMLHTTP");
}
xmlhttp.open("GET", url, false);
xmlhttp.send(null);
if (xmlhttp.statusText == "OK") {
try {
if (!(typeof __Page === 'undefined'))
var spenv = __Page.agent;
var strToSearch = '<td valign="top" class="ms-formbody" width="350px" id="SPFieldText">'; //2013,online
if (!(typeof spenv === 'undefined')) {
if (spenv.indexOf("2010") != -1)
strToSearch = '<td valign="top" class="ms-formbody" width="450px" id="SPFieldText">';
else if (spenv.indexOf("2007") != -1)
strToSearch = '<TD valign="top" class="ms-formbody" width="450px" ID="SPFieldText">';
}
var pos = xmlhttp.responseText.indexOf(strToSearch);
if (pos >= 0) {
var dispnamePropertiesHtml = xmlhttp.responseText.substring(xmlhttp.responseText.indexOf(strToSearch) + strToSearch.length, xmlhttp.responseText.length);
dispnamePropertiesHtml = dispnamePropertiesHtml.toLowerCase();
dispnamePropertiesHtml = dispnamePropertiesHtml.substring(0, dispnamePropertiesHtml.indexOf('</td>') - 5);
dispnamePropertiesHtml = dispnamePropertiesHtml.substring(dispnamePropertiesHtml.indexOf('-->') + 3, dispnamePropertiesHtml.length);
_current_user_name = normalizeSPUserAccount(dispnamePropertiesHtml.trim());
}
} catch (ex) {
__trace(ex.message);
}
}
if (!_current_user_name || _current_user_name == "") {
_current_user_name = "Anonymous_" + Math.random() * 100000;
}
return _current_user_name;
}

Retrieving the User ID Using Manual Configuration

CardioLog can identify authenticated users in an anonymous environment by retrieving the user name manually from a unique element value that is hidden in the client side code.

In order to extend the tracking code to retreive the user ID manually:

Configure the tracking agent for anonymous users.
Pass the user's account name through SharePoint's server side code to a hidden element called "userid" in the client side code, like so:

<input type="hidden" id="userid" name= "userid" value="DOMAIN\useraccountname">

For example, you can retrieve the user name from the _spUserId JavaScript global variable in SharePoint.

To verify this variable exists in your SharePoint pages, browse to a SharePoint page and enter javascript:alert(_spUserId) in the browser address bar. Verify that you see a popup with a valid ID number.

Configuring the Tracking Agent with SSL

The CardioLog tracking agent can be easily configured to work with SSL.

Upon activating CardioLog, the Configuration Wizard will be displayed. This wizard will help you configure the Tracking Agent, a tool designed to monitor visitor behavior in SharePoint.

In order to configure the tracking agent to work with SSL, perform the following steps:

In IIS Manager, configure your CardioLog web site to enable both http and https calls, by setting an SSL port and adding a server certificate.
In Step 2 of the Configuration Wizard, click Show Advanced Settings and check Require secure channel (SSL)

Alternatively, do one of the following instead, in order to avoid a possible authentication prompt, or browser security messages when working with SSL:

In Step 2 of the Configuration Wizard, install the CardioLog Analytics SharePoint feature.
Skip Step 2 of the Configuration Wizard and manually install the Tracking Agent web application on the SharePoint machine. The following steps will need to be performed on every WFE:

Create a CardioLogAgent folder under the SharePoint _layouts folder:

"_layouts" folder location on MOSS 2007:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\LAYOUTS\

"_layouts" folder location on SharePoint 2010 and SharePoint 2013:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\
Copy the installation files into the new folder from [CardioLog Installation Folder]\CardioLogAgent\.
Open IIS Manager on your SharePoint machine, create a new virtual directory named CardioLogAgent under the SharePoint website "_layouts" folder, which should point to the copied CardioLogAgent folder.
Set the following properties for the new virtual directory: ASP.NET 2.0, Integrated Windows Authentication. Verify that you can browse to https://sharepointportal/_layouts/CardioLogAgent/AgentEmbed.aspx
Open the copied CardioLogAgent directory, open the web.config file and edit the following keys, located in the <appSettings> section:
<add key="CardioLogAgentRoot" value="/_layouts"/>
Edit the Java Script tracking code to change the Tracking Agent location according to the relevant software version you have installed:
By default, the Java Script tracking code is embedded within a common Java Script file on your SharePoint WFEs -

For MOSS 2007 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\LAYOUTS\1033\core.js

For SharePoint 2010 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\1033\init.js

For SharePoint 2013 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\LAYOUTS\init.js

The code is located at the end of the file, between these comments: "//Intlock tracking code start" and "//Intlock tracking code end".
ca.src='/_layouts/CardioLogAgent/ca.aspx?_random='+Math.random();

tt.src='/_layouts/CardioLogAgent/AgentEmbed.aspx?env=[SharePoint version]&r='+Math.random()*100000;
[SharePoint version]: MOSS2007, SP2010 or SP2013

Verify event collection. Click Ctrl+F12 or the "Agent Console" bookmark and wait for several seconds. Verify that you see the tracking agent console. To add the "Agent Console" bookmark to your browser, follow the instructions in http://cardiolog_server_name:port/CardioLog/Configuration/AgentConsoleBookmarklet.aspx (Enter your CardioLog server name and port number).

Configuring Timeouts for the Tracking Agent

Setting a Timeout for Tracking Usage Data

The tracking agent web application passes on usage information via HTTP/S web requests to the EventCollector web application, which then writes the data into the CardioLog database.

To configure the timeout settings for the Tracking Agent when the EventCollector web application is not available, edit the following keys in [Installation directory]\CardioLogAgent\Web.config file (time values are in milliseconds):

<!-- Timeout in case the EventCollector web application is not available (the default is 10 seconds).->

<add key="requestTimeOut" value="10000" />


<add key="serverResponseTimeOut" value="60000" />

[Installation directory] - By default, the CardioLogAgent folder is located in the CardioLog Installation folder. If the CardioLog Analytics SharePoint feature is installed, the CardioLogAgent folder is located on all SharePoint WFEs under the SharePoint website "_layouts" folder.

Setting a Timeout for Content Personalization

Information about visitor segments is downloaded to the client's browser with each page request. The JavaScript code briefly hides the content of the page, adds or modifies page elements, and then re-displays the page according to the relevant visitor segment(s). In order to personalize the page content, the default timeout for loading the visitor segments information is 5 seconds.

To configure the timeout setting in case of a connection error, edit the following key in the JavaScript tracking code (Time value is in milliseconds):

var iignoreca = setTimeout(ignoreca, 5000);

By default, the Java Script tracking code is embedded within a common Java Script file on your SharePoint WFEs according to the relevant software version you have installed:

For MOSS 2007 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\LAYOUTS\1033\core.js

For SharePoint 2010 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\1033\init.js

For SharePoint 2013 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\TEMPLATE\LAYOUTS\init.js

If the CardioLog Analytics SharePoint feature is installed, the Java Script tracking code is embedded within a Java Script file on your SharePoint WFEs according to the version you currently have installed:

For MOSS 2007 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\LAYOUTS\CardioLogAgent\CardioLogAgent.js

For SharePoint 2010 and SharePoint 2013 only:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\CardioLogAgent\CardioLogAgent.js

Configuring Session Idle Time

Visits (Sessions) are defined as the activity of one visitor within a single browser session. If a user is inactive on your site for 30 minutes or more, any future activity will be attributed to a new session. Users that leave your site and return within 30 minutes will be counted as part of the original session.
To set the maximum idle time after which the session id is reset, edit the following key in [Installation directory]\CardioLogAgent\js\AgentEmbed.js file (Time value is in minutes):

element.SessionTimer = 30; // Renew session (in minutes)

[Installation directory] - by default, the CardioLogAgent folder is located in the CardioLog Installation folder. If the "CardioLog Analytics" SharePoint feature is installed, the CardioLogAgent folder is located on all SharePoint WFEs under the SharePoint website "_layouts" folder.

Capturing Time on Site for Single-Page Visits

Time on site is calculated by adding up the time a visitor spends on a page, for every page in a session, including the last page in the session.
To learn more see Capturing Time on Site for Single-Page Visits.

Fire "Pulse" Events Every Few Seconds for Continual Recording

By default, CardioLog Analytics JavaScript tracking code fires "pulse" events every few seconds, until the visitor leaves the page either by navigating away from it or by closing the browser.
These "pulse" events are then processed by the reporting engine to calculate the overall amount of time a visitor spends on a page in a more accurate way, including single-page and last-page visits.

To configure the pulse event time intervals, edit the following keys in [CardioLog Installation directory]\EventCollector\web.config file: (Time values are in milliseconds)

<add key="PingInterval" value="3000" />


<add key="PingIntervalAscendTime" value="30000" />


<add key="PingIntervalMax" value="30000" />

Note: Finding the optimal ping configuration to reduce traffic to the CardioLog server, and still get accurate visit duration reports, depends on a few factors, but primarily the amount of traffic and common user behavior on the portal should be considered.

PingInterval - We recommend a value of 5 seconds as a reasonable "bounce" value, when considering the time it takes to fully load a designated page.

PingIntervalAscendTime - We recommend a value between 5 and 10 seconds.

PingIntervalMax - If the portal is a work tool for your end users, and they usually spend more than a minute on it, you can change this value to 60 seconds.

Measure Time Between Visits to Different Pages

CardioLog Analytics can calculate time on site by measuring the time between visits to different pages on your site. For example, if a user visits Page A at 4:15 PM. and then Page B at 4:20 PM, the time spent on Page A will be reported as five minutes. A "duration" event will be sent only when the visitor leaves the page and goes to another page, in order to reduce traffic to the CardioLog server.

If a user only visits a single page, it may not be possible to determine the length of time the visitor spent on the site. An action has to occur to trigger the JavaScript tracking code and the most common is a click to navigate to another page.

To measure time on site using duration events, and to disable pulse events, edit the following key in [Installation directory]\CardioLogAgent\js\AgentEmbed.js file:

element.Ping = false;