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.
Customizing
The topics in the Customizing section describe tasks performed by an application developer to customize HCL Commerce.
Creating your custom store
After you install and set up your programming environment, you can create your custom store and customize your storefront. You must ensure that the store server is properly configured, and that your store assets are moved to the Store server.
Creating a custom store using JSP
This HCL Commerce store uses Java Server Pages (JSP) to implement the view layer of the Model-View-Controller (MVC) design pattern.
Customizing your store
After you review the HCL Commerce store architecture and create your custom store, you can use the programming environment to customize your store.
Store pages and features
Customize your store's pages by completing the following tasks.
Developing Commerce Composer assets
Enrich the capabilities of the Commerce Composer tool by developing your own widgets and templates, and extending other features and functions to suit your business needs.
Widget architecture
Widgets are the interchangeable building blocks that a Management Center user can use to compose layouts for store pages. Widgets are independent user interface modules that retrieve and display a specific type of data on a store page.
Creating Commerce Composer widget groups
You can create widget display and restriction groups to improve the organization of widgets and control the usage of widgets within the Commerce Composer tool.

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.
  - Customizing Management Center for HCL Commerce
    HCL Commerce allows you to pull the GIT bundle of Management Center source code and start the application locally to customize the Management Center.
  - Managed asset deployment
    Managed assets are files that are uploaded by business users to be used for store marketing, or to supplement products. They are added to HCL Commerce through the Assets tool or the Marketing tool in Management Center. By default, managed assets are extracted and deployed through the HCL Commerce EAR. To maintain performance in a large-scale production environment, site administrators must switch to alternative extraction and deployment methods for managed assets.
  - HCL Commerce development environment
    HCL Commerce Developer is the development toolkit for customizing a HCL Commerce application.
  - Functional architecture
    Functional architecture provides both the set of patterns used to implement the business functionality and the frameworks in which these business functions execute.
  - Persistent object model
    HCL Commerce deals with a large amount of persistent data. There are numerous tables defined in the current database schema. Even with this extensive schema, however, you might need to extend or customize the database schema for your particular business needs.
  - Creating your custom store
    After you install and set up your programming environment, you can create your custom store and customize your storefront. You must ensure that the store server is properly configured, and that your store assets are moved to the Store server.
    - Creating a custom store using JSP
      This HCL Commerce store uses Java Server Pages (JSP) to implement the view layer of the Model-View-Controller (MVC) design pattern.
      - Store architecture
        HCL Commerce separates individual front-end storefronts from the servers on which they rely. This architecture increases security, scalability, flexibility in server topology, and improves the ease of development and deployment of stores and store customizations.
      - Creating and configuring your custom store
        You can create and configure your custom store in your Externalized Customization workspace through the configuration and execution of a Gradle script. You can then configure your store assets, sample data, and use your Externalized Customization workspace to customize that store.
      - Customizing your store
        After you review the HCL Commerce store architecture and create your custom store, you can use the programming environment to customize your store.
        Store configuration
        Customize your storefront assets or store functionality by changing the Store server configuration, or by modifying or extending your store JavaServer Pages (JSP files) or Spring-based model-view-controller (MVC).
        Changing static HTML sample store files
        You can use the static HTML store to accelerate your web design cycle. When web designers use the static HTML store as a starting point, the cost of building user interface within the JSP files is reduced. You can modify the HTML and CSS files using your favorite web design tools and without a development environment. The changes can be incorporated into the corresponding JSP files by a store developer at a more convenient time.
        Aurora as a B2B starter store
        You can publish the Aurora starter store as a B2B store and take advantage of features that are offered by the Aurora starter store plus extra B2B capabilities. Get your B2B e-commerce site up and running faster at a lower cost by using the Aurora starter store as your starting point. With B2B-optimized features built right into the storefront, you can minimize the amount of customization that is required to provide an optimal shopping experience to your business customers.
        Store pages and features
        Customize your store's pages by completing the following tasks.
        Customizing storefront pages
        Customize storefront JavaServer Page files (JSP files) and the Spring MVC views that invoke them to modify how store pages are generated and returned to users of the store. Make additions or modifications to existing JSP files, or add new JSP files to extend the functionality of your storefront.
        Customizing an existing widget
        Customize a provided widget to modify its behavior for use on your storefront.
        Overriding a resource bundle
        Override a provided resource bundle to modify the text that is displayed on your storefront widgets.
        Loading categories in the catalog browsing menu
        You can override the behavior for loading the catalog browsing menu on individual store pages to control the display of the menu and improve the performance of loading store pages. By configuring the behavior for the catalog browsing menu, you can configure whether a store page loads only the top-level category in the catalog browsing menu when the page loads or loads all categories in the menu. The catalog browsing menu is a pop-up menu that includes a list of departments and categories.
        Enabling image-based facets for the B2B Hardware category
        After you publish the Aurora sample store as a B2B store, you can enable certain facets for products in the Fasteners and Lighting categories. These facets, such as Head style for screws and Bulb shape for lighting products, have associated images to help buyers find the right product quickly. The enablement steps involve selecting the descriptive attributes to display as facets in the Catalogs tool in Management Center and then previewing the results.
        Adding and changing messages
        You can add new messages or change existing messages in sample store pages by modifying the file that contains the store strings.
        Changing static HTML sample store files
        You can use the static HTML store to accelerate your web design cycle. When web designers use the static HTML store as a starting point, the cost of building user interface within the JSP files is reduced. You can modify the HTML and CSS files using your favorite web design tools and without a development environment. The changes can be incorporated into the corresponding JSP files by a store developer at a more convenient time.
        Applying HTML changes to JSP files
        After a web designer changes the static HTML files, a store developer can determine the JSP files that dynamically render the different areas on specific pages in a storefront. The highlight feature, one of the tools that are provided with the assets, is used to identify the JSP files that make up the page you are on. It marks off each area of the page that a JSP file represents and shows the file name in the upper left corner.
        Adding extension logic to all store pages
        You can configure the Aurora starter store to include custom extension logic, such as self contained JSP on all store pages. By using this configuration, you can easily embed common code on all store pages, or embed code for tracking the browsing history of shoppers.
        Enabling subscription support in the order component
        In order to enable subscription support in the order component, the order configuration file must be updated.
        Enabling and configuring site search statistics
        You can gather data for the site into search statistics reports so that you can view and analyze them in the Management Center.
        Customizing web store labels and messages
        The static HTML store shows the labels and messages. Use the static HTML store to find the properties files that are needed to customize the labels and messages in your live store.
        Directory structure
        Store files are organized by default in a defined directory structure.
        Catalog image requirements
        For each catalog entry (product, SKU, bundle, and kit), the Aurora starter store displays images in various sizes in different locations.
        Dynamic caching
        In the Aurora starter store, dynamic caching is enabled by default. Dynamic caching reduces the server load because significant segments of the page, such as store widgets, do not have to be retrieved from the server on every new page display.
        JSTL variables
        The crs-web > WebContent > storedir > Common > EnvironmentSetup.jspf file is a configuration file that is commonly included in starter store pages. The variables declared within this file can be modified to change the appearances and behaviors of storefront components.
        Coding JSP pages to use the Storefront Test Automation Engine
        The HCL Commerce test automation framework is designed to help you effectively and efficiently test your store before deployment. To fully leverage the test automation framework, it is recommended that you edit your JavaServer Pages (JSP) to include the following best practices.
        Adding and changing messages
        You can add new messages or change existing messages in sample store pages by modifying the file that contains the store strings.
        Enabling the progress bar
        The progress bar is displayed when an AJAX request is triggered and removed when the request completes. It serves as a confirmation indicator on the page, where additional actions can still be performed by the customer. That is, it does not impede the customer from performing additional actions on the page.
        Enabling account activation by email
        You can enable account activation so that customers must click an activation URL before they become registered in the Aurora starter store.
        Disabling account activation by email
        You can disable the account activation by email function if the function is enabled.
        Shortening the context root of a migrated local store URL
        When you migrate your store from a previous version of HCL Commerce to version 9.0, your store runs on the transaction server (trs-app) and is often referred to as a local store. In addition to running on the transaction server, your local store also uses the transaction web server (trs-web). If you are using a local store, you can shorten the context root of your store's URL to make it easier for shoppers to remember a link. Shorting the context root also improves visibility in search engine results.
        Uploading requisition lists
        You can create a requisition list in a text or spreadsheet editor and upload the requisition list to the store. A requisition list is a reusable list of items (SKUs) that you can use to create orders. Requisition lists are supported when the Aurora starter store is published as a B2B store.
        Enabling a Subscribe link for an e-Marketing Spot feed
        The Aurora starter store includes a feature that allows customers to subscribe to e-Marketing Spot feeds for catalog entry recommendations. To familiarize yourself with the Aurora implementation, you can enable and test the Subscribe link for an e-Marketing Spot on the Department page. Then, consider a similar implementation for your own store.
        Enabling a Subscribe link for a wish list feed
        The Aurora starter store includes a feature that allows shoppers to subscribe to wish list feeds. To familiarize yourself with the Aurora implementation, you can enable and test the Subscribe link for the wish list. Then, consider a similar implementation for your own store.
        Updating the Aurora starter store for key splitting
        The key splitting feature might potentially expose some JavaScript coding issues in the store JSP pages. JSP pages that passed or initialized JSTL variables of object's primary keys (or identifiers) into JavaScript variables as integers might be subject to unexpected behavior in the storefront.
        Enabling the Cancel button for orders on the Order Details page
        If you want to allow shoppers to cancel orders, you can enable the Cancel button on the Order Details page for the Aurora starter store. The enablement steps involve installing interim fixes that contain code that is required for the Cancel button to function and defining modification rules for order statuses in Sterling Order Management.
        Currency formatting
        The Aurora sample store uses the JavaServer Pages Standard Tag Library (JSTL) API to format the currencies that are displayed on store pages.
        Methods for retrieving configuration parameters from the STORECONF table
        You can use the StoreConfigurationRegistry to access store configuration values in the STORECONF database table from either Java™ code or JSP files.
        Developing Commerce Composer assets
        Enrich the capabilities of the Commerce Composer tool by developing your own widgets and templates, and extending other features and functions to suit your business needs.
        Layout architecture
        A layout is an arrangement of Commerce Composer widgets within a layout template that retrieve and display different artifacts to render a store page. When a shopper views a page, the Commerce Composer framework resolves the appropriate layout to use for the page for that point in time. The Commerce Composer framework then uses the layout contents and design to render the page for the shopper to view.
        Layout template architecture
        A layout template is the starting point for a Management Center user to use for composing a layout for a store page. Each template is a grid that contains a specific arrangement of slots.
        Widget architecture
        Widgets are the interchangeable building blocks that a Management Center user can use to compose layouts for store pages. Widgets are independent user interface modules that retrieve and display a specific type of data on a store page.
        Creating widgets
        You can create a custom Commerce Composer widget that Management Center users can use to compose store pages. You must define your widget functionality, content, and presentation. Then, you must register your widget in the Commerce Composer framework, and subscribe one or more stores to use the widget.
        Copying HCL Commerce site-level widgets
        You can copy and modify an existing Commerce Composer widget to use as a model to create your own custom widget. If you need a widget that provides almost the same functionality of a widget that is provided by HCL Commerce, the recommended best practice is to copy the assets for the provided widget. You can then use the copied assets to model your own custom widget that is a copy of the default-provided widget. With your custom version of the widget, you can then modify your widget to meet your store design and functionality requirements.
        Commerce Composer widget properties
        By default, the widgets that are available for use with the Commerce Composer tool can include properties that a developer can define, or Management Center user can configure. When you are creating a custom widget, you can define your widget to include any of these properties, or you create your own custom properties.
        Creating Commerce Composer widget groups
        You can create widget display and restriction groups to improve the organization of widgets and control the usage of widgets within the Commerce Composer tool.
        Creating Commerce Composer widget display groups
        Create a widget display group to organize the widgets that are available within the Add Widgets to Slots window. When business users select to add a widget to a layout template slot, the user can use the widget display group to filter the widgets that show within the Add Widgets to Slots window.
        Creating Commerce Composer widget restriction groups
        Create a widget restriction group to control the widgets that can be included within a layout template slot by using the Commerce Composer. When business users select to add widget to a layout template slot, only the widgets that a slot is restricted to use are available within Add Widgets to Slots window.
        Enabling auto-scrolling in the Content Carousel widget
        You might want the Content Carousel widget to automatically scroll through the images rather than requiring the user to control the scrolling. If so, you can add an auto-scrolling property to the UI provider JSPF file for the widget and specify the scrolling speed.
        Example: How widgets can display products and prices according to a B2B contract
        In a B2B store, you might want your Commerce Composer widget to display products and prices according to the terms of the contract that the buyer is shopping under. If so, review an example of how the Commerce Composer framework uses REST services to ensure that the Catalog Entry List widget displays the products and prices that a buyer is entitled to.
        Commerce Composer page creation
        If your site supports the use of the Commerce Composer tool in Management Center, you can create store pages that can be managed with the Commerce Composer tool.
        Best practices for developing Commerce Composer assets
        If you are planning to create or use custom Commerce Composer assets, ensure that you review following best practices.
        Deleting Commerce Composer objects
        If you no longer need a specific Commerce Composer object, such as a widget, layout template, layout, or page, you can remove the object from your store and delete the object.
        Deploying Commerce Composer assets
        You can build and deploy a package of your custom or updated Commerce Composer assets with the HCL Commerce Build and Deployment tool.
        Commerce Composer JSTL tags
        The Commerce Composer framework uses a set of custom JavaServer Pages Standard Tag Library (JSTL) tags that are provided with HCL Commerce. This HCL Commerce Page Layout Tag Library is used to support the authoring of JSP files for use with the Commerce Composer tool and framework.
        Responsive Web Design (RWD)
        Responsive Web Design (RWD) is a web design approach that is aimed at crafting pages that are optimized for a wide range of devices. It advocates the use of primarily fluid layouts and media queries to optimize a site for different devices, instead of designing a separate site for each device.
        Email messages
        You can use the provided email template JSP files as a starting point to customize your email content. The templates are provided in the crs-web > WebContent > YourStoreFrontAssetStoreDir > EmailTemplates directory.
        Search engine optimization (SEO)
        You can use one of the following solutions to optimize your store for search engine results.
    - Creating a custom store using React
      You can create a React single page application Store using the HCL Commerce Store SDK that is provided for pages and react components. The Store SDK allows your front end developers to quickly develop and deploy a Store while focusing on creating the best user experience possible.
    - Creating a custom store using Next.js
      You can create a server-side rendered storefront using the HCL Commerce Next.js Store SDK. The Next.js Store SDK allows your front end development of a storefront using an easy extension paradigm.
    - Email templates and sitemap generator
      An email template is a pre-designed format for creating consistent emails. Notifications are messages that inform users about events or updates related to a service or application.
  - Presentation layer
    HCL Commerce uses Java Server Pages (JSP) to implement the view layer of the Model-View-Controller (MVC) design pattern. The view layer is in charge of retrieving data from the database through the use of data beans and formatting it to meet the display requirements. The view layers determines whether the request is sent to a browser or streamed out as XML. JSP files present a clean separation between data content and presentation.
  - Controller layer
    The Controller layer is the conductor of operations for a request. It controls the transaction scope and manages the session related information for the request. The controller first dispatches to a command and then calls the appropriate view processing logic to render the response.
  - Business logic layer
    The business logic layer is the business components that provide OAGIS services to return data or start business processes. The presentation layer uses these OAGIS services to display data, or to invoke a business process. The business logic provides data required by the presentation layer. The business logic layer exists because more than just fetching and updating data is required by an application; there is also additional business logic independent of the presentation layer.
  - Persistence layer
    The interaction between the business objects and persistence layer is isolated in an object called the Business Object Mediator. Business object document (BOD) commands interact with the Business Object Mediator to handle the interaction with the logical objects and how they are persisted.
  - Business model information model
    A business model, a representation of the business processes used throughout the site, provides a sample commerce solution which includes an organization structure, default user roles and access control policies, one or more starter stores, administration tools, and business processes that demonstrate best practices. A business model can be customized to support business requirements and scenarios. HCL Commerce provides sample business models that show some common commerce solutions. These business models are created by setting up an organization hierarchy structure, access control policies, stores, and contracts that help satisfy the necessary business requirements.
  - Business models
    Before starting to develop your site with HCL Commerce, you need to determine the business model supported by HCL Commerce that best represents the purpose of your site. Usually sites created with HCL Commerce will be implemented based on of one of these business models.
  - Store data information model
    Store data is the information that is loaded into the Transaction server database, which allows your store to function. The URL Registry Entries and View Registry Entries packages are included in the diagram, but they are not database assets. These entries are presentation configuration (that is, struts actions and forwards) that must be deployed. URL registry entries are shown in the diagram to illustrate the entire store data information model. To operate properly, a store must have the data in place to support all customer activities. For example, in order for a customer to make a purchase, your store must contain a catalog of goods for sale (catalog data), the data associated with processing orders (tax and shipping data), and the inventory to fulfill the request (inventory and fulfillment data).
  - Customizing HCL Commerce
    You can extend the HCL Commerce product to fit your business needs. This topic describes the prerequisite skills and required knowledge that you need to customize business logic. After you have the required knowledge, use HCL Commerce Developer to take tutorials that guide you step-by-step through various customization scenarios.
  - Run Engine command framework
    The Run Engine command framework provides predefined commands, that you can use to change environment parameters or container configurations. This framework is built into the HCL provided Docker images.
  - GraphQL for HCL Commerce
    The GraphQL markup language is available for any API. It is a server-side interpreter for processing queries using a data type system you design. With GraphQL, your data and code are independent of any database or storage system.
  - Representational State Transfer (REST) services
    HCL Commerce uses Representational State Transfer (REST) services to provide a framework that can be used to develop RESTful applications on several platforms. These platforms can include web, mobile, kiosks, and social applications.
  - Web services
  - Search
    HCL Commerce comes with a powerful and fully integrated search function. The search functions in HCL Commerce provide an enriched customer experience, with features such as automatic search term suggestions and spelling correction. Since it is built on industry standards, HCL Commerce Search is highly flexible and extensible. Starter stores can use the search engine's most sophisticated features without requiring extra customization. Starting with Version 9.1, HCL Commerce Search with Elasticsearch microservices manage indexing and other crucial tasks, with no performance impact on the storefront or transaction server.
- 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.

Creating Commerce Composer widget groups

You can create widget display and restriction groups to improve the organization of widgets and control the usage of widgets within the Commerce Composer tool.

By creating widget display groups, you can organize the display of the widgets that are available within the Add Widgets to Slots window. When business users select to add a widget to a layout template slot, they can filter the widgets that show by the widget display groups.

By creating widget restriction groups, you can control which widgets can be included within specific layout template slots. When business users select to add widget to a layout template slot, only the widgets that a slot is restricted to use are available within Add Widgets to Slots window.