Configuring the store to communicate with IBM Digital Analytics(biConfig.xml)

<store
    storeId = "10101"
    biprovider = "coremetrics"
    enabled = "true"
    debug = "true"
    marketingCenterEnabled="true"
    useHostedCMHLibraries = "true"
    useEmailForCustomerId = "false"
    segmentExportMode = "append">

If you configured any default values for an analytics provider, you can override any of these values by setting store-specific values. To use a default value again, remove the store-specific value.

clientId

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

enabled

Indicates whether tracking is enabled, which means that analytics data is 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.

instrumentation

Instrumentation code that is related to the integration between a store and the analytics provider. For example, code that includes JavaScript libraries or other related tasks specific for the store inside the element, as shown in the following example:

<instrumentation>
        <![CDATA[
           <script type="text/javascript">
            /* Instrumentation code if any */
           </script>
         ]]>
   </instrumentation>

You can define the default CDATA section within this attribute

marketingCenterEnabled

The enablement flag for integrating Management Center with IBM Marketing Center. For more information, see integration.

marketingCenterUrl

If you are integrating Management Center with IBM Marketing Center, you can include this element to override the default URL to IBM Marketing Center. For more information, see integration.

includeShipAdjustInProductPrice

The enablement flag that 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

If you are integrating with IBM Digital Data Exchange (DDX), you can include this element and the useDDX attribute with a value of "true" to enable the integration. For more information about this integration, see IBM Digital Data Exchange integration.

output

The JavaScript snippets, or any other content, that you want to write to a specific location in your store pages.

url

The URL for launching the analytics provider from Management Center.

useCookies

Indicates whether category information is stored in cookies. For more information, see Storing category information in cookies for analytics reporting.

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 an HCL 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 HCL Commerce member ID as the IBM Digital Analytics customer ID. This value is the default value.

Set this parameter to true only if your 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, by using the email address, you can correlate a customer that completes a product inquiry form on an external site to the same customer that registers with a HCL 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 tmtconfigsegbiconfig.html.

 <clientid>69999999</clientid>

• To launch reports from the IBM Digital Analytics test server, use your test client ID, which typically starts with the digit 6.
• To launch reports from the IBM Digital Analytics production environment, use your production client ID.

<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>

Notice that the line that contains your production client ID is commented out, whereas the line that contains your test client ID is not. This ID means that your analytics data is sent to the IBM Digital Analytics test server initially. When you are ready to send data to the production environment, you can comment out the line that contains your test client ID, remove the comments from the line that contains your production ID, and then switch the client ID you configured in step 5.a to your production client ID.

cmSetClientID("88888888|SiteID",true,"data.coremetrics.com","thesite.com");