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
D
DISPCGPREL
This table holds the page names used to display CatalogGroups. The selection is based on Store, MemberGroup, DeviceType, CatalogGroup, Language, or any combination of the above. If many pages satisfy the criteria, the page that best fits will be chosen.

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.
    - Database tables
      - A
      - B
      - C
      - D
        DAEMON
        This table is deprecated and is provided for backward compatibility only
        DBDELIVERY
        This table is deprecated and is provided for backward compatibility only
        DBDTFREQ
        This table is deprecated and is provided for backward compatibility only
        DBMEAS
        This table is deprecated and is provided for backward compatibility only
        DBMEASFM
        This table is deprecated and is provided for backward compatibility only.
        DBTEMPLATE
        This table is deprecated and is provided for backward compatibility only.
        DBVIEW
        This table is deprecated and is provided for backward compatibility only.
        DEVICEFMT
        This table is for defining all the device format types.
        DISPCGPREL
        This table holds the page names used to display CatalogGroups. The selection is based on Store, MemberGroup, DeviceType, CatalogGroup, Language, or any combination of the above. If many pages satisfy the criteria, the page that best fits will be chosen.
        DISPENTREL
        This table holds the page names used to display CatalogEntries. The selection is based on Store, MemberGroup, DeviceType, CatalogEntryType, CatalogEntry, AuctionState, Language, or any combination of the above.
        DISTARRANG
        Each row of this table represents a DistributionArrangement, enabling a Store to sell its own inventory.
        DKADJMNT
        Stores adjustments to components within a specific dynamic kit. This table is not used with the Sterling Configurator dynamic kit integration provided with HCL Commerce Feature Pack 3.
        DKOFFER
        Stores prices of components within a dynamic kit. This table is not used with the Sterling Configurator dynamic kit integration provided with HCL Commerce Feature Pack 3.
        DKOFFERADJMNT
        Stores offer adjustments to components within a specific dynamic kit.
        DKPDCCATENTREL
        Contains relationships between predefined configurations and the dynamic kit catalog entries for which they are built.
        DKPDCCOMPLIST
        Contains the components within a predefined configuration.
        DKPDCDESC
        Contains the descriptions of predefined configurations.
        DKPDCOFFERREL
        Contains relationships between predefined configurations and the offers that price them.
        DKPDCREL
        Reserved for HCL internal use. Stores the complete structure of a pre-defined Nested Dynamic Kit. (No longer supported)
        DKPREDEFCONF
        Contains predefined configurations of dynamic kit catalog entries.
        DMACTATTR
        Attributes of a marketing activity.
        DMACTIVITY
        A definition of the interaction with a customer to market content.
        DMACTTYPE
        Types of marketing activities. These include web, e-mail, dialog, search, and pageLayout.
        DMCAMPAIGN
        A group of activities to meet specific marketing objectives.
        DMELEMENT
        Campaign elements associated with a marketing activity.
        DMELEMENTNVP
        Name value pairs associated with a campaign element.
        DMELEMENTTYPE
        Types of trigger, target and action campaign elements for an activity.
        DMELESTATS
        Statistics of trigger, target and action campaign elements within an activity.
        DMELETEMPLATE
        Template definitions of trigger, target, and action campaign elements. A trigger is used to wait for a customer to do something, or to wait for a certain period of time to elapse. When a trigger occurs, the activity flow can continue from where the trigger was defined in the flow. A target is used to qualify customers for subsequent actions or continue execution of the activity flow. Targets are usually based on a customer's behavior and segmentation. An action is a step to perform as part of the activity flow. Actions are the "to do" based on the previous sequence of triggers and targets. Most actions are for marketing purposes, such as display content in an e-marketing spot, or send the customer an e-mail.
        DMEMSPOTCMD
        The ordering scheme set up for stores and individual e-MarketingSpots.
        DMEMSPOTCOLLDEF
        This is a relationship table between an e-Marketing Spot and a Collateral, which stores the e-Marketing Spot label.
        DMEMSPOTDEF
        The default content to display in an e-Marketing Spot.
        DMEMSPOTORD
        A list of ordering schemes in which to order marketing content displayed in an e-MarketingSpot.
        DMEMSPOTPAGE
        This table is currently not used. Can be used to relate e-Marketing Spots to store pages.
        DMEMSPOTSTATS
        Statistics for an e-MarketingSpot within a marketing activity.
        DMEXPFAMILY
        The set of related marketing activities.
        DMEXPLOG
        This table contains the details of what was displayed to a customer on a store page in an e-Marketing Spot as a result of an experiment.
        DMEXPSTATS
        This table stores the statistics related to marketing experiments.
        DMEXPTYPE
        The types of experiments associated with a marketing activity
        DMMBRGRPPZN
        This table contains customers that are explicitly included in a member group by the customer's personalization ID. This works in conjunction with the explicit inclusion and exclusion rules that are specified in the MBRGRPMBR table and the implicit inclusion rules that are specified in the MBRGRPCOND table. If both multiple criteria are specified, the following algorithm is used to evaluate if a member belongs to a member group: Explicit exclusion by member ID takes first precedence, then explicit inclusion by member ID, then inclusion by personalization ID, and then finally implicit inclusion.
        DMPAGE
        A list of store pages with EMarketingSpots to display marketing content.
        DMRANKINGITEM
        This table stores calculated ranking information. For example, the top 10 products purchased in a category, or the top 5 browsed products in a category. Each ranking item under a ranking group has a sequence.
        DMRANKINGSTAT
        This table stores collected information used to generate a ranking list. For example, when a relevant product is purchased or browsed, the data will be recorded in this table.
        DMTEMPLATETYPE
        Types of marketing activity templates.
        DMTRIGLSTN
        List of triggers that are being listened for in marketing activities.
        DMTRIGSND
        Time based triggers to send when the specified time has elapsed.
        DMUSERBHVR
        A customer's behavior within a site, and within a marketing activity.
      - 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.

