Configure the site to communicate with IBM Digital Analytics

Tag library setup and configuration for is controlled by the biConfig.xml file.

Task info

This file contains the following data about each web store:

• Which analytics provider is being used.

• Whether tracking is enabled. (Tracking refers to whether the data is sent to IBM Digital Analytics.)

• Whether debug mode is enabled. (The debug messages display on the web page where the tag is located, generally at the bottom of the page.)

• The location of any vendor-specific code required for tracking.

Procedure

1. Open the workspace_dir\crs-web\WebContent\WEB-INF\xml\config\bi\biConfig.xml file.

2. Update the store's reporting options. Find the following line:

   <store storeId="
   10001" biprovider="coremetrics" enabled="
   false" debug="
   false">

   1. Update the store ID parameter with the values appropriate for the stores for which we want to enable IBM Digital Analytics. The storeId supports the following definition styles:

      1. A single storeId

      2. A comma-separated list of storeIds. For example, specify storeId="10000, 10001" to enable IBM Digital Analytics for two stores that use the same IBM Digital Analytics clientId, and JavaScript libraries that are defined in the configuration.

      3. A range of storeIds. For example, specify storeId="10000-10200" to enable Coremetrics for all of the stores that have storeId values that fall within the range, which includes the specified upper and lower bounds. The stores specified in the range shares a IBM Digital Analytics clientId and the JavaScript libraries that are defined in the configuration.

   2. Update the enabled parameter to reflect whether we want analytics to be enabled. This parameter can be either true or false.

   3. Update the debug parameter to reflect whether we want the debug mode enabled. This parameter can be either true or false.

3. Update the store's IBM Digital Analytics client ID.

   1. Find the following line: <clientid> clientID</clientid>

   2. Update the clientID such that it matches the store's client ID as provided by IBM Digital Analytics.

4. Update the locations of the IBM Digital Analytics JavaScript files:

   Note: cmSetProduction() is replaced by cmSetClientID(). Consult the IBM Digital Analytics implementation guide for details.

   <script language="JavaScript1.1" type="text/JavaScript" src="
   /wcsstore/coremetrics/v40/eluminate.js"></script>
   <script language="JavaScript1.1" type="text/JavaScript" src="
   /wcsstore/coremetrics/cmdatatagutils.js"></script>
   <script language="JavaScript1.1" type="text/JavaScript">
   <!--
   //cmSetProduction();
   //-->

   Note: In IBM Digital Analytics implementations before September 2007 (using eluminate.js 4.1.1 or earlier), look for the following code:

   <script language="JavaScript1.1" type="text/JavaScript" src="
   /wcsstore/coremetrics/v40/eluminate.js"></script>
   <script language="JavaScript1.1" type="text/JavaScript" src="
   /wcsstore/coremetrics/v40/techprops.js"></script>
   <script language="JavaScript1.1" type="text/JavaScript" src="
   /wcsstore/coremetrics/cmdatatagutils.js"></script>
   <script language="JavaScript1.1" type="text/JavaScript">
   <!--
   //cmSetProduction();
   //-->

   IBM Digital Analytics requires that you identify the locations of the three JavaScript files that are highlighted in the code sample. You should update these paths to reflect your system. The files are not included by default; however, when you sign up with IBM Digital Analytics, the IBM Digital Analytics Implementation Service team will provide the location of the required JavaScript file and other additional JavaScript files, as needed. IBM Digital Analytics also requires that you call their main method, cmSetProduction().

   Important: The main method, cmSetProduction() is commented out because by default, the data goes to the IBM Digital Analytics test server; however, you need to uncomment the line when you complete testing, and are ready to send the data to the IBM Digital Analytics production server.

5. Restart test servers.

Next topic: Generating a file that captures the catalog hierarchy