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 production environment without IBM Cloud Private
You can set up your production environment without IBM Cloud Private however you like by using the provided Docker images for your HCL Commerce servers.
Deploying HCL Commerce to production environments
HCL Commerce provides all applications in Docker images for deployment in a configuration of your choice. Also included are Kubernetes Helm Charts and Docker Compose sample files. Kubernetes is the intended deployment method for a live production site, however a production environment for testing, debugging or developing purposes can be deployed using the more simple Docker Compose method.
Deploying HCL Commerce Version 9.0 with Docker Compose
You can deploy HCL Commerce Version 9.0 simply using Docker Compose. Generally, you deploy an authoring environment and a live environment to work together. In this standard HCL Commerce configuration, you update and modify your store in the authoring environment, and then propagate the changes to the live environment.
Deploying Version 9.0.1.18+
You can deploy HCL Commerce Version 9.0 simply using Docker Compose. Generally, you deploy an authoring environment and a live environment to work together. In this standard HCL Commerce configuration, you update and modify your store in the authoring environment, and then propagate the changes to the live environment.
The /volumes/ directory
When deploying HCL Commerce 9.0.1.18 or greater with the Docker Compose method, the /volumes/ directory is used to mount storage into your deployment Docker images.

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 two offerings, HCL Commerce Professional, and HCL Commerce Enterprise. Each version of each edition of HCL Commerce is an offering. HCL Commerce Developer is a separate offering that is used by developers of the platform. It can be used to develop for the corresponding version of both HCL Commerce Professional and HCL Commerce Enterprise. 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.0 release.
  - 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.
    - Setting up an HCL Commerce production environment with IBM Cloud Private
      You can use IBM Cloud Private to easily install, deploy, and operate your HCL Commerce version 9.0 production environments on Kubernetes.
    - Setting up an HCL Commerce production environment without IBM Cloud Private
      You can set up your production environment without IBM Cloud Private however you like by using the provided Docker images for your HCL Commerce servers.
      - Planning your production environment
        Before you set up your production environment, ensure that you understand the HCL Commerce application structure and that you are familiar with basic steps for setting up the environment.
      - Prerequisites for your production environment
        Before you set up the HCL Commerce production environment, perform these steps to ensure that your environment satisfies the prerequisite software.
      - Deploying HCL Commerce to production environments
        HCL Commerce provides all applications in Docker images for deployment in a configuration of your choice. Also included are Kubernetes Helm Charts and Docker Compose sample files. Kubernetes is the intended deployment method for a live production site, however a production environment for testing, debugging or developing purposes can be deployed using the more simple Docker Compose method.
        Deploying HCL Commerce Version 9.0 with Docker Compose
        You can deploy HCL Commerce Version 9.0 simply using Docker Compose. Generally, you deploy an authoring environment and a live environment to work together. In this standard HCL Commerce configuration, you update and modify your store in the authoring environment, and then propagate the changes to the live environment.
        Deploying Version 9.0.1.18+
        You can deploy HCL Commerce Version 9.0 simply using Docker Compose. Generally, you deploy an authoring environment and a live environment to work together. In this standard HCL Commerce configuration, you update and modify your store in the authoring environment, and then propagate the changes to the live environment.
        Deployment prerequisites
        The following steps highlight the minimum requirements before deploying HCL Commerce with Docker Compose.
        The /volumes/ directory
        When deploying HCL Commerce 9.0.1.18 or greater with the Docker Compose method, the /volumes/ directory is used to mount storage into your deployment Docker images.
        Env.sh configuration
        After HCL Commerce 9.0.1.18, all deployment configuration and environment configuration for the Docker Compose deployment method is made within the env.sh configuration script. Beginning with HCL CommerceThis deployment method can also be used to aid in the deployment of an HCL Commerce Developer installation for development of the Elasticsearch-based search solution, or other HCL Commerce Version 9.1 solution.
        Deploying Version 9.0.0.0 to 9.0.1.17
        You can set up a simple production environment, consisting of an authoring environment and a live environment, completely with Docker Compose. Generally, you would deploy an authoring and live environment to work together, where you can update and modify your store in the authoring environment, and then propagate the changes to the live environment.
        Deploying HCL Commerce Version 9 on Kubernetes
        This sample solution illustrates how to deploy an HCL Commerce Version 9 environment based on Helm Charts on Kubernetes, or IBM Cloud Private (ICP).
        Persisting search index data to a Gluster file system
        Learn how to use Kubernetes and GlusterFS to deploy HCL Commerce with a persistent volume for the search index.
    - 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.0, 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, 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.

The Docker Compose deployment /volumes/ directory structure and contents

When deploying HCL Commerce 9.0.1.18 or greater with the Docker Compose method, the /volumes/ directory is used to mount storage into your deployment Docker images.

This process is implemented for two reasons:

For the ease of import of essential files into your Docker images, without the need to create or recreate custom images;
For HCL Commerce data to be persisted in the event that you turn off or restart your deployment.

The following table describes the /volumes/ directory structure.


Directory	File	Description
/volumes/		The root directory that contains all persisted directories can be mounted automatically within the provided HCL Commerce Docker containers.
/volumes/jdbc/		Contains the JDBC .jar files for database connections. Only required for Oracle Database. ojdbc8.jar