Home
Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
Integrating
Topics in the Integrating category highlight the tasks that are commonly performed for using HCL Commerce in combination with other products.
Analytics for HCL Commerce
HCL Commerce provides a framework that you can configure to integrate your store with an external Web analytics solution. This framework includes a tag library that you can use in store page JSP files to provide appropriate analytics information to the external analytics system.
Integrating a store with IBM Digital Analytics for HCL Commerce
HCL Commerce provides a framework and tools to simplify the process of setting up your site to use . IBM Digital Analytics is an industry leading hosted web analytics solution. The framework is implemented as a tag library designed to act as an intermediary layer between HCL Commerce and IBM Digital Analytics. The tools include an auto tagging utility to place analytics tags in your store pages. The tools also include a utility to generate a file that contains your catalog hierarchy for IBM Digital Analytics. This solution can significantly reduce the time that is required to deploy web analytics
Digital Analytics integration with Web 2.0 starter stores
The HCL Commerce Web 2.0 starter stores use Rich Internet Application (RIA) technologies such as Ajax (Asynchronous JavaScript and XML) and Dojo widgets. With these technologies certain customer interactions with store page content do not result in a full page refresh. provides a framework to track these page interactions, in addition to interactions that result in a full-page refresh. This framework ensures that IBM Digital Analytics collects accurate analytics data about how customers are using your Web 2.0 store.
IBM Digital Analytics events
The event listener for is a JavaScript object that is incorporated into the store JSP file. The IBM Digital Analytics event listener detects IBM Digital Analytics events and calls the appropriate IBM Digital Analytics tag functions. The tag functions forward the analytics data to IBM Digital Analytics.
IBM Digital Analytics page view event
When the event listener for detects a IBM Digital Analytics page view event, the event listener calls the IBM Digital Analytics cmCreatePageviewTag function.

Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
- Getting started
  HCL Commerce has different advantages for business users, administrators and developers. HCL Commerce targets each of these roles with a tailored set of offerings so that each of your users can get maximum benefit.
- Installing and deploying
  Learn how to install and deploy HCL Commerce development environments and HCL Commerce production environments.
- Migrating
  Before you migrate to HCL Commerce Version 9.1, review this information to help plan and execute your migration.
- Operating
  Topics in the Operating category highlight tasks that are typically performed by business users, customer support representatives, to complete their day-to-day tasks in the operation of the HCL Commerce site.
