Sample biConfig.xml file for IBM Digital Analytics

Sample biConfig.xml file for IBM Digital Analytics

The following biConfig.xml sample file represents the default version included with .
The default sample biConfig.xml file that WebSphere Commerce provides is in the following directory:
workspace_dir\crs-web\WebContent\WEB-INF\xml\config\bi
Your updated biConfig.xml file must be deployed to the following directory so that IBM Digital Analytics can reference it: workspace_dir\WC\xml\config\bi

(Developer) When we are updating the biConfig.xml file in your development environment, we can use a reload file to help you quickly test configuration changes. By using this reload file, you do not need to continually restart your server to apply configuration changes from the biConfig.xml file.
For more information about configuring the settings for the biConfig.xml file for use with IBM Digital Analytics, see Configure the store to communicate with IBM Digital Analytics(biConfig.xml). The following sample file includes the elements and attribute in the biConfig.xml file that we can update with the site-specific information. The values in bold are sample values, which we must replace with values specific for the store or site.
<?xml version="1.0" encoding="UTF-8"?>


<BIConfiguration>
 1   <ssoKey></ssoKey>
 2   <biproviders>
 3     <biprovider name="coremetrics">
      <options><attribute name="useDDX" value="false"/></options>
      <header>
        <![CDATA[<script type="text/JavaScript">
        
        </script>]]>
      </footer>
    </biprovider>
  </biproviders>
  
 4   <stores>
 5     <store storeId="10101" 
      biprovider="coremetrics" enabled="true" debug="true" 
      marketingCenterEnabled="true"
      useHostedCMHLibraries="true" useEmailForCustomerId="false" 
      segmentExportMode="append" >
      <useCookies>true</useCookies>
      <clientid>69999999</clientid>
      <url>https://welcome.coremetrics.com/analyticswebapp/analytics.jsp</url>
      <marketingCenterUrl>https://mc.coremetrics.com/mcwebapp/welcome.do</marketingCenterUrl>
      <includeShipAdjustInProductPrice>true</includeShipAdjustInProductPrice>
      <options><attribute name="useDDX" value="false"/></options>
      <output section="header">
        <![CDATA[
        <script type="text/javascript" src="//libs.coremetrics.com/eluminate.js"></script> 
        <script type="text/javascript"> 
        cmSetupNormalization("krypto-_-krypto");
        
        // send data to production system 
        //cmSetClientID("99999999",true,"data.coremetrics.com","thesite.com"); 
        
        // send data to test system 
        cmSetClientID("69999999",false,"testdata.coremetrics.com","thesite.com"); 
        </script> 				
        ]]>
      </output>
    </store>
  </stores>
</BIConfiguration>   
Where
1 Identifies a secret key for single sign-on to your analytics provider for Management Center users. Single sign-on is enabled only for an integration between IBM Digital Analytics and Management Center.
2 Begins the analytics provider configuration section. Within this element, we can include multiple <biprovider> element. Each <biprovider> element, includes the configuration settings for an individual analytics provider. 3 Includes the configuration settings for a specific analytics provider. In this sample file, a single <biprovider> element is included to configure the settings for an integration with IBM Digital Analytics. The <biprovider> element can include the following elements and attributes:

name

The name of the analytics provider. The value coremetrics identifies the analytics provider as IBM Digital Analytics.

options

This element and the useDDX attribute name indicates the store that is integrated with IBM Digital Data Exchange (DDX).

header

This element includes any common JavaScript functions or statements that must be placed on store pages along with the tagging functions.

footer

This element includes any common JavaScript functions or statements that must be placed on store pages along with the tagging functions.

Within the <biprovider> element, default values can be set for each configuration setting. These values apply to every store associated with the identified analytics provider. See Configure default values for an analytics provider.
4 Begins the store level configuration section. Within this element, we can include multiple <store> elements. Each <store> element, can include the configuration settings for one or more stores. 5 Includes the configuration settings for one or more stores. In this sample file, a <store> element is included to configures the settings for a store to use IBM Digital Analytics as the analytics provider for each store. The <store> element can include the following elements and attributes:

storeId

The storeId of the store or stores to enable for the configured analytics provider, such as IBM Digital Analytics. Store ID values can be set in the following formats:

A single storeId value.
A comma-separated list of storeId values. For example, storeId="10000, 10001" enables IBM Digital Analytics for two stores using the same IBM Digital Analytics client ID and tag library that is defined in the configuration.
A range of storeId values. For example, storeId="10000-10200" enables IBM Digital Analytics for all of the stores that have storeId values that fall within the range that include the specified upper and lower bounds. The stores specified in the range must share the IBM Digital Analytics client ID and tag library that is defined in the configuration.

