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.
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.
Back-end integration legacy messages
The HCL Commerce offers support for messages which use the legacy message format. Unless you are migrating from a previous version of HCL Commerce Suite, it is recommended that you use the XML messages instead, since they accomplish the same function, and are easier to read and maintain.
Order Status Update message
The Order Status Update message is an inbound message that contains status information for an HCL Commerce order. A back-end application generates this message and sends it to the HCL Commerce inbound message queue, where the HCL Commerce system receives the message. HCL Commerce uses the OrderStatus command to update the tables ORDSTAT and ORDISTAT with the new order status information.
ORDER_STATUS_UPDATE_PROLOG_DATA
The Order Status Update message includes the ORDER_STATUS_UPDATE_PROLOG_DATA segment. This data segment identifies the type of message that is being defined; that is, the segment indicates that the message is an Order Status Update message with a field value of OS (Order Status).

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.
    - SOA Logical Architecture and HCL Commerce back-office integration
      HCL Commerce provides back-office integration to enable your business application services to connect to access services.
    - Outbound services
      HCL Commerce provides the capability for you to enable outbound web services to send information and messages that are generated from HCL Commerce.
    - Inbound services
      HCL Commerce provides inbound web services to retrieve information for HCL Commerce business operations. You can use the code and documentation that is provided with HCL Commerce to enable inbound web services to integrate backend systems and external system with HCL Commerce operations.
    - Integration XML messages
      HCL Commerce offers support for inbound and outbound messages that use the XML format. Each inbound message invokes specific behaviors within the HCL Commerce Server by executing a controller command. Each controller command in turn performs operations on the HCL Commerce database and subsystems. Some controller commands can be executed by more than one XML message. In addition, some messages can invoke different commands, depending on the content of the message.
    - Procurement system integration
      HCL Commerce provides the capability to integrate with procurement systems. This capability enables HCL Commerce customers to participate as suppliers in the procurement system's marketplace, increase sales, and enhance their business-to-business presence on the Web. HCL Commerce provides an extensible and customizable functionality in such a way that one can extend either the messages or the business logic.
    - Controller commands
      Controller commands encapsulate the business logic for a business process. By default, HCL Commerce provides various controller commands to help you integrate HCL Commerce with backend and external systems.
    - Back-end integration legacy messages
      The HCL Commerce offers support for messages which use the legacy message format. Unless you are migrating from a previous version of HCL Commerce Suite, it is recommended that you use the XML messages instead, since they accomplish the same function, and are easier to read and maintain.
      - NCCommon.mod - source file
        HCL Commerce defines all inbound XML messages based on DTD files. Each DTD file consists of several XML elements and the NCCommon.mod file.
      - NCCustomer_10.mod - source file
        HCL Commerce defines all inbound XML messages based on DTD files. Each DTD file consists of several XML elements and the NCCommon.mod file. In addition, the Create_NC_Customer_10.dtd and Update_NC_Customer_10.dtd files also include information from the NCCustomer10.mod customer common file.
      - NCCustomer_10.mod file
        The NCCustomer_10.mod customer common file consists of customer information for new customers. It is used for both the Create_NC_Customer and Update_NC_Customer messages.
      - UserData element for inbound messages
        All inbound messages include the UserData XML element as an optional element. Include the UserDataField element to transport additional data. You can customize the fields to pass extra data that is not included in the messages.
      - UserData element for outbound messages
        The outbound XML message Report_NC_PurchaseOrder includes the UserData XML element as an optional element. Include the UserDataField element in this message to send additional data. You can customize the fields to pass extra data that is not included in the messages.
      - Customer New message
        The Customer New message is a legacy format inbound message that contains customer information for a customer. A back-end application generates this message and sends it to the HCL Commerce inbound message queue, where the HCL Commerce system receives the message. HCL Commerce updates information for a new customer by calling the UserRegistrationAdd controller command.
      - Customer Update message
        The Customer Update message is an inbound message that contains customer information for a customer. A back-end application generates this message and sends it to the HCL Commerce inbound message queue, where the HCL Commerce system receives the message. HCL Commerce updates information for a registered customer by calling the UserRegistrationUpdate command.
      - Order Create message
        The Order Create message is an outbound message that contains order details for a completed order. The HCL Commerce system generates this message and sends its data to an outbound message queue, where a back-end system receives the message. This application takes the message and continues any back-end business processes required to complete the specified task for the order. Use Order Create to fulfill the order process of orders that begin with the HCL Commerce system, but also require some additional or back-end work by a separate system.
      - Order Status Update message
        The Order Status Update message is an inbound message that contains status information for an HCL Commerce order. A back-end application generates this message and sends it to the HCL Commerce inbound message queue, where the HCL Commerce system receives the message. HCL Commerce uses the OrderStatus command to update the tables ORDSTAT and ORDISTAT with the new order status information.
        ORDER_STATUS_UPDATE_HDR010_DATA
        The Order Status Update message includes the ORDER_STATUS_UPDATE_HDR010_DATA segment. This data segment consists of order specifications for the Order Status Update message.
        ORDER_STATUS_UPDATE_ITM010_DATA
        The Order Status Update message includes the ORDER_STATUS_UPDATE_ITM010_DATA segment. This data segment consists of item or product shipping specifications for the Order Status message.
        ORDER_STATUS_UPDATE_PROLOG_DATA
        The Order Status Update message includes the ORDER_STATUS_UPDATE_PROLOG_DATA segment. This data segment identifies the type of message that is being defined; that is, the segment indicates that the message is an Order Status Update message with a field value of OS (Order Status).
      - Product Price Update message
        The Product Price Update message is an inbound message that contains price information for a product. A back-end application generates this message and sends it to the HCL Commerce inbound message queue. When the HCL Commerce system receives the message, it runs the ProductOfferPriceUpdate command.
      - Product Quantity Update message
        The Product Quantity Update message is an inbound message that contains inventory information for a product. A back-end application generates this message and sends it to the HCL Commerce inbound message queue, where the HCL Commerce system receives the message.
  - 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.
  - 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.

ORDER_STATUS_UPDATE_PROLOG_DATA

The Order Status Update message includes the ORDER_STATUS_UPDATE_PROLOG_DATA segment. This data segment identifies the type of message that is being defined; that is, the segment indicates that the message is an Order Status Update message with a field value of OS (Order Status).

The Order Status Update message supports two sets of application data: Order Status Update version 01 and Order Status Update version 02. Version 02 includes a superset of the data within version 01. Specifically, the ORDER_STATUS_UPDATE_PROLOG_DATA segment for version 01 contains a value of 01 for the field NC_MsgVersion; whereas version 02 contains a value of 02 for NC_MsgVersion.

The format and the source of the fields for ORDER_STATUS_UPDATE_PROLOG_DATA for version 02 are described in the following table:


Field Name	Field Type	Field Value
NC_MsgType	CHAR (10)	OS
NC_MsgVersion	CHAR (2)	02
NC_RESERVED	CHAR (10)	Reserved for IBM use.

The format and the source of the fields for ORDER_STATUS_UPDATE_PROLOG_DATA for version 01 are described in the following table:


Field Name	Field Type	Field Value
NC_MsgType	CHAR (10)	OS
NC_MsgVersion	CHAR (2)	01
NC_RESERVED	CHAR (10)	Reserved for IBM use.