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
B
BIDPAYMENT
This table is deprecated and is provided for backward compatibility only.

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
        BASEITEM
        BaseItems represent a general family of goods with a common name and description. BaseItems are used exclusively for fulfillment. Each CatalogEntry that represents a Product in the catalog has a corresponding BaseItem for fulfillment purposes.
        BASEITMDSC
        Each row of this table contains language-dependent information for a BaseItem.
        BID
        This table is deprecated and is provided for backward compatibility only.
        BIDLOG
        This table is deprecated and is provided for backward compatibility only.
        BIDORDRREL
        This table is deprecated and is provided for backward compatibility only.
        BIDPAYMENT
        This table is deprecated and is provided for backward compatibility only.
        BIDPAYSUM
        This table is deprecated and is provided for backward compatibility only.
        BILLITEMS
        This table is deprecated and is provided for backward compatibility only.
        BKORDALLOC
        Each row contains information about the quantity required for this backordered order item and the amount of available inventory allocated to this item.
        BKORDITEM
        Each row contains the expected ship date of a backordered OrderItem.
        BLKRSNCODE
        Stores the various reason codes for which an Order may be blocked.
        BLKRSNDESC
        Holds Reason code description in different locales
        BROADCAST
        This table is deprecated and is provided for backward compatibility only.
        BUACCTDET
        Reserved for HCL internal use.
        BUADDR
        This table is deprecated and is provided for backward compatibility only.
        BUCONT
        This table is deprecated and is provided for backward compatibility only.
        BUSAUDIT
        This table contains the HCL Commerce business auditing records captured when the business auditing component is enabled.
        BUSCHN
        This table contains business channel information.
        BUSCHNDESC
        This table contains business channel descriptions for different locales.
        BUSEVENT
        The purpose of this table is to persist the business event object so it can be later processed by those other applications that may want to participate in the event. The table will contain a sequence column where each 4K chunk of the XML will be stored in a separate record and can be pieced back based on a unique key and the sequence. One of the objectives of this table is to ensure that the data can be easy replicated using DB2 replication.
        BUSPROF
        This table stores business profile information for a user. It is populated by the user registration commands. It is intended to be populated for users with profile type (USERS.PROFILETYPE) of "B", signifying that this is business user.
        BUYERPO
        Each row of this table represents a Purchase Order Number. It is that the Buyer organization of the Account has defined or used for Trading with the Seller organization. The number is only unique within the Account.
        BUYERPOTYP
        The Buyer Purchase Order Type table. This table defines the different types of Buyer Purchase Order for the Site.
        BUYORG
        This table is deprecated and is provided for backward compatibility only.
        BUYSUPMAP
        This table is used to register the buyer organization using procurement systems with supplier organizations.
        BUYSUPSEC
        This table is deprecated and is provided for backward compatibility only.
        BZRPENT
        This table is deprecated and is provided for backward compatibility only.
        BZRPENTAT
        This table is deprecated and is provided for backward compatibility only.
        BZRPENTSTG
        This table is deprecated and is provided for backward compatibility only.
        BZSRVCFG
        This table is deprecated and is provided for backward compatibility only.
        BZSVCCFG
        This table is deprecated and is provided for backward compatibility only.
        BZSVCSTA
        This table is deprecated and is provided for backward compatibility only.
      - C
      - D
      - E
      - F
      - G
      - H
      - I
      - J
      - K
      - L
      - M
      - N
      - O
      - 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.

BIDPAYMENT

This table is deprecated and is provided for backward compatibility only.

Column Descriptions:

Name	Type	Description
BIDPAY_ID	BIGINT NOT NULL	Reserved for HCL internal use.
BID_ID	BIGINT NOT NULL	Reserved for HCL internal use.
AUCPAYINFO_ID	BIGINT	Reserved for HCL internal use.
AMOUNT	DECIMAL (20,5) NOT NULL	Reserved for HCL internal use.
TYPE	INTEGER	Reserved for HCL internal use.
PAYTIME	TIMESTAMP	Reserved for HCL internal use.
PAYTYPE	CHAR (64)	Reserved for HCL internal use.
ENCRYPT	INTEGER	Reserved for HCL internal use.
DEVICE	VARCHAR (64)	Reserved for HCL internal use.
EXPDATE	TIMESTAMP	Reserved for HCL internal use.
BKNAME	VARCHAR (254)	Reserved for HCL internal use.
COMMENTS	VARCHAR (254)	Reserved for HCL internal use.
OPTCOUNTER	SMALLINT NOT NULL DEFAULT 0	Reserved for HCL internal use.

Indexes:

Name	Column Names	Type
<SYSTEM-GENERATED>	BIDPAY_ID	Primary Key
I0000047	TYPE	Non-Unique Index
I0000480	BID_ID	Non-Unique Index
I0001246	AUCPAYINFO_ID	Non-Unique Index

Constrained By Parent Tables:

Constraint	Columns	Parent Table	Parent Columns	Type
F_122	AUCPAYINFO_ID	AUCPAYINFO	AUCPAYINFO_ID	Cascade
F_123	BID_ID	BID	BID_ID	Cascade