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
T
TCPITMAP
This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.

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
      - E
      - F
      - G
      - H
      - I
      - J
      - K
      - L
      - M
      - N
      - O
      - P
      - Q
      - R
      - S
      - T
        TAGCLASS
        Stores the relationship between a tag and the class name of the tag's implementation class.
        TAGDISPLAY
        Defines a display type. The JSP snippet is used to define the display format when the display name is specified.
        TAGDPLYREL
        Stores the relationship between the TAGCLASS and TAGDISPLAY tables.
        TAXCGRY
        Each row in this table represents a Tax Category.
        TAXCGRYDS
        This table contains language-dependent information about a TaxCategory.
        TAXJCRULE
        When shipping from a FulfillmentCenter to a shipping address that matches one of the TaxJurisdictions in a particular TaxJurisdictionGroup. This table can be used by a tax CalculationRuleQualifyMethod to choose a CalculationRule
        TAXTYPE
        This table represents a TaxType. For example, sales tax and shipping tax are two types of taxes.
        TCATTR
        This table stores information about the terms and conditions attributes specified within a contract. This table stores the XML data required by a term and condition.
        TCDESC
        This table stores descriptions for terms and conditions for a contract.
        TCPITMAP
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        TCSUBTYPDS
        Each row in this table contains a description for a sub-type of terms and conditions.
        TCSUBTYPE
        Each row in this table contains information about the implementation of a terms and conditions sub-type.
        TCTYPE
        This table contains the types of terms and conditions.
        TDPSCNCNTR
        Each row of this table indicates that the TradingPositions in a TradingPositionContainer are available to customers of Stores where the Contract is deployed, subject to any terms and conditions associated with the Contract.
        TERMCOND
        This table contains terms and conditions used in trading agreements (business accounts, contracts, RFQs). To see how columns are used by different terms and conditions, refer to TERMCOND column mapping.
        TFALGOPOL
        Reserved for HCL internal use.
        TFALGOREG
        Reserved for HCL internal use.
        TFALGOTYPE
        Reserved for HCL internal use.
        TFALGPOLDS
        Reserved for HCL internal use.
        TFALGTYPDS
        Reserved for HCL internal use.
        TFALREGDSC
        Reserved for HCL internal use.
        TFDOMAIN
        Reserved for HCL internal use.
        TFDOMDSC
        Reserved for HCL internal use.
        TFEXTENG
        Reserved for HCL internal use.
        TFSBDOMAIN
        Reserved for HCL internal use.
        TFSBDOMDSC
        Reserved for HCL internal use.
        TFTRADENG
        Reserved for HCL internal use.
        TFTRENGDSC
        Reserved for HCL internal use.
        TICKLER
        This table holds to-do items requiring actions to resolve.
        TI_DELTA_CATENTRY
        
        TI_DELTA_CATGROUP
        
        TI_DELTA_INVENTORY
        
        TKLACTHIST
        This table holds the description of actions that can be performed on to-do items.
        TKLRACTDSC
        This table holds the description of actions that can be performed on to-do items.
        TKLRACTION
        This table holds the actions that can be performed on to-do items.
        TKLRREASON
        This table holds reasons for creating to-do items.
        TKLRRSNDSC
        This table holds description of reasons for creating to-do items.
        TMPBOLIST
        Reserved for HCL internal use. Used by ATP inventory stored procedures for temporary backorder item lists.
        TMPCMPLIST
        Reserved for HCL internal use. Used by ATP inventory stored procedures for temporary order item component list for dynamic kits.
        TMPFFCLIST
        Reserved for HCL internal use. Used by ATP inventory stored procedures for temporary fulfillment center lists.
        TMPPROCID
        Reserved for HCL internal use. Used by ATP inventory stored procedures for temporary process IDs.
        TMPRADTL
        Reserved for HCL internal use. Used by ATP inventory stored procedures for temporary RA detail records.
        TMPRCTLIST
        Reserved for HCL internal use. Used by ATP inventory stored procedures for temporary receipt lists.
        TORCPMAP
        This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.
        TRADEPOSCN
        This table represents a TradingPositionContainer. It can contain TradingPositions and can be made available to all customers, or only to customers in certain groups through the trading agreements or contracts.
        TRADING
        Each row in this table represents a TradingAgreement.
        TRANSPORT
        This table is used by the messaging system to store descriptive information about transport methods that are available at the site level.
        TRDATTACH
        This table stores information about the trading to attachment relationship for a TradingAgreement.
        TRDDEPAMT
        This table is used to keep track of deposited amounts by TradingAgreements, by Orders or OrderItems.
        TRDDESC
        The trading agreement description table.
        TRDPSCNXML
        This table is used to store the XML document for a given trading position container.
        TRDPURAMT
        This table is used to keep track of Purchase Amounts by Trading Agreements, by Orders or OrderItems. Entries are created only for Trading Agreement with Right-to-Buy by Amount or Obligation-to-Buy by Amount Terms and Conditions.
        TRDREFAMT
        This table is used to keep track of Refund Amounts by Trading Agreements, by Orders and by RMA ID. Entries are created only for Trading Agreements with Right-to-Buy by Amount or Obligation-to-Buy by Amount Terms and Conditions.
        TRDTYPE
        This table stores information about the type of trading for a TradingAgreement.
        TRDTYPEDSC
        This table stores a description for TradingAgreement types in multiple languages.
        TXCDCLASS
        Each row in this table represents a TaxClassification. A TaxClassification is a group of Tax CalculationCodes.
        TXCDSCHEME
        Each row in this table represents a TaxCodeScheme. A TaxCodeScheme is a set of TaxCodeClassifications of CalculationCodes of particular TaxTypes.
      - 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.

TCPITMAP

This table is deprecated and is provided for backward compatibility only. This table is replaced by PX_PROMOTION related tables.

Column Descriptions:

Name	Type	Description
CPWALLET_ID	BIGINT NOT NULL	Reserved for HCL internal use.
ORDERITEMS_ID	BIGINT NOT NULL	Reserved for HCL internal use.
DISCAMT	DECIMAL (20,5) NOT NULL	Reserved for HCL internal use.
OPTCOUNTER	SMALLINT NOT NULL DEFAULT 0	Reserved for HCL internal use.

Indexes:

Name	Column Names	Type
<SYSTEM-GENERATED>	CPWALLET_ID+ORDERITEMS_ID	Primary Key
I0000281	ORDERITEMS_ID	Non-Unique Index

Constrained By Parent Tables:

Constraint	Columns	Parent Table	Parent Columns	Type
F_827	ORDERITEMS_ID	ORDERITEMS	ORDERITEMS_ID	Cascade
F_828	CPWALLET_ID	CPWALLET	CPWALLET_ID	Cascade