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
A
ATTRDESC
This table holds the language sensitive attribute description. Before loading attributes in multiple languages, the attributes must already exist in the database with default data.

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
        ACACGPDESC
        This table stores all the access control policies in the system. Every policy refers to an action group, a member group, a resource group and optionally, a relationship.
        ACACTACTGP
        This table stores all the access control policies in the system. Every policy refers to an action group, a member group, a resource group and optionally, a relationship.
        ACACTDESC
        This table stores locale-specific information for Access Control actions which are stored in the ACACTION table.
        ACACTGRP
        This table stores all the access control policies in the system. Every policy refers to an action group, a member group, a resource group and optionally, a relationship.
        ACACTION
        This table stores all the access control actions in the system.
        ACATTR
        This table stores all the access control policies in the system. Every policy refers to an action group, a member group, a resource group and optionally, a relationship.
        ACATTRDESC
        This table stores all the access control policies in the system. Every policy refers to an action group, a member group, a resource group and optionally, a relationship.
        ACCCMDGRP
        This table is deprecated and is provided for backward compatibility only.
        ACCCMDTYPE
        This table is deprecated and is provided for backward compatibility only.
        ACCCUSTEXC
        This table is deprecated and is provided for backward compatibility only.
        ACCLOGMAIN
        This table contains information about access violation. Entries are created only if a violation has occurred. There will only be one entry per request. Detailed information is stored in the ACCLOGSUB table.
        ACCLOGSUB
        This table contains detailed information of the request causing access violation. The entries are linked to the ACCLOGMAIN table.
        ACCMBRGRP
        This table is deprecated and is provided for backward compatibility only.
        ACCOUNT
        Each row of this table represents a business account between a Buyer organization and a Seller organization. A business account can be used to organize various trading agreements, and to specify special trading terms and conditions.
        ACORGPOL
        This table is deprecated and is provided for backward compatibility only.
        ACPLGPDESC
        This table stores locale-specific information for the ACPOLGRP table.
        ACPLGPSUBS
        This table stores the association between access control policy groups and organizational entities. An organizational entity that is associated with a policy group is said to subscribe to that policy group. The access control policies belonging to that policy group will apply to that organization. An organization can subscribe to multiple policy groups and multiple organizations can subscribe to the same policy group.
        ACPOLDESC
        This table stores locale-specific information for the ACPOLICY table.
        ACPOLGPPOL
        This table stores the association between access control policy groups and access control policies. An access control policy that belongs to a policy group will be applied to all the organizations that subscribe to that policy group.
        ACPOLGRP
        This table stores all the access control policy groups in the system. Each row in this table represents a policy group.
        ACPOLICY
        This table stores all the access control policies in the system. Every policy refers to an action group, a member group, a resource group and optionally, a relationship.
        ACPOLSUBGP
        This table is deprecated and is provided for backward compatibility only.
        ACRELATION
        This table is a master list of all the access control relationships that exist in the system. These relationships are between resources that are protected and the members in the system.
        ACRELDESC
        This table stores the locale-specific information for the access control relationships which are stored in the ACRELATION table.
        ACRELGRP
        This table is a master list of all the access control relationship groups that exist in the system. These relationship groups are between resources that are protected and the users in the system.
        ACRESACT
        This table captures the relationship between access control resources and actions. Given a resource, you can find out the associated actions from this table.
        ACRESATREL
        This table stores the relationship between access control resources and attributes. These attributes are used to implicitly group resources. Given a resource, you can find out the supported attributes from this table. The metadata information about attributes is used in the GUI for defining resource groups and also for generating the SQL statements for filtering.
        ACRESCGRY
        This table stores all the access control resource categories in the system and the metadata information about them. The metadata includes information about the table and the columns that store the resources belonging to the resource category.
        ACRESGPDES
        This table stores locale specific display information for the ACRESGRP table.
        ACRESGPRES
        This table associates access control resource groups with resource categories (or the classes of resources). You can use this table to group various resources together based on their class names.
        ACRESGRP
        This table stores all the access control resource groups in the system. The conditions column stores an XML document containing the constraints and attribute value pairs used for grouping the resources.
        ACRESMEMRL
        This is an access control table that stores resource-member relationships for resources of different types.
        ACRESPRIM
        This table stores the primary resource column names for an access control resource. A given resource can have more than one primary column.
        ACRESREL
        This table associates an access control resource with the relationships that it supports. Given a resource, you can find out the possible relationships that it can have and also the table and the columns in which these relationships are stored.
        ACRLGPDESC
        This table stores locale-specific information for the ACRELGRP table.
        ACRSCGDES
        This table stores locale-specific information for the ACRESCGRY table.
        ADDRBOOK
        This table contains information about an address book. An address book is a container for addresses owned by a member. A member can only have one address book.
        ADDRESS
        This table stores the addresses of users or organizations in the HCL Commerce system. The addresses can be the members' own addresses or for their friends, associates, or clients, and so on. Some columns here replace columns used in previous versions.
        ALCHARGE
        Reserved for HCL internal use.
        APPEASEMENT
        This table holds the details of the order appeasements.
        APPEASEMENTITEM
        This table holds the details of the order appeasement items.
        APPLY_INIT
        This table is deprecated and is provided for backward compatibility only.
        APPLY_MEMBER
        This table is deprecated and is provided for backward compatibility only.
        APPLY_RESULT
        This table is deprecated and is provided for backward compatibility only.
        APPSJUSTREL
        This table holds the relationships between appeasements and justifications.
        ***
        ***
        ***
        ***
        ***
        APRVSTATUS
        This table contains information about the status of an approval.
        ATCHAST
        This table holds the metadata for the attachment asset in the attachment target.
        ATCHASTLG
        This table holds the attachment asset to language relationship.
        ATCHOBJTYP
        This table holds the information about the types of business objects that are configured to have attachments. For example, attachments can be associated to CATALOG, CATGROUP, and CATENTRY business objects.
        ATCHREL
        This table holds the attachment relation between a business object and an attachment target.
        ATCHRELDSC
        This is a description table for an attachment relation.
        ATCHRLUS
        This table holds usage information for attachment relations. For example, an attachment can be a warranty document related to a product. In this case the usage is 'warranty'.
        ATCHRLUSDS
        This table holds the description of an attachment relation usage.
        ATCHTGT
        This table holds information about the target, which is used to hold a collection of assets, for use as an attachment target.
        ATCHTGTDSC
        This table holds the description of an attachment target.
        ATTACHMENT
        This table contains information about Attachments. An Attachment is a supporting document for a trading document. For example, it can be a specification of a product, or a price list spreadsheet.
        ATTACHUSG
        The Attachment usage table.
        ATTR
        Stores attribute dictionary attributes. These attributes can be used for descriptive or SKU resolution purposes, and can be shared by catalog entries. Non attribute dictionary attributes used for a single catalog entry are stored in the ATTRIBUTE table.
        ATTRDESC
        This table holds the language sensitive attribute description. Before loading attributes in multiple languages, the attributes must already exist in the database with default data.
        ATTRDICT
        Table used to store the attribute dictionaries configured for the site. Each attribute dictionary is owned by a store, but can be used by children stores through store relationships. There can be only one attribute dictionary owned by any given store.
        ATTRDICTGRP
        Table used to store attribute dictionary attribute groups. These groups are a convenience mechanism used during administration of the attribute dictionary and when assigning attribute dictionary attributes to catalog entries or catalog groups. Attributes can belong to zero or more attribute groups.
        ATTRDICTGRPATTRREL
        Stores the relationship between the attribute dictionary group and the attribute dictionary attribute.
        ATTRDICTGRPDESC
        The table holds the attribute dictionary group description
        ATTRDICTGRPREL
        Defines the relationships between attribute dictionary attribute groups. An attribute dictionary attribute group can have only one parent group.
        ATTRDICTSRCHCONF
        The mapping table between attribute dictionary attribute's identifiers and fields in search schema.
        ATTRIBUTE
        This table holds catalog entry attributes used for descriptive or SKU resolution purposes. An attribute stored in this table is for a single catalog entry and is not shared between catalog entries. Attribute dictionary attributes are stored in the ATTR table.
        ATTRTYPE
        This table holds the type identifier for product attributes.
        ATTRVAL
        This table holds an attribute value that can be a shareable global attribute value or a local attribute value defined for a catalog entry.
        ATTRVALDESC
        This table holds the language sensitive attribute value description.
        ATTRVALUE
        This table holds the values assigned to product attributes and relates them back to catalog entries for SKU resolution.
        ATTR_EXTERNAL_CONTENT_REL
        Reserved for HCL internal use.
        AUCPAYINFO
        This table is deprecated and is provided for backward compatibility only.
        AUCTBIDVW
        This view is deprecated and is provided for backward compatibility only.
        AUCTDESC
        This table is deprecated and is provided for backward compatibility only.
        AUCTION
        This table is deprecated and is provided for backward compatibility only.
        AUCTIONLOG
        This table is deprecated and is provided for backward compatibility only.
        AUCTSTRREL
        This table is deprecated and is provided for backward compatibility only.
        AUCTSTYLE
        This table is deprecated and is provided for backward compatibility only.
        AUCTVIEW
        This view is deprecated and is provided for backward compatibility only.
        AUTOBID
        This table is deprecated and is provided for backward compatibility only.
        AUTOBIDLOG
        This table is deprecated and is provided for backward compatibility only.
      - B
      - 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.