biprovider

The analytics provider. The value coremetrics identifies the analytics provider as IBM Digital Analytics.

enabled

Indicates whether tracking is enabled, which means that analytics data is tracked and sent to IBM Digital Analytics. Values are true or false.

debug

Indicates 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. Values are true or false.

marketingCenterEnabled

The enablement flag for integrating Management Center with .

useHostedCMHLibraries

Indicates whether the store uses the standard IBM Digital Analytics library. Values are true for the standard IBM Digital Analytics library or false for the custom IBM Digital Analytics library. Leave this value set to true.

useEmailForCustomerId

Indicates whether to use an email address instead of a WebSphere Commerce member ID to identify customers in IBM Digital Analytics Valid values are:

true

Use the customer's email address as the IBM Digital Analytics customer ID.

false

Use the WebSphere Commerce member ID as the IBM Digital Analytics customer ID. This value is the default value.

When the value is true, a store requires customers to provide their email address when they register and when they place an order as a guest shopper. Using the customer's email address as the customer ID is useful if only the email address can be collected consistently when customers set up a new account, sign up to receive a newsletter, or complete some other identifying form. For example, using the email address, we can correlate a customer that completes a product inquiry form on an external site to the same customer that registers with a WebSphere Commerce store. Using the email address can also help you to track multiple orders that are placed by the same guest shopper. When a customer places an order, a guest shopper is assigned a different unique member ID each time; however, the guest shopper's email address is likely to stay the same.
The customer ID parameter is passed to IBM Digital Analytics in the cmCreateRegistrationTag data tag (which is generated by the <cm:registration /> tag), and in the cmCreateShopAction9 and cmCreateOrderTag data tag (which are both generated by the <cm:order /> tag).

segmentExportMode

Indicates the export mode to use when you update IBM Digital Analytics based customer segments. See ../tasks/tmtconfigsegbiconfig.htm.

useCookies

Indicates whether category information is stored in cookies. See Storing category information in cookies for analytics reporting.

clientid

The analytics provider client ID for the store, as provided by the analytics provider.

url

The URL for launching the analytics provider from Management Center.

marketingCenterUrl

If Management Center is integrated with IBM Marketing Center, this element can be used to override the default URL to .

includeShipAdjustInProductPrice

This flag controls whether shipping adjustments are applied to the product prices in an order or to the shipping charge when order data is sent to IBM Digital Analytics. This setting does not affect the order details that a shopper views when they are submitting or reviewing an order.

true

The default value. Shipping adjustments are applied to the products in an order instead of being applied to the shipping charge when order data is sent to IBM Digital Analytics. For example, a product costs $40 with a shipping charge of $10. If a promotion that offers a $5 discount on shipping is applied, the order total is $45. When the includeShipAdjustInProductPrice flag is set to true, the order and shopping cart tags send the order data to IBM Digital Analytics. The information that is sent indicates that the order total was $45, the product price $35, not $40, and the shipping charge $10, not $5.

false

Shipping adjustments are applied to the shipping charge when data is sent to IBM Digital Analytics. For example, if the includeShipAdjustInProductPrice flag is false in the previous scenario, the information that the order and shopping cart tags send to IBM Digital Analytics indicates that the order total was $45, the product price $40 and the shipping charge was $5.

options

This element and the useDDX attribute with a value of "true" indicates that the store is integrated with IBM Digital Data Exchange (DDX).

output

This element configures the JavaScript snippets, or any other content, to write to a specific location in the store pages to track and send analytics data. Update the cmSetClientID function settings in the element to set the following values. There is one cmSetClientID setting for configuring the client ID for our production system and the other for our test system.

Client ID

The client ID that is provided by your analytics provider, such as IBM Digital Analytics. In this sample file, the value is "99999999".

Data collection method

The data collection method. We can set one of the following values:

true

The data collection is managed by the analytics provider, such as IBM Digital Analytics.

false

The data collection is managed by your client.

Analytics provider domain name

The domain name for our analytics provider. In this sample, the value is "data.coremetrics.com" for IBM Digital Analytics.

WebSphere Commerce server

The domain name of the WebSphere Commerce server. In this sample file, the value is "thesite.com".

Related tasks
Defining the output tag in the analytics configuration file (biConfig.xml)
Configure the secret key for single sign-on in the analytics configuration file (biConfig.xml)