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
R
RULEVALUE
This table is deprecated and is provided for backward compatibility only.

Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
- Getting started
  HCL Commerce has different advantages for business users, administrators and developers. HCL Commerce targets each of these roles with a tailored set of offerings so that each of your users can get maximum benefit.
- Installing and deploying
  Learn how to install and deploy HCL Commerce development environments and HCL Commerce production environments.
- Migrating
  Before you migrate to HCL Commerce Version 9, review this information to help plan and execute your migration.
- Operating
  Topics in the Operating category highlight tasks that are typically performed by business users, customer support representatives, to complete their day-to-day tasks in the operation of the HCL Commerce site.
- Integrating
  Topics in the Integrating category highlight the tasks that are commonly performed for using HCL Commerce in combination with other products.
- Administering
  Topics in the Administering category highlight tasks that are typically performed by the Site Administrator, to support daily operations of the HCL Commerce site.
- Customizing
  The topics in the Customizing section describe tasks performed by an application developer to customize HCL Commerce.
- Tutorials
  HCL Commerce provides many tutorials to help you customize and understand your HCL Commerce instance and stores.
- Samples
  Topics in the Samples category highlight the various samples that are provided with HCL Commerce.
- Compliance
  The following section describes how you can leverage HCL Commerce features and functionality to help your site be compliant with different privacy and security standards.
- Securing
  These topics describe the security features of HCL Commerce and how to configure these features.
- Performance
  Topics in the Performance section describe the means by which to plan, implement, test, and re-visit the optimization of HCL Commerce site performance.
- Troubleshooting
  Topics in the Troubleshooting section highlight common issues that are encountered with HCL Commerce, and how they can be addressed or mitigated.
