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
P
PAYMTHDSUP
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.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
        PAGELAYOUT
        This table contains information about various layouts present in the system
        PAGELAYOUTTYPE
        This table defines the group of a layout or a page. If using the Commerce Composer capability for your store, a relationship from the PAGELAYOUT table is used only for specifying a default page layout for a particular page group (or PAGELAYOUTTYPE). A relationship from the PLPAGE table represents the grouping (or PAGELAYOUTTYPE) of page. Example types for a default page layout or page include: - Category - Content - Search - Product - Kit - Bundle - DynamicKit If using the Page Layout capability for your store, this table defines the type of layout. Example values include: - HomePage - CategoryPage - ProducPage etc.
        PAREQINFO
        This table is deprecated and is provided for backward compatibility only.
        PARTICIPNT
        This table stores information about a participant for a TradingAgreement.
        PARTROLE
        This table stores role information about a participant for a TradingAgreement.
        PARTROLEDS
        This table stores descriptions for the role a participant plays a TradingAgreement.
        PASTATS
        This table is deprecated and is provided for backward compatibility only.
        PATTRDESC
        Reserved for HCL internal use.
        PATTRIBUTE
        This is the personalization attribute supported by the site.
        PATTRPROD
        The relationship table between the PATTRIBUTE and CATENTRY tables.
        PATTRVALUE
        The personalization attribute value table. This table holds the values associated with personalization attributes.
        PAYMTHD
        This table is deprecated and is provided for backward compatibility only.
        PAYMTHDDSC
        This table is deprecated and is provided for backward compatibility only.
        PAYMTHDSUP
        This table is deprecated and is provided for backward compatibility only.
        PAYSTATUS
        Reserved for HCL internal use.
        PAYSUMMARY
        Each row of this table stores a payment summary XML that could be sent to an external accounting system. The summary is by Store, Account, and payment policy.
        PAYSYNCH
        Reserved for HCL internal use.
        PCSTATS
        This table is deprecated and is provided for backward compatibility only.
        PESTATS
        This table is deprecated and is provided for backward compatibility only.
        PICKBATCH
        This table contains pick batch information. A pick batch groups together order releases for their processing as a unit at a FulfillmentCenter. It picks inventory for OrderItems, packs them into boxes, and ships to customer through selected carrier.
        PKGATTR
        This table holds package attributes. Package attributes are inherited from the attributes of the products that are contained within packages.
        PKGATTRVAL
        This table holds the values assigned to package attributes. Package attribute values are inherited from the attribute values of the products that are contained within packages.
        PKGITEMREL
        This table is deprecated and is provided for backward compatibility only.
        PLCYACCDSC
        This table holds language-dependent information related to an account policy.
        PLCYACCLCK
        This table contains the account lockout policies for users.
        PLCYACCT
        This table stores the user account policies that consist of an account lockout policy and a password policy.
        PLCYLCKDSC
        This table holds language-dependent information related to an account lockout policy.
        PLCYPASSWD
        This table stores password policies.
        PLCYPWDDSC
        This table holds language-dependent information related to a password policy.
        PLCYTYCMIF
        This table stores command interface relationship information for a business policy.
        PLCYTYPDSC
        This table describes the type of business policy for a policy.
        PLLOCATION
        Specifies an indirect mapping between store pages and the location where they are used in the store. For every assignment of a page layout to a page, a web activity is created and referenced in this table. A 1:1 mapping exists between a page layout location and a web activity. The web activity determines which layout is used on a given page. This table provided the association between the layout and locations which you can see displayed through business tools.
        PLLOCSTATIC
        This table contains information about the static assignment of a layout to a user. Each PAGELAYOUT entry can have at most one entry in this table.
        PLPAGE
        Each entry specifies a page in the web site. A page is defined by an administrative name, type of page, URL and SEO metadata.
        PLPROPERTY
        This table contains information about the properties of a layout.
        PLSTOREWIDGET
        Each row specifies the relationship between a store and available widgets. Each available widget is allowed to be added to page layouts within the specified store.
        PLTEMPLATEREL
        This table stores the relationship between a page layout and the original page layout template it was based on.
        PLWIDGET
        This table contains the association of widgets to page layouts.
        PLWIDGETDEF
        Contains information about all widgets registered on the system.
        PLWIDGETDEFDESC
        Contains language specific descriptions for each widget in PLWIDGETDEF.
        PLWIDGETNVP
        This table contains information about the properties configured for a widget or container. Widgets and containers have properties when configured on a page layout.
        PLWIDGETREL
        This table contains information about the relationship between widgets on a page layout. Defines a hierarchy of containers and widgets on a page.
        PLWIDGETSLOT
        Used by the business tool to display and name slots on a page layout. This table defines the configurable slots on a page layout.
        POIDESC
        Contains Point of Interest (POI) record descriptions.
        POINTOFINTEREST
        Contains Point of Interest (POI) records.
        POLICY
        Each row of this table indicates that the TradingPositions in a TradingPositionContainer are available to customers of Stores. There the Contract is deployed, subject to any terms and conditions associated with the Contract.
        POLICYCMD
        This table stores command relationship information for a business policy.
        POLICYDESC
        This table stores descriptions for a business policy.
        POLICYTC
        This table stores information about which business policy is referenced by a specific term or condition.
        POLICYTYPE
        This table stores information about the type of business policy for a policy.
        PPCBATCH
        The batch object representing the batch transaction
        PPCCREDIT
        This table stores the information of the value object container Credit for credit-related transactions in the payments subsystem.
        PPCEXTDATA
        This table stores the non-standard protocol data required in the financial transaction which goes beyond the standard attributes defined in the payment instruction. It can be associated with a payment instruction or a financial transaction. When associated with a payment instruction, it can be used by all the financial transactions executed against the same payment instruction. When associated with a financial transaction, this extra data can be used by this same transaction and subsequent transactions.
        PPCPAYINST
        This table stores the value object Payment Instruction in HCL Commerce which contains the detailed information required by plug-ins to process financial transactions. The amount in the payment instruction can be used by plug-ins to determine what is the maximum target amount the payments subsystem intends to consume collectively.
        PPCPAYMENT
        This table stores the information of the value object container Payment for payment-related transactions in the payments subsystem.
        PPCPAYTRAN
        This table stores the information of a financial transaction processed by a payment plug-in.
        PRATRSTATR
        Reserved for HCL internal use.
        PRCEOFFPRD
        Reserved for HCL internal use.
        PRCOFFRPRC
        Reserved for HCL internal use.
        PRCONSTANT
        Each row of this table represents a price constant. Price constant is a reusable number or monetary value with a name indicating its business meaning. For example, a constant 'Uplift for EU countries' is used to increase prices in EU countries.
        PRCONVALUE
        Each row of this table represents a price constant value. Price constant value could be number or monetary amount.
        PRCORSN
        Price Override Reason - This table stores the reason the merchant needed to override a system calculated price.
        PRCORSNDSC
        Price Override Reason Description - This table stores the language-dependent description of the price override reason codes.
        PRDATRAVAL
        Reserved for HCL internal use.
        PRELEMENT
        Each row of this table represents a price rule element. Multiple elements function together to determine the flow of a price rule. For example, price rule element could be price list, condition, equation, branch and coordinator etc.
        PRELEMENTATTR
        Each row of this table represents a price rule attribute. A price rule attribute is a name-value pair used for price rule evaluation at runtime. For example, the element of PriceList type may have an attribute with the name 'priceListId' and the value '10001'.
        PRELETEMPLATE
        Each row of this table represents a price rule element template. Elements which share the same template use the same element command but different parameters for price rule evaluation at runtime. For example, customer segment condition is an element template.
        PRELETPLTGRP
        Each row of this table represents a price rule element template group. An element template group includes one or more element templates which have the similar attributes and behaviors. For example, both category condition and customer segment condition are under the same template group (condition).
        PREQENTRY
        Each row of this table represents an equation entry (unit) for an equation. Multiple equation entries function together to compose an equation. For example, the equation "Master Price List * 0.5" is composed of 3 equation entries: "Master Price List","*","0.5".
        PREQENTRYTYPE
        Each row of this table represents an equation entry type.Currently there are following types:PriceList,Operator,Parenthesis,Number,PriceConstant,InputPrice.
        PREQUATION
        Each row of this table represents a price equation. Price equation is an expression for price calculation. The parameters used in the equation can include the input price, price lists, price constants etc. For example, the equation "Input Price + Distribution cost" means the final price will be the sum of the Input Price and Distribution cost.
        PREVIEWTOKEN
        This table contains preview tokens generated for service preview and store preview links.
        PRICERULE
        Each row of this table represents a price rule in a store. Price rule is a business rule which defines how to get a dynamic price under different business conditions.
        PROCBUYPRF
        This table contains the buyer organization specific profile information of procurement system protocols to support Procurement System integration.
        PROCESSFILE
        Stores all the information related to the file process.
        PROCMSGVW
        This table contains the view names used to compose the response message sent to procurement systems. Response message composition can be customized (per buyer, per protocol) using this table.
        PROCPROTCL
        Each row of this table represents a procurement system protocol and its version number. For example, cXML, OCI, OBI, and so on.
        PROCSYS
        Each row of this table represents a Procurement System.
        PRODATR
        Reserved for HCL internal use.
        PRODSETDSC
        This table holds the language-dependent information related to product sets.
        PRODUCTSET
        This table holds the definition of a product set. The actual representation of the product set is held in the PRSETCEREL table.
        PROFILE
        This table is used by the messaging system to store profile data. Specifically, it defines what transports are to be used for particular stores, message types, and priorities. It also holds other administrative information
        PROFNVSTRG
        This table holds additional attributes for the profiles in the form of name-value pairs. Can be utilized for user-attributes.
        PRSETCEREL
        This table holds the expanded (published) form of a ProductSet.
        PSETADJMNT
        This table stores information on product set adjustments and shows which product set is referenced by a term and condition for a business policy.
        PURCHASELT
        This table stores information on stipulations or limitations on how much a customer can purchase based on a Contract.
        PVCBINDING
        This table represents a relationship between a customer and a terminal for pervasive computing.
        PVCBUFFER
        This table stores the command input data which needs to be submitted over several pages of pervasive computing devices.
        PVCDEVMDL
        This table stores device model information. Records will be looked up by the value returned by the HCL Commerce pervasive computing adapter. Each subclass of PVCAdapterImpl is responsible to get a device model name from the HTTP request.
        PVCDEVSPEC
        This table represents minimum specification of pervasive computing devices which are categorized by PVCMDLSPEC. Records of this table will be set in the appropriate adapter.
        PVCMDLSPEC
        The table contains different model specification mapping for each store. PVCMDLSPEC represents relationship among records in the PVCDEVMDL and the PVCDEVSPEC database tables.
        PVCSESSION
        This table manages the session of various pervasive computing devices.
        PX_CDPOOL
        This table contains all the promotion codes available to shoppers.
        PX_CDPOOL_ERROR
        This table is used to temporarily store errors during promotion code generation on Oracle. This table has the same columns as the PX_CDPOOL table with a few additional columns for Oracle's use. Note: This table only exists on the Oracle database.
        PX_CDPROMO
        This table is deprecated and is provided for backward compatibility only.
        PX_CDSPEC
        This table contains addition promotion code information.
        PX_CDUSAGE
        This table contains all the promotion code usage information. The recording of public promotion code usage must be enabled before this table includes usage information for public promotion codes.
        PX_COUPON
        This table contains all of the coupons issued to individual customers.
        PX_DESCRIPTION
        This table contains promotion description information.
        PX_DYNATTR
        This table contains the details about any dynamic attributes that belong to promotion entities, such as promotion groups, promotion policies, and others.
        PX_ELEMENT
        This table contains promotion element information.
        PX_ELEMENTNVP
        This table contains promotion element values.
        PX_GROUP
        Contains the promotion group information.
        PX_GRPPOLICY
        This table contains relationships between promotion groups and promotion policies.
        PX_POLICY
        This table contains promotion policies.
        PX_PROMOARG
        This table contains details about how promotions are applied to an order.
        PX_PROMOAUDIT
        This table contains obsolete promotion information for auditing purpose.
        PX_PROMOAUTH
        This table contains additional authoring information that is managed by the Promotions tool in the Management Center user interface.
        PX_PROMOCD
        This table contains promotion and promotion code relation information.
        PX_PROMOPOLICY
        This is table is intended for customization, which contains the relationship between a promotion policy with a promotion. This table is not used with default implementation.
        PX_PROMOTION
        This table contains promotions.
        PX_PROMPROM
        This table is deprecated and is provided for backward compatibility only.
        PX_RWDOPTION
        This table contains reward option information associated with a promotion application that will be used at evaluation time.
        PX_TEMPLATE
        Reserved for HCL internal use.
        PX_TPLTGRP
        This table records details about relationships between entries in the PX_TEMPLATE and PX_GROUP tables.
        PX_USAGE
        This table contains statistics about promotion usage.
      - 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.

PAYMTHDSUP

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

Column Descriptions:

Name	Type	Description
PAYMTHD_ID	INTEGER NOT NULL	Reserved for HCL internal use.
STOREENT_ID	INTEGER NOT NULL	Reserved for HCL internal use.
FIELD1	VARCHAR (254)	Reserved for HCL internal use.
OPTCOUNTER	SMALLINT NOT NULL DEFAULT 0	Reserved for HCL internal use.

Indexes:

Name	Column Names	Type
<SYSTEM-GENERATED>	PAYMTHD_ID+STOREENT_ID	Primary Key
I0000684	STOREENT_ID	Non-Unique Index

Constrained By Parent Tables:

Constraint	Columns	Parent Table	Parent Columns	Type
F_576	PAYMTHD_ID	PAYMTHD	PAYMTHD_ID	Cascade
F_577	STOREENT_ID	STOREENT	STOREENT_ID	Cascade