DISPCGPREL

This table holds the page names used to display CatalogGroups. The selection is based on Store, MemberGroup, DeviceType, CatalogGroup, Language, or any combination of the above. If many pages satisfy the criteria, the page that best fits will be chosen.

Column Descriptions:

Name	Type	Description
CATGROUP_ID	BIGINT NOT NULL	The reference number of the CatalogGroup for which this page name will be displayed. A value of 0 indicates that this page name will be used for all CatalogGroups.
DISPCGPREL_ID	BIGINT NOT NULL	The reference number of this entry.
LANGUAGE_ID	INTEGER	The language in which this page displays. For a list of language components, see the LANGUAGE table.
DEVICEFMT_ID	INTEGER NOT NULL	The reference number of the device type that the page will be displayed on. Foreign key to the DEVICEFMT table.
PAGENAME	VARCHAR (254) NOT NULL	The name and path of the display page template. The path is relative to the application document root.
STOREENT_ID	INTEGER NOT NULL	The reference number of the Store for which this page will be displayed.
MBRGRP_ID	BIGINT NOT NULL	The reference number of the MemberGroup for which this template page will display. A value of 0 indicates that this template page will be used for all MemberGroups.
DESCRIPTION	VARCHAR (254)	A descriptive comment of this entry.
RANK	DOUBLE	A sequence number used to break ties when more than one page satisfies the selection criteria. The larger the rank, the lower the precedence of the page.
FIELD1	VARCHAR (254)	Customizable.
FIELD2	VARCHAR (254)	Customizable.
OID	VARCHAR (64)	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
<SYSTEM-GENERATED>	DISPCGPREL_ID	Primary Key
I0000091	DEVICEFMT_ID+STOREENT_ID+CATGROUP_ID+MBRGRP_ID+RANK+LANGUAGE_ID	Unique Index
I0000554	STOREENT_ID	Non-Unique Index
I0000555	CATGROUP_ID	Non-Unique Index
I0000556	MBRGRP_ID	Non-Unique Index

Constrained By Parent Tables:

Constraint	Columns	Parent Table	Parent Columns	Type
F_297	LANGUAGE_ID	LANGUAGE	LANGUAGE_ID	Cascade
F_298	CATGROUP_ID	CATGROUP	CATGROUP_ID	Cascade
F_299	STOREENT_ID	STOREENT	STOREENT_ID	Cascade
F_300	DEVICEFMT_ID	DEVICEFMT	DEVICEFMT_ID	Cascade
F_301	MBRGRP_ID	MBRGRP	MBRGRP_ID	Cascade