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.
Reference
Topics in the Reference section contain all of the HCL Commerce reference documentation.
HCL Commerce database schema
The HCL Commerce database model was designed for data integrity and optimal performance. HCL Commerce provides several hundred tables that store HCL Commerce instance data. To maintain data integrity, and to ease maintenance referential integrity, constraints are widely used in the database model. Indexes are used carefully on tables to avoid over-indexing and to provide a good balance between data retrieval and data manipulation activities (insert and update). The business rules are implemented at the application level rather than by using database trigger. Triggers, however, are used to facilitate data staging and optimistic locking. A limited number of SQL-based database stored procedures are used for data intensive activities.
Database tables
O
ONQUEUE
Reserved for HCL internal use.

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.
- 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.
  - HCL Commerce API reference
    HCL Commerce exposes two main programming APIs. The first and newest API is a REST interface, and most new classes are exposed here. The legacy Java API also contains new classes not suitable for REST, and can be browsed in Javadoc format.
  - Cross-reference of data beans and tables
    Data beans are grouped into several component groups.
  - Cross-reference of commands, tasks, and tables
    URL commands, controller commands, task commands, view commands and tables are related to each other.
  - Cross reference: Commands to beans to database tables
    Use this information when you are customizing a command and you want to know which tables are affected. You should also use this topic if you are modifying a table and want to know which commands and beans are affected.
  - Run Engine commands
    The following Run Engine commands are available by default for you to configure the applications that are running inside the containers.
  - Entering Docker containers
    To enter a Docker container you can complete the following steps.
  - Docker container start up logic for 9.0.0.0 and 9.0.0.1
    When you deploy a container from an HCL provided image, an Entrypoint.sh helper script determines the configurations to use while starting up the container. Review the following information to learn about what the helper script does, and how you can customize the configurations.
  - Docker container start up logic for HCL Commerce Version 9.0.0.2 or later
    When you deploy a container from an HCL provided image, an Entrypoint.sh helper script determines the configurations to use while starting up the container. Review the following information to learn about what the helper script does, and how you can customize the configurations.
  - HCL Commerce database schema
    The HCL Commerce database model was designed for data integrity and optimal performance. HCL Commerce provides several hundred tables that store HCL Commerce instance data. To maintain data integrity, and to ease maintenance referential integrity, constraints are widely used in the database model. Indexes are used carefully on tables to avoid over-indexing and to provide a good balance between data retrieval and data manipulation activities (insert and update). The business rules are implemented at the application level rather than by using database trigger. Triggers, however, are used to facilitate data staging and optimistic locking. A limited number of SQL-based database stored procedures are used for data intensive activities.
    - Column data type considerations
      Several column data types are available for you to use when you are creating new database table or columns.
    - Schema changes from Version 8 to Version 9
      Database tables and columns within the HCL Commerce Version 9 database schema can differ from the tables and columns in the database schema for HCL Commerce Version 8.
    - Deprecated tables and columns
      If a database table or column is marked as deprecated, then the table or column is outdated by newer constructs. Deprecated sections are supported for reasons of compatibility with an earlier version only. These tables or columns are obsolete or can become obsolete in future versions of HCL Commerce.
    - Data models
      Any given database data model displays the relationship among database tables in the schema.
    - Database tables
      - A
      - B
      - C
      - D
      - E
      - F
      - G
      - H
      - I
      - J
      - K
      - L
      - M
      - N
      - O
        OFFER
        Each row of this table represents an Offer to sell a product identified by a CatalogEntry.
        OFFERDESC
        Each row in this table contains language-dependent information for an Offer.
        OFFERPRICE
        Each row of this table represents a price in a currency for an Offer.
        OIBTB
        This table is deprecated and is provided for backward compatibility only
        OICOMPLIST
        Each rows contains information about the components of a configured OrderItem.
        OICOMPREL
        Stores all kit level information for an Order item that is a kit. A kit may contain other kits and catalog entries outside of a kit. However there is no storefront, tooling or server side support for kits that contain other kits. This table stores information about kit components and the OICOMPLIST table stores information about catalog entries outside of a kit.
        OICONFIG
        This table maintains the relationship between order item and its configuration details
        ONLOG
        Reserved for HCL internal use.
        ONQUEUE
        Reserved for HCL internal use.
        ONSLOG
        Reserved for HCL internal use.
        OPERATOR
        This table is used to define operators.
        OPERATRDSC
        This table holds the language-dependent information related to an operator.
        OPSYSTEM
        This table is used for storing Order Processing system.
        ORCOMMENT
        The table stores the comments for an order entered by a customer service representative.
        ORCPMAP
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        ORDADJDSC
        Each row of this table contains language-dependent information for an OrderAdjustment.
        ORDADJTXEX
        Each row of this table indicates that an OrderAdjustment is exempt from taxation of a particular TaxCategory. For example, an "after tax rebate" can be represented as a negative OrderAdjustment that is exempt from taxation of all TaxCategories.
        ORDADJUST
        Each row of this table represents an OrderAdjustment.
        ORDAUDIT
        Stores audit records for each order line submitted
        ORDBTB
        Reserved for HCL internal use.
        ORDCALCD
        Each row of this table indicates to the CalculationCodeCombineMethod that a CalculationCode is directly attached to all OrderItems in an Order. The order directCalculationCodeAttachment flag in ORDERITEMS.PREPAREFLAGS is 1.
        ORDCHGRSN
        This table is used for storing the order change reason code for different actions.
        ORDCHGRSNDS
        The order change reason code description for different languages.
        ORDCHNLTYP
        Reserved for HCL internal use.
        ORDERBLK
        Stores blocked Orders with reason code
        ORDERHIST
        This table is used to save order snapshots in XML format.
        ORDERITEMGIFT
        This table stores the relationship between an order item and a gift registry.
        ORDERITEMS
        Each row of this table represents an order item in an order.
        ORDJUST
        This table holds the details of the order justifications.
        ORDJUSTDESC
        This table holds the language specific descriptions of the order justifications.
        ORDERMGP
        This table is used to track the customer segments to which an Order is associated.
        ORDERMSG
        Reserved for HCL internal use.
        ORDRETURN
        This table holds the details of the order returns.
        ORDRETURNITEM
        This table holds the details of the order return items.
        ORDERREL
        Each row in this table represent relationship between one child order and one parent order.
        ORDERS
        Each row in this table represents an order in a store.
        ORDERTMPL
        Each row of this table indicates that an Order is used as a template by a customer. And it also indicates whether the template is current for that customer.
        ORDEXTATTR
        This table stores extended order attributes.
        ORDIADJUST
        Each row in this table represents an OrderItemAdjustment.
        ORDICALCD
        Each row of this table indicates to the CalculationCodeCombineMethod that a CalculationCode is directly attached to an OrderItem. The attachment is not effective unless the directCalculationCodeAttachment flag in ORDERITEMS.PREPAREFLAGS is 1.
        ORDIMEEXTN
        This table contains procurement system specific OrderItem information.
        ORDIOFFER
        Each row of this table indicates an Offer that was searched to obtain the price for an OrderItem. These rows are created by the OrderItemAdd and OrderItemUpdate commands.
        ORDIPROF
        Reserved for HCL internal use.
        ORDISTAT
        This table contains information about the items within a single order for an Order Status Update inbound message. Each row contains information about a single item.
        ORDITAX
        Each row of this table contains a tax amount of a particular TaxCategory, for an OrderItem. By default, WebSphere Commerce does not save any data in this table. However tax amounts are aggregated by TaxCategory in the SUBORDTAX and ORDTAX tables.
        ORDITEMCONF
        This table is used to check order item shipment confirmation and capture the order serial numbers
        ORDITEMEXTATTR
        This table will hold extended attributes of order items which is used for customization.
        ORDITPROMOCD
        This contains promotion codes that were captured with an order for the order items in the order. This table is intended for customization and is not used by default implementation.
        ORDITRD
        Each row of this table indicates a TradingAgreement that was searched to obtain the price for an OrderItem. These rows are created by the OrderItemAdd and OrderItemUpdate commands.
        ORDMEEXTN
        This table contains procurement system specific order information.
        ORDOPTIONS
        This table is used for Order notification.
        ORDPAYINFO
        Each row in this table holds a name-value pair representing payment information for a particular Order. Values added to this table are encrypted when the "Instance/PDIEncrypt" configuration flag is "on".
        ORDPAYMTHD
        This table is deprecated and is provided for backward compatibility only.
        ORDPICKHST
        Details of the how inventory was picked from the receipt level when available inventory is allocated to an OrderItem.
        ORDPROMOCD
        This table contains promotion codes captured for an order.
        ORDQUOTREL
        Each row of this table represents a relationship between a parent Order and a child Order.
        ORDRELEASE
        Each row in this table represents an order release. The release is a grouping of all order items in an order that are to be shipped on the same date to the same address. The order items also use the same shipping mode from the same fulfillment center.
        ORDRTNITMJUSTREL
        This table holds the relationships between order return items and justifications.
        ORDRLSTTLS
        Store release level charges.
        ORDSHIPHST
        Each row contains information about inventory that has been released for fulfillment of an OrderItem.
        ORDSTAT
        This table contains information about the status of an order for an Order Status Update inbound message. Each row in the table contains information about a single order.
        ORDTAX
        Each row of this table represents the total of the tax amounts of a particular TaxCategory for all the OrderItems in an Order.
        ORDUSERS
        Contains information about users that worked with an order.
        ORGCODE
        This table contains the unique identification of an OrgEntity under different identification systems or domains. This can be used to identify buyer organizations and supplier organizations to each other in procurement systems.
        ORGENTITY
        This table contains information on organizational entities (OrgEntities). An OrgEntity is either an organization or an organization unit. Authorization domains are also stored in this table.
        OUTPUTQ
        Reserved for HCL internal use.
        OUTPUTQDSC
        Reserved for HCL internal use.
      - P
      - Q
      - R
      - S
      - T
      - U
      - V
      - W
      - X
      - Y
      - Z
  - Payments subsystem
    In HCL Commerce, payment processing uses the Payments subsystem.
  - Dynamic caching
    In general, caching improves response time and reduces system load. Caching techniques are used to improve the performance of World Wide Web Internet applications. Most techniques cache static content (content that rarely changes) such as graphic and text files. However, many websites serve dynamic content, containing personalized information or data that changes more frequently. Caching dynamic content requires more sophisticated caching techniques, such as those provided by the WebSphere Application Server dynamic cache, a built-in service for caching and serving dynamic content.
  - HCL Commerce store pages properties
  - Cache-entry elements
    The root element of the cachespec.xml file, <cache>, contains <cache-entry> elements. The WebSphere dynamic cache service parses the cachespec.xml file during start-up, and extracts a set of configuration parameters from each <cache-entry> element.
  - Data Load utility configuration file schema
    The Data Load utility contains several configuration files. You can use the configuration file schema to understand and customize the data load configuration files.
  - HCL Commerce web services
    HCL Commerce provides many web services.
  - Utilities
    In HCL Commerce utilities are scripts that perform operations such as loading access control policies, loading store data, and cleaning the database of obsolete objects. In runtime environments, run utilities from the Utility server Docker container. In the development environment, run utilities from the bin directory.
  - Shopping flow URLs
    HCL Commerce shopping flow URLs are organized by subsystem.
  - Messaging system URLs
    The following URLs relate to the Messaging system.
  - Scheduler URLs
    The server subsystem consists of functions that are associated with URLs that are run by the scheduler.
  - jQuery Enhancements API
    The Aurora starter store in HCL Commerce is completely written in jQuery, which is one of the most commonly used JavaScript libraries used in dynamic websites. The jQuery AJAX and events API provides an easy to use framework that meets most AJAX requirements for storefront development.
  - HCL Commerce foundation tag library
    The HCL Commerce foundation JSTL tag library is a collection of custom tags that are provided to you to support the authoring of HCL Commerce JSP files. HCL Commerce stores use the JavaServer Pages Standard Tag Library (JSTL) to perform logic, instead of Java code. At the same time, business logic is moved into data beans. The combination of these steps allows for less Java code in a JSP page.

ONQUEUE

Reserved for HCL internal use.

Column Descriptions:

Name	Type	Description
STOREENT_ID	INTEGER NOT NULL	Reserved for HCL internal use.
ORRFNBR	BIGINT NOT NULL	Reserved for HCL internal use.
OPTCOUNTER	SMALLINT NOT NULL DEFAULT 0	The optimistic concurrency control counter for the table. Every time there is an update to the table, the counter is incremented.

Indexes:

Name	Column Names	Type
I0000170	ORRFNBR	Unique Index
I0000631	STOREENT_ID	Non-Unique Index

Constrained By Parent Tables:

Constraint	Columns	Parent Table	Parent Columns	Type
F_479	ORRFNBR	ORDERS	ORDERS_ID	Cascade
F_480	STOREENT_ID	STOREENT	STOREENT_ID	Cascade