- Integrating
  Topics in the Integrating category highlight the tasks that are commonly performed for using HCL Commerce in combination with other products.
  - Order management system integration
    Integrate a distributed order management (DOM) system with your store to provide comprehensive coverage of the order lifecycle across channels, from capture to fulfillment.
  - Sterling Order Management integration
    The integration between HCL Commerce and Sterling Order Management combines the industry-leading front-end capabilities of HCL Commerce with the proven, back-end order and inventory management features of Sterling Order Management.
  - Inventory Management system integration
    Integrate an inventory management system with your store to ensure that inventory availability is constantly updated to reflect your store's current inventory levels.
  - Payments system integration
    Integrate a payments system with your store to process shopper payments for your site. You can also integrate with pricing and tax service providers to manage the pricing and tax calculations for your store.
  - Tax system integration
    You can integrate HCL Commerce with a third-party tax calculation system to provide tax calculations for your store. Integrating with a third-party tax service provider can help you to build and maintain a highly secure e-commerce site with a worldwide tax calculation process. Use the available HCL Commerce tax integration extension points to create any extensions that you need for integrating with your third-party tax calculation system. The tax integration xC extensions are a set of task commands that are called by the order component to communicate with the third-party tax calculation system when the tax integration feature is enabled.
  - Integrating with back-end systems and external applications
    External systems integration is a key feature of the HCL Commerce solution. In HCL Commerce business logic is enabled for integration and built-in adapters and interfaces are provided for common integration points. Additionally, the HCL Commerce integration solution leverages integration standards by using various IBM connectivity solutions.
  - IBM Watson Campaign Automation integration
    You can integrate IBM Watson Campaign Automation with HCL Commerce so that transactional emails are sent by IBM Watson Campaign Automation.
  - IBM MQ
    HCL Commerce provides a listener for IBM MQ for inbound requests, and an adapter for IBM MQ for outbound requests, to integrate back-end, and external systems with HCL Commerce.
  - Content management integration
    You can integrate HCL Commerce with an external content management system through a punch-out window from Management Center and through the web feed utility. You can integrate HCL Commerce with IBM Web Content Manager to provide Management Center users the ability to associate IBM Web Content Manager content with HCL Commerce objects.
  - Analytics for HCL Commerce
    HCL Commerce provides a framework that you can configure to integrate your store with an external Web analytics solution. This framework includes a tag library that you can use in store page JSP files to provide appropriate analytics information to the external analytics system.
    - Analytics tag library for HCL Commerce
      The basis for the HCL Commerce analytics framework is a JSP-based tag library. By adding HCL Commerce analytics tags to your store pages, you can communicate information about site usage to an external analytics system.
    - Integrating a store with IBM Digital Analytics for HCL Commerce
      HCL Commerce provides a framework and tools to simplify the process of setting up your site to use . IBM Digital Analytics is an industry leading hosted web analytics solution. The framework is implemented as a tag library designed to act as an intermediary layer between HCL Commerce and IBM Digital Analytics. The tools include an auto tagging utility to place analytics tags in your store pages. The tools also include a utility to generate a file that contains your catalog hierarchy for IBM Digital Analytics. This solution can significantly reduce the time that is required to deploy web analytics
      - IBM Digital Analytics JavaScript library types: standard and custom
        There are two different JavaScript libraries for : the standard IBM Digital Analytics library and the custom IBM Digital Analytics library. It is important to understand which type your site is using because the implementation details differ.
      - CDFGenerator utility
        For proper product and content classification, requires a Category Definition File (CDF). When you run the CDFGenerator utility, it generates a CSV file in the IBM Digital Analytics defined CDF format. The CDFGenerator is the command-line utility that generates the product data as a CSV file.
      - Auto tagging utility
        The Auto tagging utility automates the process of tagging the store JSP files with analytics tags. This utility makes tagging the site much easier and also reduces the implementation time. With this utility, the JSP files are only tagged with the tag named pageview and not any other tag. This utility scans the HCL Commerce web pages and adds the tags. The utility also creates backup copies of the JSP files that it updates to facilitate removing the changes.
      - Sample biConfig.xml file for IBM Digital Analytics
        The following biConfig.xml sample file represents the default version included with .
      - Storing category information in cookies for analytics reporting
        You can configure your site to store category information in cookies to pass to an analytics provider. The configuration steps involve adding a <useCookies> element to your biConfig.xml configuration file, and adding a <cm:setCategoryCookie/> tag to certain store pages.
      - Configuring single sign-on between Management Center and IBM Digital Analytics
        Make the integration between Management Center and seamless for business users by configuring single sign-on. When single sign-on is in place, business users do not need to log on to IBM Digital Analytics separately when they launch the IBM Digital Analytics dashboard or view IBM Digital Analytics reports from Management Center.
      - Using the output tag to configure the placement of IBM Digital Analytics JavaScript snippets
        In store JSP pages, the output tag (<cm:output/>) acts as a marker for the location to write JavaScript snippets for each time the page is rendered.
      - Creating self-signed certificates for testing IBM Digital Analytics for HCL Commerce
        Use a self-signed or third-party certificate for testing in a staging or test environment.
      - Digital Analytics integration with Web 2.0 starter stores
        The HCL Commerce Web 2.0 starter stores use Rich Internet Application (RIA) technologies such as Ajax (Asynchronous JavaScript and XML) and Dojo widgets. With these technologies certain customer interactions with store page content do not result in a full page refresh. provides a framework to track these page interactions, in addition to interactions that result in a full-page refresh. This framework ensures that IBM Digital Analytics collects accurate analytics data about how customers are using your Web 2.0 store.
        List of analytics tags in starter store pages
        The Aurora starter store is already tagged with the full set of HCL Commerce analytics tags so that you do not have to add the tags yourself. By understanding which pages include tags by default, you can plan the implementation of additional tagging more effectively.
        Customer interactions that trigger IBM Digital Analytics events in Web 2.0 starter stores
        In Web 2.0 starter stores, customers can interact with page content that does not result in a full page refresh. For example, a customer can drag products into their mini shopping cart, or their wish list, or use the Product Fast Finder to narrow down search results. For these page interactions, HCL Commerce starter store pages generate events to provide analytics data to .
        IBM Digital Analytics events
        The event listener for is a JavaScript object that is incorporated into the store JSP file. The IBM Digital Analytics event listener detects IBM Digital Analytics events and calls the appropriate IBM Digital Analytics tag functions. The tag functions forward the analytics data to IBM Digital Analytics.
        IBM Digital Analytics page view event
        When the event listener for detects a IBM Digital Analytics page view event, the event listener calls the IBM Digital Analytics cmCreatePageviewTag function.
        IBM Digital Analytics product view event
        When the event listener for detects a IBM Digital Analytics product view event, the event listener calls the IBM Digital Analytics cmCreateProductviewTag function.
        IBM Digital Analytics cart view event
        When the event listener for detects a IBM Digital Analytics cart view event, the event listener calls the IBM Digital Analytics cmCreateShopAction5Tag function.
        IBM Digital Analytics registration view event
        When the event listener for , detects a IBM Digital Analytics registration view event, the event listener calls the IBM Digital Analytics cmCreateRegistrationTag function.
        IBM Digital Analytics element event
        When the event listener for detects a IBM Digital Analytics element event, the event listener calls the IBM Digital Analytics cmCreateElementTag function.
        IBM Digital Analytics conversion event
        When the event listener for , detects a IBM Digital Analytics conversion event, the event listener calls the IBM Digital Analytics cmCreateConversionEventTag function.
        Customizing IBM Digital Analytics events for Web 2.0 starter stores
        You can customize events for for Web 2.0 starter stores in three different ways.
      - IBM Digital Analytics reports for HCL Commerce
        offers a set of five analytics reports designed specifically for HCL Commerce. The reports display marketing metrics that are gathered from your site by the HCL Commerce analytics tags. These reports are available to HCL Commerce sites that are integrated with IBM Digital Analytics. You can view the reports in the IBM Digital Analytics application in an intuitive, visual format, along with other IBM Digital Analytics reports.
      - IBM Digital Analytics based customer segments
        With the push of a button, marketing managers can export any profile segments that are defined in as HCL Commerce customer segments. These customer segments are viewable in Management Center. Marketing managers can use these IBM Digital Analytics based customer segments as targets for marketing activities and promotions, just as they would use customer segments that are created in HCL Commerce.
      - Configuring default values for an analytics provider
        You can configure default values for an analytics provider configuration to apply the default values to all stores that are associated with the analytics provider. By setting site-level default values, you can quickly configure multiple stores to use the same analytics provider settings. You can also override the default values for an individual store.
      - Using a reload file to test the analytics integration configuration
        In your development environment, you can create and use a reload file to quickly test adjustments to the configuration between HCL Commerce and an analytics provider. When this file is in same directory as your biConfig.xml configuration file, your system can locate the file and begin reloading the biConfig.xml file to apply any changes to your analytics configuration. This reloading behavior can help you test changes and complete your analytics configuration quicker.
    - Integrating a store with an external analytics system (other than IBM Digital Analytics)
      To meet your analytics requirements, you can integrate an HCL Commerce store with any web-based analytics system that uses a JavaScript based tagging mechanism. For this purpose, HCL Commerce provides an extensible JSP-based tag library framework for analytics.
    - Integrating a store with multiple analytics providers
      HCL Commerce provides you with the option to use multiple analytics providers for one store, allowing for greater data collection and accuracy of shopper activity. As a result, you can compare and analyze multiple sets of data from different analytics providers.
  - IBM Product Recommendations and HCL Commerce
    IBM Product Recommendations is an IBM Digital Analytics solution that you can subscribe to that automatically generates personalized product recommendations on the storefront. The recommendations are based on the browsing, shopping, and purchasing behavior of individual customers. If your site is integrated with IBM Digital Analytics, you can display recommendations from IBM Product Recommendations on your store pages.
  - IBM Enterprise Marketing Management integration
    You can integrate HCL Commerce with IBM Enterprise Marketing Management.
  - IBM Dynamic Pricing
    Dynamic Pricing is a cloud-based pricing system that analyzes real-time market data to provide suggestions on how merchandisers can react to competitor pricing and shifts in market conditions. Data can be fed to Dynamic Pricing from multiple sources, including HCL Commerce. You can configure HCL Commerce to export pricing data to Dynamic Pricing for pricing analysis and adjustment. The adjusted pricing data can then be imported from Dynamic Pricing to HCL Commerce, so the prices can be propagated to your live store front.
  - IBM WebSphere eXtreme Scale
    You can integrate HCL Commerce version 9.0.0.7 or later with IBM WebSphere eXtreme Scale version 8.6.1.2 or later. The WebSphere eXtreme Scale licensed program is an elastic, scalable, in-memory data grid that you can use as an advanced cache for HCL Commerce. Integrating with WebSphere eXtreme Scale can provide significant performance benefits for high volume HCL Commerce customers.
  - Apple Pay on the Web integration
    Apple Pay on the Web integration with HCL Commerce provides you with an easy and secure way to accept and process payments. Apple Pay on the Web enables customers to purchase products in the Aurora starter store with a single touch in Safari on Mac, iPhone, and iPad.
  - Configuring directory services (LDAP) with HCL Commerce
    HCL Commerce can be configured to use one or more LDAP servers as the master user repository instead of the HCL Commerce database. This is typically done when multiple applications need to share a common user repository.
  - Sterling Omni-Configurator integration
    The Sterling Omni-Configurator integration for HCL Commerce enables your storefront to sell complex, configurable products, otherwise know as dynamic kits.
  - OAuth 2.0 framework for social login
    When you integrate with the OAuth 2.0 framework, your shoppers can authenticate to your storefront with their social networking accounts, like Google, Facebook, and Twitter.
  - HCL Digital Experience integration
    HCL Digital Experience is a fully-featured, multi-platform enterprise content management solution. Using HCL Digital Experience, you can easily manage your growing volume of digital content that is required to run your business and support critical decisions.
  - HCL Unica Discover integration
    HCL Unica Discover records what your customers are seeing on your store web pages and how they interact with store pages. HCL Unica Discover provides deep behavioural insights into the online journey of users who visit your store. You can use these insights to create positive experiences for the users that make them want to visit your store again.
  - Google Analytics integration
    Google Analytics helps you to understand how your customers are engaging with your store content and how they interact with store pages. Google Analytics helps you to get a deeper understanding of your customers so that you can improve customer experience and get better results.
