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.
Installing and deploying
Learn how to install and deploy HCL Commerce development environments and HCL Commerce production environments.
Setting up HCL Commerce environments
Learn how to set up development, testing, and production environments, and how to update the production environment through deploying custom changes and applying maintenance.
Setting up an HCL Commerce development environment
This section describes how to set up an HCL Commerce development environment. The HCL Commerce development environment is a flexible collection of software, collectively known as HCL Commerce Developer, for developers or system administrators to develop and test stores and HCL Commerce application code.
Developer Legacy environment
In previous iterations of HCL Commerce, all site features were developed within a single development environment. This environment was built with the HCL Commerce Developer software package. With HCL Commerce Version 9.1, this software environment has been renamed to the HCL Commerce Developer Legacy environment to more reflect its usage within the product.
Setup prerequisites for an HCL Commerce Developer Legacy environment
To set up an HCL Commerce Developer Legacy environment, install the appropriate prerequisite software: Rational Application Developer, WebSphere Application Server, WebSphere Application Server V8.5.5 Liberty, and the appropriate Java SDK version. You also need to prepare your IBM Db2 or Oracle development database.

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.
  - HCL Commerce assemblies
    HCL Commerce consists of HCL Commerce Enterprise, and HCL Commerce Developer, a separate offering that is used by developers of the platform. Each offering is logically divided into subpackages called electronic assemblies, or eAssemblies. An eAssembly is a group of software that is devoted to a particular platform or environment. Each eAssembly contains the individual product images for that environment, called parts. Which parts you need depends on your usage and configuration choices.
  - Downloading software
    To set up an HCL Commerce production, development, or test environment, you require the associated product software images.
  - Supported software levels, fixes, and settings
    The following table provides a list of generally available (GA) software levels, fixes, and settings for the latest HCL Commerce Version 9.1 release.
  - Hardware requirements
    The following reference provides a general guideline for the hardware capacity that is required for the HCL Commerce Version 9.1 release. This includes both full development and production environments for sites that are based on different sets of HCL Commerce solutions.
  - Setting up HCL Commerce environments
    Learn how to set up development, testing, and production environments, and how to update the production environment through deploying custom changes and applying maintenance.
    - Setting up an HCL Commerce development environment
      This section describes how to set up an HCL Commerce development environment. The HCL Commerce development environment is a flexible collection of software, collectively known as HCL Commerce Developer, for developers or system administrators to develop and test stores and HCL Commerce application code.
      - Obtaining HCL Commerce Developer software
        To set up an HCL Commerce development environment, you require associated product software images and Software Development Kits (SDKs).
      - Developer Legacy environment
        In previous iterations of HCL Commerce, all site features were developed within a single development environment. This environment was built with the HCL Commerce Developer software package. With HCL Commerce Version 9.1, this software environment has been renamed to the HCL Commerce Developer Legacy environment to more reflect its usage within the product.
        Setup prerequisites for an HCL Commerce Developer Legacy environment
        To set up an HCL Commerce Developer Legacy environment, install the appropriate prerequisite software: Rational Application Developer, WebSphere Application Server, WebSphere Application Server V8.5.5 Liberty, and the appropriate Java SDK version. You also need to prepare your IBM Db2 or Oracle development database.
        Installing Rational Application Developer Version 9.6 or a later 9.6 refresh pack
        Installing 64-bit Rational Application Developer is the first step of installing HCL Commerce Developer Legacy environment.
        Installing WebSphere Application Server and IBM Java SDK 8
        Install WebSphere Application Server, WebSphere Application Server V8.5.5 Liberty, and IBM Java SDK for use in the development of HCL Commerce software. You must have WebSphere Application Server, WebSphere Application Server V8.5.5 Liberty and IBM Java SDK installed before you can set up your HCL Commerce Developer Legacy environment.
        Preparing a database
        To serve as the HCL Commerce Developer database, you can launch a preconfigured IBM Db2 Docker container. Alternatively, you can manually install a compatible version of an IBM Db2, or Oracle database.
        Installing HCL Commerce Developer
        You can install HCL Commerce Developer silently, or by using the IBM Installation Manager GUI.
        Configuring a database
        Prepare a Db2 or Oracle database to use as the HCL Commerce development environment database.
        Loading the HCL Commerce Developer database schema
        You need to use a script to load the HCL Commerce database schema.
        Changing the development database type by using the setdbtype command
        You must configure your HCL Commerce Developer workspace to point to your IBM Db2 or Oracle database that you installed as a prerequisite.
        Adding certificates
        When integrating HCL Commerce with an external system, it is required to add the third party certificates to the HCL Commerce trust store. This allows HCL Commerce to make HTTPS requests to an external system.
        Configuring the Developer Legacy environment for Solr
        After installation, your HCL Commerce Developer Legacy environment is configured by default for use with the newer Elasticsearch-based search solution that was introduced in HCL Commerce Version 9.1. Complete the following steps to revert your Developer Legacy environment to maintain or develop sites that use the Solr-based search solution.
        Deploying Redis for HCL Cache
        Deploy and configure Redis on your HCL Commerce Developer Legacy environment to test HCL Cache caching and cache invalidation.
        Starting the Cache Manager
        Configure the HCL Commerce Cache Manager application within your HCL Commerce development environment to aid in the control of your caching implementation.
        Enabling Marketplace
        Marketplace is a new store feature introduced in HCL Commerce 9.1.10.0. Due to the fact that this feature is still early in development, and not ready for a full production setting, the early implementation of Marketplace is not enabled in HCL Commerce Developer by default. Enable Marketplace to preview its usage within your HCL Commerce Developer Legacy environment.
        Verifying your HCL Commerce Developer installation
        To verify your installation, ensure that you can browse the sample Aurora starter store and that you can access business user tools.
      - Developer Search environment
        HCL Commerce Version 9.1 provides support for Elasticsearch by default. Use the HCL Commerce Developer Search environment to make customizations to the search solution.
      - Developer React Store environment
        HCL Commerce provides a standalone HCL Commerce Developer React Store environment. This environment uses the React Store Software Development Kit (SDK) with reference Single Page Application (SPA) Stores that are based on the Node.js react-app. The HCL Commerce Developer React Store environment is completely independent of the HCL Commerce Developer Legacy environment.
      - Developer Next.js Store environment
        Refer to storeseparation/tasks/ruby_downloadsdk.html for instructions on how to download the Next.js Store SDK.
      - Developer Tooling environment
        HCL Commerce provides a standalone HCL Commerce Developer Tooling environment Software Development Kit (SDK).
      - Developer Solr-based Nextjs Store environment
        The Orchestration service acts as a bridge between Ruby applications that can only recognize Elastic-based search formats, and Solr-based search services. If you plan to develop for Ruby applications for use with a Solr-based search solution, you must configure the Orchestration service to test your storefronts in an HCL Commerce development environment.
      - Uninstalling HCL Commerce Developer
        Uninstalling HCL Commerce Developer consists of removing HCL Commerce Developer and Rational Application Developer from your computer.
    - Setting up an HCL Commerce production environment
      You can set up your production environment however you like by using the provided Docker images for your HCL Commerce servers.
    - Default port numbers
      Review this information for the default port numbers that are used by HCL Commerce services or the component products.
  - Deploying custom changes
    With HCL Commerce Version 9.1, you can customize HCL Commerce Docker image with the source code, configurations, and the Docker container start-up logic. Learn how to build Docker images with your customized code and deploy the images (and other changes) to your Docker containers.
  - Updating HCL Commerce overview
    Learn about HCL Commerce release types, and learn how to update your custom HCL Commerce site deployments.
- 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.

Setup prerequisites for an HCL Commerce Developer Legacy environment

To set up an HCL Commerce Developer Legacy environment, install the appropriate prerequisite software: Rational Application Developer, WebSphere Application Server, WebSphere Application Server V8.5.5 Liberty, and the appropriate Java SDK version. You also need to prepare your IBM Db2 or Oracle development database.

If you do not have the software, download the necessary eAssemblies from HCL License and Delivery portal. For more information, see HCL Commerce eAssemblies.

Before installing HCL Commerce Developer software, ensure that your HCL Commerce development environment meets the hardware and software requirements.

For software requirements, see Supported software levels, fixes, and settings for HCL Commerce.
For hardware requirements, see Hardware requirements for HCL Commerce.

Setup prerequisites for an HCL Commerce Developer Legacy environment

Procedure