- Reference
  Topics in the Reference section contain all of the HCL Commerce reference documentation.
  - HCL Commerce API reference
    HCL Commerce exposes two main programming APIs. The first and newest API is a REST interface, and most new classes are exposed here. The legacy Java API also contains new classes not suitable for REST, and can be browsed in Javadoc format.
  - Cross-reference of data beans and tables
    Data beans are grouped into several component groups.
  - Cross-reference of commands, tasks, and tables
    URL commands, controller commands, task commands, view commands and tables are related to each other.
  - Cross reference: Commands to beans to database tables
    Use this information when you are customizing a command and you want to know which tables are affected. You should also use this topic if you are modifying a table and want to know which commands and beans are affected.
  - Run Engine commands
    The following Run Engine commands are available by default for you to configure the applications that are running inside the containers.
  - Entering Docker containers
    To enter a Docker container you can complete the following steps.
  - Docker container start up logic for 9.0.0.0 and 9.0.0.1
    When you deploy a container from an HCL provided image, an Entrypoint.sh helper script determines the configurations to use while starting up the container. Review the following information to learn about what the helper script does, and how you can customize the configurations.
  - Docker container start up logic for HCL Commerce Version 9.0.0.2 or later
    When you deploy a container from an HCL provided image, an Entrypoint.sh helper script determines the configurations to use while starting up the container. Review the following information to learn about what the helper script does, and how you can customize the configurations.
  - HCL Commerce database schema
    The HCL Commerce database model was designed for data integrity and optimal performance. HCL Commerce provides several hundred tables that store HCL Commerce instance data. To maintain data integrity, and to ease maintenance referential integrity, constraints are widely used in the database model. Indexes are used carefully on tables to avoid over-indexing and to provide a good balance between data retrieval and data manipulation activities (insert and update). The business rules are implemented at the application level rather than by using database trigger. Triggers, however, are used to facilitate data staging and optimistic locking. A limited number of SQL-based database stored procedures are used for data intensive activities.
    - Column data type considerations
      Several column data types are available for you to use when you are creating new database table or columns.
    - Schema changes from Version 8 to Version 9
      Database tables and columns within the HCL Commerce Version 9 database schema can differ from the tables and columns in the database schema for HCL Commerce Version 8.
    - Deprecated tables and columns
      If a database table or column is marked as deprecated, then the table or column is outdated by newer constructs. Deprecated sections are supported for reasons of compatibility with an earlier version only. These tables or columns are obsolete or can become obsolete in future versions of HCL Commerce.
    - Data models
      Any given database data model displays the relationship among database tables in the schema.
    - Database tables
      - A
      - B
      - C
      - D
      - E
      - F
      - G
      - H
      - I
      - J
      - K
      - L
      - M
      - N
      - O
      - P
      - Q
      - R
        RA
        Records general information about inventory expected from a vendor. "RA" stands for Replenishment Advisement. However, the term "Expected Inventory Record" is used to mean the same thing.
        RABACKALLO
        Each row contains information about how backorders are allocated against expected inventory.
        RADETAIL
        This table contains detailed information about items on an expected inventory record.
        RCPTAVAIL
        Defines which DistributionArrangements have access to received inventory.
        RCPTITMVW
        A view which summarizes the quantity of inventory available from the RECEIPT table for an item across all Stores and FulfillmentCenters.
        RCPTSTFFVW
        A view which summarizes the quantity of inventory available from the RECEIPT table for an item owned by a Store at a FulfillmentCenter.
        RCPTSTVW
        A view which summarizes the quantity of inventory available from the RECEIPT table for an item owned by a Store across all FulfillmentCenters.
        RECEIPT
        Each row contains information about each receipt of an item at a FulfillmentCenter.
        REFKEYS
        Each row of this table defines a new primary-foreign relationship between two tables of the commerce. This option provides a specific application/business to impose a primary-foreign relationship instead of creating a new constraint at the metadata level. Thus it avoids possible frequent changes in the database metadata. This relations are picked up by the IdResolver in the process of resolution of Identifiers.
        REFUNDMTHD
        This table is deprecated and is provided for backward compatibility only.
        REPCUSTREL
        This table defines the relationship between a customer service representative or team of representatives, and the customer or customer group that they are assigned to.
        REPDLVRY
        This table describes how StoreEntities want their automated commerce reports to be delivered.
        REPORT
        This table is deprecated and is provided for backward compatibility only.
        RFQ
        This table holds basic RFQ data.
        RFQCATEGRY
        This table holds categories created in each RFQ.
        RFQPROD
        RFQ Request and Product relationship table. This table stores information about the products requested in an RFQ.
        RFQRSP
        RFQ Response table. This table stores the basic RFQ response information.
        RFQRSPEVAL
        This table holds all the response product evaluations for the RFQ.
        RFQRSPPARL
        This table holds the relationship of the personalized attributes in the RFQ and the response.
        RFQRSPPROD
        RFQ response and product relationship table. This table stores the products included in a specific RFQ Response.
        RFQRSPTCRL
        The relationship between one specified RFQ term or condition, and an RFQ Response to this term or condition.
        RFQTARGET
        This table holds the target stores for RFQs.
        RICHATTR
        This summary table relates Attribute to AttrValue for each Catalog Entry. It contains pre-computed results based on the data existing in the underlying ATTRIBUTE and ATTRVALUE tables.
        RICHATTRCG
        This summary table relates Attribute to AttrValue for Catalog Entries in each CatGroup. It contains pre-computed results based on the data existing in the underlying ATTRIBUTE and ATTRVALUE tables.
        RLDISCOUNT
        This table is deprecated and is provided for backward compatibility only.
        RMA
        This table is a container for return merchandise authorizations (RMAs).
        RMAAUTHLOG
        This table is a log of when each return merchandise authorization (RMA) was authorized. A single RMA may appear multiple times if changes were made and the RMA was re-authorized.
        RMACHARGE
        This table stores charges or credits, applied to a return merchandise authorization (RMA), which are not for salable products or services. This can be applicable to the entire RMA or to a specific RMA item, such as restocking fees or shipping credits.
        RMAIADJCRD
        This table stores return merchandise authorization (RMA) item adjustment credits. These are the portion of an order item adjustment that is to be refunded to the buyer.
        RMAIDNYRSN
        A joint table which specifies reasons for denying a return merchandise authorization (RMA) item. Note: There is no similar table for rejecting an RMA. If you wish to reject an entire RMA, you must reject each RMA item individually.
        RMAITEM
        This table stores item information for a return or credit for a return merchandise authorization (RMA).
        RMAITEMCMP
        This table describes the smallest unit of inventory items involved in a return merchandise authorization (RMA).
        RMAITEMSERIAL
        This table is used to track return serial numbers.
        RMATAX
        This table stores return merchandise authorization (RMA) tax credits.
        ROLE
        This table stores the roles defined in WebSphere Commerce. Once a role is created, you cannot change the name or description of a role using a graphical user interface tool.
        ROLEASNPRM
        Role Assignment Permission table. This table specifies the roles that users with a particular assigning role are able to assign to other users.
        ROLEDESC
        Stores translatable descriptions for the roles.
        RTNDNYDESC
        This table stores the language-dependent descriptions of the reasons for denying return merchandise authorizations (RMAs).
        RTNDNYRSN
        This table stores denial reasons for return merchandise authorization (RMA) items. These are the reasons for which an RMA item was not automatically approved by the system.
        RTNDSPCODE
        This table stores return disposition codes to describe how a received item is disposed.
        RTNDSPDESC
        This table stores the language-dependent description of a return disposition code.
        RTNRCPTDSP
        This table describes how a returned item has been disposed.
        RTNREASON
        This table stores the reason for customer dissatisfaction with a product.
        RTNRECEIPT
        This table stores the receipt record that indicates a returned item from a return merchandise authorization ( RMA). This returned item specifies that the item has been received. It also has information about the received items.
        RTNRSNDESC
        This table stores the language-dependent description of the return reason codes.
        RULECLSREG
        This table is deprecated and is provided for backward compatibility only.
        RULEVALUE
        This table is deprecated and is provided for backward compatibility only.
      - 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.

RULEVALUE

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

Column Descriptions:

Name	Type	Description
RULEVALUE_ID	INTEGER NOT NULL	Reserved for HCL internal use.
WORKINGPUBLISHABLE	INTEGER NOT NULL	Reserved for HCL internal use.
COMMITTEDPATH	VARCHAR (1024)	Reserved for HCL internal use.
WORKINGPATH	VARCHAR (1024) 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>	RULEVALUE_ID	Primary Key