Customizing the Adobe Analytics Framework customizing-the-adobe-analytics-framework

The Adobe Analytics framework determines the information that is tracked with Adobe Analytics. To customize the default framework, you use JavaScript to add custom tracking, integrate Adobe Analytics plugins, and change general settings within the framework used for tracking.

About the Generated JavaScript for Frameworks about-the-generated-javascript-for-frameworks

When a page is associated with an Adobe Analytics framework, and the page includes references to the Analytics module, a analytics.sitecatalyst.js file is automatically generated for the page.

The JavaScript in the page creates an s_giobject (that the s_code.js Adobe Analytics library defines) and assigns values to its properties. The name of the object instance is s. The code examples that are presented in this section makes several references to this s variable.

The following example code is similar to the code in an analytics.sitecatalyst.js file:

var s_account = "my_sitecatalyst_account";
var s = s_gi(s_account);
s.fpCookieDomainPeriods = "3";
s.currencyCode= 'USD';
s.trackInlineStats= true;
s.linkTrackVars= 'None';
s.charSet= 'UTF-8';
s.linkLeaveQueryString= false;
s.linkExternalFilters= '';
s.linkTrackEvents= 'None';
s.trackExternalLinks= true;
s.linkDownloadFileTypes= 'exe,zip,wav,mp3,mov,mpg,avi,wmv,doc,pdf,xls';
s.linkInternalFilters= 'javascript:,'+window.location.hostname;
s.trackDownloadLinks= true;

s.visitorNamespace = "mynamespace";
s.trackingServer = "xxxxxxx.net";
s.trackingServerSecure = "xxxxxxx.net";

/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
    //add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/

When you use custom JavaScript code to customize the framework, you alter the content of this file.

Configuring Adobe Analytics Properties configuring-adobe-analytics-properties

There are several predefined variables within Adobe Analytics that are configurable on a framework. The charset, cookieLifetime, currencyCode, and trackInlineStats variables are included in the General Analytics Settings list by default.

You can add variable names and values to the list. These predefined variables and any variables that you add are used to configure the properties of the s object in the analytics.sitecatalyst.js file. The following example shows how the added prop10 property of value CONSTANT is represented in the JavaScript code:

var s_account = "my_sitecatalyst_account";
var s = s_gi(s_account);
s.fpCookieDomainPeriods = "3";
s.currencyCode= 'USD';
s.trackInlineStats= true;
s.linkTrackVars= 'None';
s.charSet= 'UTF-8';
s.linkLeaveQueryString= false;
s.linkExternalFilters= '';
s.linkTrackEvents= 'None';
s.trackExternalLinks= true;
s.linkDownloadFileTypes= 'exe,zip,wav,mp3,mov,mpg,avi,wmv,doc,pdf,xls';
s.prop10= 'CONSTANT';
s.linkInternalFilters= 'javascript:,'+window.location.hostname;
s.trackDownloadLinks= true;

s.visitorNamespace = "mynamespace";
s.trackingServer = "xxxxxxx.net";
s.trackingServerSecure = "xxxxxxx.net";

Use the following procedure to add variables to the list:

Adding custom JavaScript to an Adobe Analytics Framework adding-custom-javascript-to-an-adobe-analytics-framework

The free-from JavaScript box in the General Analytics Settings area lets you add custom code to an Adobe Analytics framework.

The code that you add is appended to the analytics.sitecatalyst.js file. Therefore, you can access the s variable, which is an instance of the s_gi JavaScript object that is defined in s_code.js. For example, adding the following code is equivalent to adding a variable named prop10 of value CONSTANT, which is the example in the previous section:

s.prop10= 'CONSTANT';

The code in the analytics.sitecatalyst.js file (which includes the content of the Adobe Analytics s-code.js file) contains the following code:

if (s.usePlugins) s.doPlugins(s)

The following procedure demonstrates how to use the JavaScript box to customize Adobe Analytics tracking. If your JavaScript needs to use Adobe Analytics plugins, integrate them into AEM.

The following example concatenates the data captured on a page in hierarchical order, using a common separator of “|”.

An Adobe Analytics framework has the following configruations:

For example, the following values are generated in Adobe Analytics:

Adding Global Custom Code for All Adobe Analytics Frameworks adding-global-custom-code-for-all-adobe-analytics-frameworks

Provide custom JavaScript code that is integrated into all Adobe Analytics frameworks. When a page’s Adobe Analytics framework contains no custom free-form JavaScript, the JavaScript that the /libs/cq/analytics/components/sitecatalyst/config.js.jsp script generates is appended to the analytics.sitecatalyst.js file. By default, the script has no effect because it is commented out. The code also sets s.usePlugins to false:

/* Plugin Config */
/*
s.usePlugins=false;
function s_doPlugins(s) {
    //add your custom plugin code here
}
s.doPlugins=s_doPlugins;
*/

Code in the analytics.sitecatalyst.js file (which includes the content of the Adobe Analytics s_code.js file) contains the following code:

if (s.usePlugins) s.doPlugins(s)

Therefore, your JavaScript should set s.usePlugins to true so that any code in the s_doPlugins function is executed. To customize the code, overlay the config.js.jsp file with one that uses your own JavaScript. If your JavaScript needs to use Adobe Analytics plugins, integrate them into AEM.

Using Adobe Analytics Plugins in AEM using-adobe-analytics-plugins-in-aem

Obtain the JavaScript code for Adobe Analytics plugins and integrate them into your Adobe Analytics framework in AEM. Add the code to a client library folder of the category sitecatalyst.plugins so that they are available to your custom JavaScript code.

For example, if you integrate the getQueryParams plugin, you can call the plugin from the s_doPlugins function of your custom JavaScript. The following example code sends the query string in “pid” from the referrer’s URL as eVar1, when an Adobe Analytics call is triggered.

s.usePlugins=true;
function s_doPlugins(s) {
   // take the query string from the referrer
   s.eVar1=s.getQueryParam('pid','',document.referrer);
}
s.doPlugins=s_doPlugins;

AEM installs the following Adobe Analytics plugins, so that they are available by default:

The /libs/cq/analytics/clientlibs/sitecatalyst/plugins client library folder includes these plugins in the sitecatalyst.plugins category.

Use the following procedure to create the client library folder for your plugins. You only need to peform this procedure once. To add a plugin to the client library folder, use the subsequent procedure.

Use the following procedure to obtain the plugin code, store the code in the AEM repository, and add the code to your client library folder.