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
        CACHEIVL
        This table records changes to product or category information in the database. It can be populated by user-defined database triggers.
        CALADJUST
        A row in this table represents a calculation adjustment. A calculation adjustment is an adjustment created by a service representative to be applied to the calculation usage specified. Currently only shipping adjustments are supported.
        CALCODE
        A row in this table represents a CalculationCode. CalculationCodes represent ways of determining monetary amounts associated with OrderItems. They are used to calculate discounts, shipping charges, sales tax, and shipping tax.
        CALCODEDSC
        Each row of this table contains Language-dependent information for a CalculationCode.
        CALCODEMGP
        The CalculationCodeQualifyMethod can use the rows of this table to restrict use of a CalculationCode to members of certain MemberGroups.
        CALCODTXEX
        Each row of this table indicates that monetary amounts calculated using a particular CalculationCode are exempt from taxation of a particular TaxCategory.
        CALMETHOD
        Each row of this table defines a CalculationMethod implementation.
        CALRANGE
        Each row of this table represents a CalculationRange, which conceptually represents a row in a CalculationScale.
        CALRLOOKUP
        Each row in this table represents a CalculationRangeLookupResult, which is part of a CalculationRange.
        CALRULE
        Each row in this table represents a CalculationRule, it defines how to arrive at a monetary amount for a set of OrderItems. For each CalculationCode, one or more CalculationRules can be defined. The CalculationRules which belong to one CalculationCode are responsible for doing the calculation.
        CALRULEMGP
        A row in this table associates a CalculationRule with a MemberGroup. The discount CalculationRuleQualifyMethod can use this relationship to restrict use of the CalculationRule to members of certain MemberGroups. See the STOREMBRGP table.
        CALSCALE
        A row in this table represents a CalculationScale. It can be used to perform a scale lookup to calculate a monetary amount for a given set of OrderItems. CalculationScale defines what the charge is based on when calculating different kinds of charges. For example, the shipping charge can be charged by total price, weight, quantity, etc. CalculationScale can be associated with the CalculationRule through table CRULESCALE.
        CALSCALEDS
        Each row of this table contains Language-dependent information for a CalculationScale.
        CALUSAGE
        A row in this table represents a CalculationUsage, indicating what kind of calculation a CalculationCode or CalculationScale is used for. Examples of CalculationUsages include discounts, shipping charges, sales tax, and shipping tax.
        CAMPAIGN
        This table is deprecated and is provided for backward compatibility only.
        CATALOG
        This table holds the information related to a catalog.
        CATALOGDSC
        This table holds language-dependent information related to a catalog.
        CATCLSFCOD
        This table contains the assignment of classification codes to CatalogEntries.
        CATCNTR
        Each row of this table associates a catalog with a contract.
        CATCONFINF
        This table holds additional information for catalog entries that represent configurable products. This information may be required by an external configurator to configure this catalog entries.
        CATENCALCD
        A row in this table indicates that a CalculationCode is attached to a CatalogEntry. And it is also attached to the CatalogEntry's PRODUCT_ITEM children (or all CatalogEntries) for the specified Store. And also it is attached to TradingAgreement (or all TradingAgreements).
        CATENTATTR
        This table is deprecated and is provided for backward compatibility only. Attributes in this table should be migrated to the ATTRIBUTE and ATTRVALUE tables as descriptive attributes. The USAGE column in the target ATTRIBUTE table should not be 'null', '0' or '1' (recommended value is '2').
        CATENTDESC
        This table holds language-dependent information related to a catalog entry.
        CATENTDESCOVR
        This table is used to store information about catalog entry description override. When a field of a record in this table contains the null value, this means that there is no override for this field and the product displayed on the store front should use the field from the asset store.
        CATENTREL
        This table holds containment relationships between catalog entries. Examples of these relationships are Product-Item, Bundle, and Package relationships. This table should not be used for peer-to-peer catalog relationships, such as cross-sells.
        CATENTRY
        This table holds the information related to a catalog entry. Examples of catalog entries include products, items, packages, and bundles.
        CATENTRYATTR
        Stores the catalog entry (CATENTRY) and attribute dictionary attribute (ATTR) relationship. For example, when assigning an attribute dictionary attribute to a catalog entry, a row is created in this table with the details of the relationship between the two objects.
        CATENTRY_EXTERNAL_CONTENT_REL
        This table holds the information about the language and store specific relationship between the catalog entry and the external content the catalog entry uses.
        CATENTSHIP
        Each row in this table contains information about how a product represented by a CatalogEntry is packaged. The information can be used to determine prices, discounts, shipping charges, and taxes.
        CATENTSUBS
        Each row in this table represents the subscription related information for a catalog entry.
        CATENTTYPE
        This table defines all possible types of catalog entries. Examples of catalog entry types are CatalogEntryBean, ProductBean, ItemBean, PackageBean, BundleBean, DynamicKitBean, and PredDynaKitBean.
        CATFILTER
        Each row of this table represents a catalog filter.
        CATFLTDSC
        Each row of this table represents a language specific description of a certain catalog filter.
        CATGPCALCD
        A row in this table indicates that a CalculationCode is attached to all CatalogEntries (and their PRODUCT_ITEM children) in a CatalogGroup for the specified Store and TradingAgreement (or all TradingAgreements).
        CATGPENREL
        This table relates catalog groups (or categories) to the catalog entries that are inside them. You can also use this table to dictate the navigational flow from catalog groups to catalog entries. Each relationship is also qualified by a Catalog ID.
        CATGROUP
        This table hold the information related to a catalog group. A catalog group is similar to a generic category that can contain both other catalog groups and also catalog entries.
        CATGROUP_EXTERNAL_CONTENT_REL
        This table holds the information about the language and store specific relationship between the catalog group and the external content the catalog group uses.
        CATGRPATTR
        This table is deprecated and is provided for backward compatibility only.
        CATGRPDESC
        This table holds the language-dependent information related to a catalog group.
        CATGRPPS
        This table relates catalog groups to product sets. Every catalog entry under the catalog subtree for this catalog group is a member of the specified product set.
        CATGRPREL
        This table relates catalog groups (or categories) to child catalog group (or child categories). You can use this table to dictate the navigational flow from catalog groups to child catalog groups. Each relationship is also qualified by a Catalog ID.
        CATGRPRULE
        Relates a category to a web activity.
        CATGRPTPC
        This table relates master catalogs with trading position containers. Each catalog entry belonging to the indicated master catalog must have a standard price offer supplied for the specified trading position container.
        CATOVRGRP
        This table holds information related to the catalog override group. The catalog override group is a container to group different catalog override.
        CATPRDREL
        This table is deprecated and is provided for backward compatibility only
        CATRELTYPE
        This table describes the types of containment relationships between catalog entries, such as types for ProductItems and PackageComponents.
        CATTOGRP
        This table identifies the root catalog groups (or root categories) contained within a catalog.
        CCCHECK
        The Credit Card Check table stores the length and prefix of credit cards. This information is used by the default CheckCCNumber task command to help determine the validity of the credit card number. Initially, the CCCHECK table is empty. If no entry is found in the table for the credit card brand, the default CheckCCNumber task command calls the DoLuhnCheck task command.
        CCOMMENT
        This table stores customer comments. These are notes about interactions that a customer service representative has with a particular customer, or notes that the customer requests be recorded as part of their profile.
        CEDISPCONF
        This table stores the configuration for catalog entry display properties. An example of such property is display sequence of a product under a category.
        CEDISPCTX
        This table holds the contextual information related to the catalog entry display property configuration.
        CEDYNDISPCONF
        Reserved for HCL internal use. This table configures a rule that defines a sequence of products under a category.
        CEDYNDISPCTX
        Reserved for HCL internal use. This table holds the contextual information related to the configuration of the product dynamic sequence rule.
        CERT_X509
        This table is used to map X.509 certificate users to a unique user within the HCL Commerce system.
        CFCATGROUP
        Each row represents a selected catalog group in the catalog tree.
        CFCOND
        Each row of this table represents a condition in a certain condition group
        CFCONDGRP
        Each row of this table represents a condition group in a certain catalog filter
        CFCONDVAL
        Each row of this table represents the association between a condition and an attribute value.
        CFPRODUCTSET
        Each row represents the relationship between a catalog filter and a product set used for filtering.
        CHARGETYPE
        Charge or credit applied against a transaction which is not for product. Examples include expedite fees, customization fees, and restocking fees.
        CHKARRANG
        This table associates the defined store commands (SCHCMD) with the defined check commands (CHKCMD).
        CHKCMD
        This table contains information about check commands, which can be used by a store to determine whether scheduled jobs require execution. This information is for the Scheduler menu in the Administration Console.
        CHRGTYPDSC
        This table contains the language-dependent descriptions of the Charge Type.
        CIITEMLIST
        Each row in this table represents the relationship between an IItemlist and a member to which it is the current list.
        CLASIFCODE
        This table contains all possible product classification codes under different classification domains (such as UNSPSC, SPSC, and so on) that can be assigned to CatalogEntries.
        CLCDPROMO
        This table stores information about the relationship between the Calculation Framework and the promotion standalone infrastructure. Each calculation code matches one promotion in the PX_PROMOTION table.
        CLEANCONF
        This table contains information for the Database Cleanup utility.
        CLIENTLOCATION
        Contains client location records at a specific point in time.
        CLSATTRSRCHCONF
        The mapping table between classic attribute's name and fields in search schema.
        CLSFCODEDS
        This table contains the language specific information of product classification code.
        CMACTVERSN
        This table is part of the Content Version schema, and alias in the Commerce base schema. This table contains all content active version.
        CMBITEMS
        This table is deprecated and is provided for backward compatibility only.
        CMDREG
        This command registry allows the server to look up an implementation and default parameters for a command interface.
        CMEXTDATA
        This table contains extended data required to maintain the last modification action on a primary business object. This is an extension of information contained in the CMPRMYOBJ table. This is used for the Change History capabilities for tasks or task groups in Workspaces.
        CMFEEDLOG
        This table logs information about each feed that has been processed. It also records a hash code for the record to compare against to determine if there is an update to the record.
        CMFILE
        Contains the list of all the files that are content managed along with additional meta data.
        CMFILEDIR
        Reserved for HCL internal use. This table contains directory structures for the content managed files.
        CMFTASK
        Holds the Task information for Workspaces
        CMFTASKDSC
        Holds the task description information for tasks in workspaces.
        CMFTASKGRP
        Holds the Task Group information for Workspaces.
        CMFTGCMT
        Holds the Task Group Comments for Workspaces
        CMFTGDSC
        Holds the Task Group description information for Workspaces
        CMFTGTSKREL
        Holds the relationship between a task group and a task.
        CMFTSKMBREL
        Holds the task member-specific information. This relationship defines the tasks assigned to members. For example, workspaces contributor tasks, approval tasks will be stored in this table.
        CMFWKSPC
        Holds workspace-specific information.
        CMFWKSPCDSC
        Holds workspace description-specific information.
        CMFWSTGREL
        Holds the relationship between the Workspace and the Task Group
        CMLARGEFILE
        Contains the physical bytes that makes up a particular managed file. This table contain only the contents of those files that are greater then 32K and have a storage type of 1 in the CMFILE table.
        CMMETADATA
        Records the business objects that have changed and the associated workspaces, task groups, and tasks that have made that change. This table will be used for resource locking and for determining the business objects that will be committed and published to production.
        CMPRMYOBJ
        This table is used to a record of the last modification action on a primary business object. This is used for the Change History capabilities for tasks or task groups in Workspaces.
        CMSMALLFILE
        Contains the physical bytes that makes up a particular managed file. This table contains only the contents of those files that are less then or equal to 32K and have a storage type of 0 in the CMFILE table.
        CMVERSNCHGLOG
        This table is part of the Content Version schema, and alias in the Commerce base schema. It holds a list of objects to be versioned.
        CMVERSNCOLL
        This table is part of the Content Version schema, and alias in the Commerce base schema. This table contains the content version collection information
        CMVERSNCOLLREL
        This table is part of the Content Version schema, and alias in the Commerce base schema. This table contains the content collection and version relation information
        CMVERSNINFO
        This table is part of the Content Version schema, and alias in the Commerce base schema. This table contains the content version meta information.
        CMWORKSPACE
        Contains a list of valid workspaces that may be assigned to an available schema pool.
        CMWSSCHEMA
        The association of the underlying database schemas that makes up the workspace along with the assigning the workspace to a workspace identifier.
        CNTRDISPLY
        This table contains display information for a Contract.
        CNTRNAME
        This table contains name information for a Contract. The Contract name is used to force serialization on contract management.
        CNTRSTORE
        This table contains Store information for a Contract. The data is used to persist XML data needed by a contract to create a Store.
        COLLABWS
        This table is deprecated and is provided for backward compatibility only.
        COLLATERAL
        This table contains data describing the advertisements used by marketing campaigns.
        COLLDESC
        This table holds language-dependent information related to a Collateral.
        COLLIMGMAPAREA
        This table stores the image map information that are used in the store front pages.
        COLLTYPE
        This table defines all possible types of Collateral. Examples of Collateral types are image, flash and text.
        COMMENT
        This table holds the details of the comments for the particular approval record.
        CONTRACT
        Each row of this table represents a Contract. A Contract is part of a Store, and represents terms and conditions that may be associated with OrderItems. Such as prices, minimum quantities, and who can use the Contract.
        CONTRLRULE
        This table is deprecated and is provided for backward compatibility only.
        COUNTCODE
        Each row of this table maps the country or region abbreviation code representing a country or region to a numeric code. The mapping is dictated by the third-party product or vendor identified by the string in the PRODUCTVENDOR column.
        COUNTRY
        This table lists the country or region names in each of the supported languages identified by LANGUAGE_ID. (Note that some of the entries may store the region name rather than the official country name in the NAME column for historical reasons.)
        CPEMAILMAP
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPENDORDER
        Each row of this table indicates that an order is marked as current for a customer in a store, if its status is "P" (Pending).
        CPGNLOG
        This table is deprecated and is provided for backward compatibility only.
        CPGNSTATS
        This table is deprecated and is provided for backward compatibility only.
        CPITMAP
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPOFFER
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPPMN
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPPMNACC
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPPMNCAT
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPPMNDESC
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPPMNDISC
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPPMNORD
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPPMNPROD
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPPMNVAL
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CPWALLET
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        CREDITLINE
        Each row of this table represents a credit line the account holder (buyer organization) has with the seller organization. This credit line is associated with a specific business account.
        CRULESCALE
        Each row in this table shows that a CalculationRule is associated with a CalculationScale. Both are used by the Calculation Framework for discounts, shipping charges, taxes, and so on.
        CSEDITATT
        This table holds the attributes of the transport in the form of name-value pairs. The attributes of this table refer to connection-specific attributes of a transport. This table holds attribute information at three levels - site, store and profile.
        CTXDATA
        This table contains the data that associates with a particular activity.
        CTXMGMT
        This table contains the management information of each context service activity.
        CURCONVERT
        Each row of this table represents a rule. The rule can be used to convert a price (stored in the database in a particular currency) to an amount. The amount is what the customer will be charged in a supported shopping currency (a currency in which payment is accepted).
        CURCVLIST
        Each row of this table represents a CounterCurrencyPair. The primary use of this information is for "dual display" of European Monetary Union monetary amounts.
        CURFMTDESC
        Each row of this table represents the Language-dependent part of a currency formatting rule. It describes how to format (for display purposes) a monetary amount in a particular currency, in a particular Language.
        CURFORMAT
        Each row of this table represents the Language-independent part of a currency formatting rule. If a Store has no formatting rule for a particular currency, it uses the formatting rule of its StoreGroup.
        CURLIST
        Each row of this table represents an explicitly supported currency for a StoreEntity. A Store implicitly supports all its default currencies (see the STOREENT and STORELANG tables), and all currencies supported by its StoreGroup.
        CURMSGID
        This table is deprecated and is provided for backward compatibility only.
        CWMEMBER
        This table is deprecated and is provided for backward compatibility only.
      - 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.

C