- Administering
  Topics in the Administering category highlight tasks that are typically performed by the Site Administrator, to support daily operations of the HCL Commerce site.
- Customizing
  The topics in the Customizing section describe tasks performed by an application developer to customize HCL Commerce.
- Tutorials
  HCL Commerce provides many tutorials to help you customize and understand your HCL Commerce instance and stores.
- Samples
  Topics in the Samples category highlight the various samples that are provided with HCL Commerce.
- Compliance
  The following section describes how you can leverage HCL Commerce features and functionality to help your site be compliant with different privacy and security standards.
- Securing
  These topics describe the security features of HCL Commerce and how to configure these features.
- Performance
  Topics in the Performance section describe the means by which to plan, implement, test, and re-visit the optimization of HCL Commerce site performance.
- Troubleshooting
  Topics in the Troubleshooting section highlight common issues that are encountered with HCL Commerce, and how they can be addressed or mitigated.
- Reference
  Topics in the Reference section contain all of the HCL Commerce reference documentation.

IBM Digital Analytics page view event

When the event listener for detects a IBM Digital Analytics page view event, the event listener calls the IBM Digital Analytics cmCreatePageviewTag function.

The IBM Digital Analytics page view event gathers the following data to populate the IBM Digital Analytics cmCreatePageviewTag data tag:

pagename: An optional parameter that specifies the name of the page, or page element, being viewed. If a page name is not provided, the HTML page title is used.
category: An optional parameter that specifies the category of the page, or page element, being viewed. If a category is not provided, no category information is sent.
searchTerms: For a search results page: a required parameter that specifies the term that the customer used to search the site.
searchCount: For a search results page: a required parameter that specifies the total number of results that are returned by the search.
storeId: Store identifier of the store to which the page currently being viewed belongs. If not provided, the storeId parameter is extracted from the current URL.