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
M
MESSAGE
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
      - C
      - D
      - E
      - F
      - G
      - H
      - I
      - J
      - K
      - L
      - M
        MANIFEST
        One record exists for each manifest (shipment confirmation) produced for an order release. If a release is packaged in two boxes there will be two rows in the manifest table.
        MASSOC
        This table holds all of the possible semantic specifiers that can be used when associating CatalogObjects.
        MASSOCCECE
        This table holds the merchandising associations that exist between CatalogEntries.
        MASSOCGPGP
        This table holds the merchandising associations that exist between CatalogGroups.
        MASSOCTYPE
        This table holds all of the possible types of associations that can exist between CatalogObjects.
        MBINFO
        This table is deprecated and is provided for backward compatibility only.
        MBRATTR
        This table contains the custom member attributes available to be assigned to users and organizations.
        MBRATTRVAL
        This table stores the values of attributes which are defined in the MBRATTR table for members.
        MBRGRP
        This table stores member groups defined in the HCL Commerce system. A member group is a group of members. Membership is restricted to users within a member group.
        MBRGRPCOND
        This table stores the conditions for an implicit member group.
        MBRGRPDESC
        This table contains locale specific information for the entries in the MBRGRP table.
        MBRGRPMBR
        This table contains members that are explicitly included or excluded from a member group. This works in conjunction with the implicit inclusion rules that are specified by MBRGRPCOND table. If both implicit and explicit criteria are specified, the following algorithm is used to evaluate if a member belongs to a member group: Explicit exclusion takes first precedence, then explicit inclusion, and then finally implicit inclusion.
        MBRGRPTYPE
        This table stores intended usages that can be associated with member groups.
        MBRGRPUSG
        This table allows a member group to be associated with multiple member group types (or multiple intended usages).
        MBRREL
        This table stores member hierarchy relationships (ancestors and descendants) of organizational entities and registered users. Note that member groups are not part of the member hierarchy.
        MBRROLE
        This table stores role assignment for members. Each member can play one or more roles in the HCL Commerce system. When a member is assigned a role, the orgEntity for which the member plays that role can also be specified.
        MBRVIEWPRF
        This table is deprecated and is provided for backward compatibility only.
        MEMBER
        Stores the list of members (participants) of the HCL Commerce system. A member is either a user, an organizational entity or a member group.
        MEMBRAUCT
        This table is deprecated and is provided for backward compatibility only.
        MERCHANT
        This table stores the information of the value object container Credit for credit-related transactions in the payments subsystem.
        MERCHCONF
        This table stores the information of the value object container Credit for credit-related transactions in the payments subsystem.
        MERCHCONFINFO
        This table stores the NVPs for properties of merchant information for a specific merchant configuration.
        MERPROFILE
        This table is deprecated and is provided for backward compatibility only.
        MESSAGE
        This table is deprecated and is provided for backward compatibility only.
        METRIC
        This table holds the defined resource metrics used in Resource Value Unit (RVU) tracking.
        METRICSUM
        This table holds the summary count of resource metrics.
        MGPCONDELE
        This table stores member group condition elements.
        MGPCONDELENVP
        This table stores member group condition element values.
        MGPTRDPSCN
        This table is deprecated and is provided for backward compatibility only.
        MLTIME
        This table is deprecated and is provided for backward compatibility only.
        MOPICONFIG
        This table is deprecated and is provided for backward compatibility only.
        MSALESVW
        This table is deprecated and is provided for backward compatibility only.
        MSGARCHIVE
        This table holds the messages sent as a result of using a transacted send when the corresponding message type has Archive message after sent flag turned on (during message type to transport assignment).
        MSGCOUNTVW
        This view is deprecated and is provided for backward compatibility only.
        MSGMEMREL
        This table is deprecated and is provided for backward compatibility only.
        MSGSTORE
        This table holds the messages stored as a result of using a transacted send. Temporary storage space only.
        MSGTYPES
        This table is used by the messaging system to store header information about the available message types.
        MSGVIEW
        This view is deprecated and is provided for backward compatibility only.
        MUSRTRVW
        Monthly user traffic view table
      - 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.

MESSAGE

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

Column Descriptions:

Name	Type	Description
MESSAGE_ID	BIGINT NOT NULL	Reserved for HCL internal use.
MEMBER_ID	BIGINT NOT NULL	Reserved for HCL internal use.
MSGTYPE	INTEGER	Reserved for HCL internal use.
SUBJECT	VARCHAR (254)	Reserved for HCL internal use.
POSTTIME	TIMESTAMP	Reserved for HCL internal use.
CONTENT	CLOB (1000000)	Reserved for HCL internal use.
MSGPARAM1	VARCHAR (254)	Reserved for HCL internal use.
MSGPARAM2	VARCHAR (254)	Reserved for HCL internal use.
MSGPARAM3	VARCHAR (254)	Reserved for HCL internal use.
DELAY	TIMESTAMP	Reserved for HCL internal use.
BASE	TIMESTAMP	Reserved for HCL internal use.
TARGET_ID	BIGINT	Reserved for HCL internal use.
OPTCOUNTER	SMALLINT NOT NULL DEFAULT 0	Reserved for HCL internal use.

Indexes:

Name	Column Names	Type
<SYSTEM-GENERATED>	MESSAGE_ID	Primary Key
I0000156	MSGTYPE	Non-Unique Index
I0000157	DELAY	Non-Unique Index
I0000158	BASE	Non-Unique Index
I0000159	TARGET_ID	Non-Unique Index
I0000619	MEMBER_ID	Non-Unique Index

Constrained By Parent Tables:

Constraint	Columns	Parent Table	Parent Columns	Type
F_459	MEMBER_ID	MEMBER	MEMBER_ID	Cascade

Referenced By Child Tables:

Constraint	Columns	Child Table	Child Columns	Type
F_463	MESSAGE_ID	MSGMEMREL	MESSAGE_ID	Cascade