ATTRDESC

This table holds the language sensitive attribute description. Before loading attributes in multiple languages, the attributes must already exist in the database with default data.

Column Descriptions:

Name	Type	Description
ATTR_ID	BIGINT NOT NULL	The reference number to an attribute in the ATTR table.
LANGUAGE_ID	INTEGER NOT NULL	The language for this attribute description.
ATTRTYPE_ID	CHAR (16) NOT NULL	The attribute type.
NAME	VARCHAR (254) NOT NULL	The name of the attribute.
DESCRIPTION	VARCHAR (254)	The attribute description.
DESCRIPTION2	VARCHAR (254)	An additional description field for this attribute
FIELD1	VARCHAR (254)	Customizable field
GROUPNAME	VARCHAR (64)	Specifies the name of the group of attributes. All related attributes should be created with the same group name.
QTYUNIT_ID	CHAR (16)	The units in which this attribute is measured.
NOTEINFO	VARCHAR (64)	Auxiliary attribute data such as a footnote.
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>	ATTR_ID+LANGUAGE_ID	Primary Key
I0001465	LANGUAGE_ID	Non-Unique Index
I0001466	ATTRTYPE_ID	Non-Unique Index
I0001467	QTYUNIT_ID	Non-Unique Index

Constrained By Parent Tables:

Constraint	Columns	Parent Table	Parent Columns	Type
F_3556	ATTR_ID	ATTR	ATTR_ID	Cascade
F_3557	ATTRTYPE_ID	ATTRTYPE	ATTRTYPE_ID	Cascade
F_3558	LANGUAGE_ID	LANGUAGE	LANGUAGE_ID	Cascade
F_3559	QTYUNIT_ID	QTYUNIT	QTYUNIT_ID	Cascade

Referenced By Child Tables:

Constraint	Columns	Child Table	Child Columns	Type
F_3562	ATTR_ID+LANGUAGE_ID	ATTRVALDESC	ATTR_ID+LANGUAGE_ID	Cascade