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.
Data models
Any given database data model displays the relationship among database tables in the schema.
Order Management
The order management data model shows the relationship between database tables related to the Order Management subsystem.
ATP inventory reservations
The ATP inventory reservations data model diagram shows the relationship between database tables that contain information about ATP inventory reservations.

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.
- 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 HCL Commerce Version 9.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.
  - 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.
      - Legend for data models
        Database tables within the HCL Commerce database schema are organized into functional groups, called data models.
      - Marketplace
        The marketplace data model shows the relationship between database tables related to the Marketplace Management system.
      - Catalog
        The catalog data model shows the relationship between database tables related to the Catalog subsystem.
      - Marketing
        The marketing data model shows the relationship between database tables related to the Marketing subsystem.
      - Promotions
        The promotions data models show the relationship between database tables that are related to the promotions.
      - Member
        The member data model shows the relationship between database tables related to the Member subsystem.
      - Order Management
        The order management data model shows the relationship between database tables related to the Order Management subsystem.
        ATP inventory
        The ATP inventory data model shows the relationship between database tables that contain information about ATP inventory.
        ATP inventory adjustment
        This diagram shows the relationship between database tables that contain information about ATP inventory adjustments.
        ATP expected inventory
        The ATP expected inventory data model shows the relationship between database tables that contain information ATP expected inventory.
        ATP inventory fulfillment
        The ATP inventory fulfillment data model shows the relationship between database tables that contain information about ATP inventory fulfillment.
        ATP inventory orders
        The ATP inventory orders data model shows the relationship between database tables that contain information about ATP inventory orders.
        ATP inventory reservations
        The ATP inventory reservations data model diagram shows the relationship between database tables that contain information about ATP inventory reservations.
        Billing
        The database tables that contain information about billing do not have any direct relationship with each other.
        Calculation code
        The Calculation code data model shows the relationship between database tables that contain information about calculation codes.
        Calculation code - direct attachment
        The Calculation code - direct attachment data model shows the relationship between database tables that contain information about direct attachments in calculation codes.
        Calculation code - indirect attachment
        The Calculation code - indirect attachment data model shows the relationship between database tables that contain information about indirect attachments in calculation codes.
        Calculation method
        Each row in the CALMETHOD database table indicates a task command that can be used by a store, or by stores in a store group, to perform calculations of discounts, shipping charges, sale or use tax, and shipping taxes (depending on its calculation usage).
        Calculation rule - discount
        The Calculation rule - discount data model shows the relationship between database tables that contain information about discount data in calculation rules.
        Calculation rule - shipping
        The Calculation rule - shipping data model shows the relationship between database tables that contain information about shipping data in calculation rules.
        Calculation rule - tax
        The Calculation rule - tax data model shows the relationship between database tables that contain information about tax data in calculation rules.
        Calculation scale
        The Calculation scale data model shows the relationship between database tables that contain information about calculation scales. You can use calculation scales to define ways to calculate discounts, shipping charges, and taxes within a store. The scale is part of a StoreEntity and can be associated with a particular QuantityUnit or Currency.
        Calculation usage
        The calculation usage data model shows the relationship between database tables that contain information about calculation usage. Calculation usage includes discounts, shipping charges, and sales and shipping taxes. Calculation usage can be specified for individual stores, and affects the way that calculation codes and methods are used.
        Country and state code
        The Country and state code data model shows the relationship between database tables that contain information about the state and country codes for taxes.
        Currency
        The currency data model shows the relationship between database tables that contain information about currency within payments.
        DOM inventory cache data model
        The DOM inventory cache data model shows the relationship between database tables that contain information about inventory configuration and inventory cache in DOM inventory.
        Fulfillment
        The Fulfillment data model shows the relationship between database tables that contain information about fulfillment. Fulfillment centers are not part of a store, and hold inventory on behalf of stores.
        Interest item
        The Interest item data model shows the relationship between database tables that contain information about interest items.
        Jurisdiction
        The Jurisdiction data model shows the relationship between database tables that contain information about tax and shipping jurisdictions.
        Offers
        The Offers data model shows the relationship between database tables containing information about offers for trading positions.
        Order
        The Order data model shows the relationship between database tables that contain information about orders. Members can own StoreEntities. Other Members can create Orders and Addresses. An Order may have a billing address.
        Order adjustment
        The Order adjustment data model shows the relationship between database tables that contain information about order adjustments. Each OrderAdjustment is the total of the OrderItemAdjustments that are created when the results from a particular CalculationCode calculation are applied.
        Order management adjustment and tax
        The Order management adjustment and tax data model shows the relationship between database tables that contain information about order management adjustment and tax data for an Order.
        Order management - receipt and disposition
        The Order management - receipt and disposition data model shows the relationship between database tables that contain information about receipt and disposition data for an Order.
        Order management - RMA
        The Order management - RMA data model shows the relationship between database tables that contain information about RMA (return merchandise authorization) data for an Order.
        Order management - RMAitem
        The Order management - RMA item data model shows the relationship between database tables that contain information about RMA (return merchandise authorization) item data for an Order.
        Order release
        The Order release data model shows the relationship between database tables that contain information about release data for an Order.
        Order tax
        The Order tax data model shows the relationship between database tables that contain information about tax data for an Order.
        Order trading agreement
        The Order trading agreement data model shows the relationship between database tables that contain information about order trading agreements.
        Order item
        The Order Item data model shows the relationship between database tables that contain information about order item data.
        Order item - allocated
        The Order Item - allocated data model shows the relationship between database tables that contain information about allocated data for an OrderItem.
        Order item - backordered
        The Order item - backordered data model shows the relationship between database tables that contain information about backordered data for an OrderItem.
        Pricing
        The Pricing data model shows the relationship between database tables that contain information about pricing.
        Price rules
        The Price Rules data model shows the relationship between tables used in the Catalog Filter and Pricing tool.
        Procurement
        The Procurement data model shows the relationship between database tables that contain information about procurements.
        Quantity unit
        The Quantity unit data model shows the relationship between database tables that contain information about quantity units.
        Quantity unit - references
        The Quantity unit - references data model shows the relationship between database tables that contain information about quantity units.
        Receipt
        The Receipt data model shows the relationship between database tables that contain information about receipts.
        Shipping
        The shipping data model shows the relationship between database tables that contain information about shipping.
        Buy online, pickup in-store
        The Buy online, pickup in-store data model shows the relationship between database tables that contain information about online orders that are to be picked up in-store.
        Suborders
        The suborders data model shows the relationship between database tables that contain information about suborders.
        Subscriptions and recurring orders
        The subscriptions and recurring orders data model shows the relationship between database tables related to the service provider solution.
        Tax type and category
        The Tax type and category data model shows the relationship between database tables that contain information about categories and types of taxes.
        Ticklers
        The Ticklers shows the relationship between database tables that contain information about ticklers.
        Vendor
        The Vendor data model shows the relationship between database tables that contain information about vendor.
      - Payment
        The payment data models show the database tables that are related to the payments subsystem.
      - Store
        The store data models show the relationship between database tables that are related to stores.
      - System
        The system data models show the relationship of database tables used for HCL Commerce system functions.
      - Trading
        The trading data models show the relationship of database tables in the Trading subsystem.
      - Content Management
        The Content Management shows the relationship between database tables that contain information about content management.
      - Content management system integration
        The content management system integration data model shows the relationship between database tables used by the solution.
      - Content versioning
        The content versioning data model shows the relationship between database tables that contain information about the content versioning.
      - Folder data model
        The folder data model shows the relationship between the database tables that include information about folder and folder items.
      - Wish list
        The Wish list data model (previously the Gift Center data model) shows the relationship between database tables that contain information about the storefront user wish list.
      - HCL Commerce search engine optimization
        The HCL Commerce search engine optimization (SEO) shows the relationship between database tables that contain information about HCL Commerce search engine optimization (SEO).
      - HCL Commerce search data model
        The HCL Commerce search data model shows the relationship between database tables that are related to HCL Commerce search.
    - Database tables
  - 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.

ATP inventory reservations data model

The ATP inventory reservations data model diagram shows the relationship between database tables that contain information about ATP inventory reservations.

Click any of the database table boxes to see more information about that table.