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.
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.
Integrating Sterling Order Management with HCL Commerce
Configuring and deploying HCL Commerce and Sterling Order Management for integration includes running provided activation scripts, defining properties for your implementation, granting permissions, and triggering agent and integration servers.
Configuring and deploying Sterling Order Management for integration
Configuring and deploying Sterling Order Management for integration involves several steps.
Triggering agents and integration server
You must trigger inventory cache push synchronization and the integration server.
Triggering inventory cache push synchronization
Inventory cache synchronization runs in two modes: Monitor Option 1 mode, where the Activity Based Monitor focuses on distinct inventory items in the YFS_INVENTORY_ACTIVITY table, and Monitor Option 3 mode, which is Full Sync. This monitor focuses on all inventory items maintained by the inventory organization provided. If no InventoryOrganizationCode is provided, all inventory items are monitored.

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, 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.
    - Solution Overview
      The integration of HCL Commerce and IBM Sterling Order Management delivers the strengths of both products.
    - Prerequisites
      For the Sterling Order Management integration with HCL Commerce, some prerequisites, system requirements, assumptions, and limitations apply.
    - Sample configuration for integrating with Aurora starter store
      The sample configuration for integrating with the Aurora starter store provides a preconfigured order management-to-storefront environment that you can test to understand the significant features of the HCL Commerce integration with Sterling Order Management.
    - Integrating Sterling Order Management with HCL Commerce
      Configuring and deploying HCL Commerce and Sterling Order Management for integration includes running provided activation scripts, defining properties for your implementation, granting permissions, and triggering agent and integration servers.
      - Setting up HCL Commerce to work with Sterling Order Management
        Setting up HCL Commerce to work with Sterling Order Management involves several steps.
      - Configuring and deploying Sterling Order Management for integration
        Configuring and deploying Sterling Order Management for integration involves several steps.
        Activating a Direct Integration
        Side-by-side integration is done after Sterling Order Management and HCL Commerce are installed, and involves running two scripts. The process activates event handlers, event templates, and user exit implementations. Existing data are validated to ensure that no existing configurations are overwritten.
        Installing third party JAR
        Copy the JAR files from the HCL Commerce runtime and install them as the third party JAR files in the Sterling Order Management runtime.
        Defining integration properties in Sterling Order Management
        You can use this information to define variables for communication services.
        Defining Action Properties
        The action.properties file maps HCL Commerce business object documents (BOD) and Sterling Order Management services.
        Deploying template files
        Use this information to identify, rename, and deploy sample template files.
        Defining and deploying ValueMaps.xml file
        The ValueMaps.xml file maps values between HCL Commerce and Sterling Order Management.
        Configuring the authorizationOnlyApiServlet for direct integration
        To enable SSL as part of direct integration, enable access to the authorizationOnlyApiSerlet.
        Granting API permissions
        Organization WCIntegrationOrg must be loaded and API permissions must be granted to the group WCIntegrationGroup.
        Enabling data access policies override
        The Access Policies Override feature provides a mechanism whereby any API can be called to create or view orders, preventing failure at the access policy layer.
        Configuring order and inventory integration in Sterling Order Management
        Configuring order and inventory integration in Sterling Order Management involves starting the order integration servers and configuring the Real-Time Availability Monitor.
        Configuring pricing and promotion integration in Sterling Order Management
        You must configure Sterling Order Management for HCL Commerce pricing.
        Triggering agents and integration server
        You must trigger inventory cache push synchronization and the integration server.
        Triggering the integration server
        Triggering the integration server is the final step in the Sterling Order Management configuration.
        Triggering inventory cache push synchronization
        Inventory cache synchronization runs in two modes: Monitor Option 1 mode, where the Activity Based Monitor focuses on distinct inventory items in the YFS_INVENTORY_ACTIVITY table, and Monitor Option 3 mode, which is Full Sync. This monitor focuses on all inventory items maintained by the inventory organization provided. If no InventoryOrganizationCode is provided, all inventory items are monitored.
      - Configuring one-way or two-way SSL authorizations
        To implement Secure Socket Layer (SSL) security for the integration between Sterling Order Management and HCL Commerce, you can enable one-way or two-way SSL.
    - Customizing
      Many elements of the side-by-side integration can be customized.
    - Troubleshooting and status codes
      To troubleshoot integration issues, review status codes.
    - Reference
      To understand how Sterling Order Management integrates with HCL Commerce, review mappings between the two systems and integration flows.
  - 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.
  - 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.
- 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.

Triggering inventory cache push synchronization

Inventory cache synchronization runs in two modes: Monitor Option 1 mode, where the Activity Based Monitor focuses on distinct inventory items in the YFS_INVENTORY_ACTIVITY table, and Monitor Option 3 mode, which is Full Sync. This monitor focuses on all inventory items maintained by the inventory organization provided. If no InventoryOrganizationCode is provided, all inventory items are monitored.

The inventory push is triggered in Monitor Option 1 or Monitor Option 3 mode, the availability change message from Sterling Order Management is routed to the SyncInventoryAvailability Service and sent to the HCL Commerce Inventory service.

In Activity based Inventory Sync, if inventory goes above or below a threshold, that is, if the inventory level changes (additional inventory available) or inventory falls under a specified threshold, the availability change message from Sterling Order Management is routed to the SyncInventoryAvailability Service and sent to the HCL Commerce Inventory service.
Figure 1. Monitor Option 1 mode

To trigger inventory cache push synchronization in Monitor Option 1 mode, run the following command:
```
<INSTALL_DIR>/bin/triggeragent.sh <RTAM_CRITERIA_ID_OP1>
```
When a full inventory sync is required where the entire catalog inventory is synchronized, the inventory push is triggered in Monitor Option 3 mode, where the availability change message from Sterling Order Management is routed to the SyncInventoryAvailabilityCSV Service. This service creates InventoryAvailability.csv file, which is consumed by the HCL Commerce scheduler.
Figure 2. Monitor Option 3 mode

To trigger inventory cache push synchronization in Monitor Option 3 mode, run the following command:
```
<INSTALL_DIR>/bin/triggeragent.sh <RTAM_CRITERIA_ID_OP3>
```