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.
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.
Extracting and loading data
HCL Commerce provides utilities for preparing and loading data into a HCL Commerce database. The loading utilities are flexible and you can continue to use these utilities when you customize the HCL Commerce schema.
Data Load utility
The Data Load utility is an enhanced business object based loading utility. This utility provides an efficient solution for loading information into your HCL Commerce database. You can also customize the Data Load utility to load other types of data. The Data Load utility is the recommended loading utility.
Data Load input file format
To run the Data Load utility, an input file is required. The input file must be a CSV or XML file. Your input file must follow a particular format for the Data Load to be able to load your file.
Data Load utility CSV column and XML element definitions
Look up the database column name and definitions for business objects to find details about the required and optional fields, and the values that they can contain.
Marketing objects
To load marketing objects with the Data Load utility, you must understand the information that you include in an input file to load the data. You must also understand how to complete the columns or elements in each of the input files that you are loading.
Marketing campaign objects
Use a MarketingCampaign.csv input file to load information to create marketing campaigns for a store. After you load the data, business users can manage the new campaigns with the Marketing 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, 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.
  - The HCL Commerce application
    Every time you deploy the HCL Commerce application, you are deploying a set of Docker containers that communicate with each other to run your HCL Commerce site. Each HCL Commerce application deployment can contain one or more stores.
  - Overview of administering an HCL Commerce site
    In HCL Commerce the person who performs administrative tasks is called a Site Administrator. The Site Administrator installs, configures, and maintains HCL Commerce and the associated software and hardware. The administrator responds to system warnings, alerts, and errors, and diagnoses and resolves system problems. Typically, this person controls access and authorization (creating and assigning members to the appropriate role), manages the Web site, monitors performance, and manages load balancing tasks. The Site Administrator might be responsible for establishing and maintaining several server configurations for different stages of development such as testing, staging, and production. The Site Administrator also handles critical system backups and resolves performance problems.
  - Staging environment
    an HCL Commerce staging environment is a runtime environment where business and technical users can update and manage store data and preview changes. The changes can then be propagated to the production environment.
  - Workspaces
    You can enable and manage workspace assets and determine policies such as locking rules and commit and publishing options.
  - HCL Commerce database
    As a site administrator, maintain the HCL Commerce database and ensure that any HCL Commerce utilities and processes that load and retrieve data from the database is configured to connect to the database properly.
  - 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.
  - Extracting and loading data
    HCL Commerce provides utilities for preparing and loading data into a HCL Commerce database. The loading utilities are flexible and you can continue to use these utilities when you customize the HCL Commerce schema.
    - Data Load utility
      The Data Load utility is an enhanced business object based loading utility. This utility provides an efficient solution for loading information into your HCL Commerce database. You can also customize the Data Load utility to load other types of data. The Data Load utility is the recommended loading utility.
      - Data Load utility architectural overview
        In order to work with the Data Load utility, you must first have an understanding of how it works.
      - Running the Data Load utility in the HCL Commerce development environment
        Run the Data Load utility inside the HCL Commerce development environment when testing customizations or when debugging issues with the utility. This configuration is less time-consuming than first deploying to a production environment, and then running the utility for testing purposes.
      - Data Load input file format
        To run the Data Load utility, an input file is required. The input file must be a CSV or XML file. Your input file must follow a particular format for the Data Load to be able to load your file.
        Creating data in CSV format
        You can create data for loading into your database with the Data Load utility in a CSV formatted file. The easiest way to create this data is to download a sample CSV file to use as a starting point.
        Creating data in XML format
        You can create data that you want to load into your database with the Data Load utility in an XML formatted file. This XML file must follow a specific XML format, which is similar in structure and content to the supported CSV format for loading catalog data.
        Data Load utility CSV column and XML element definitions
        Look up the database column name and definitions for business objects to find details about the required and optional fields, and the values that they can contain.
        Catalog object input file definitions
        Look up the column and element name definitions for catalog object types to find details about the required and optional fields.
        Catalog filter object input file definitions
        Look up the column and element name definitions for catalog filter object types to find details about the required and optional fields.
        Price objects
        To load price objects with the Data Load utility, you must understand the information that you include in an input file to load the data. You must also understand how to complete the required and optional columns or elements in each of the input files that you load.
        Commerce Composer objects
        To load Commerce Composer objects with the Data Load utility, you must understand each of the input files that you can use to load the data. You must also understand how to fill the columns or elements in the input files with the correct data.
        Payment objects
        Load payment objects to configure your store to support specific payment integrations and payment methods.
        Promotion objects
        To load promotion objects with the Data Load utility, you must understand the information that you include in an input file to load the data. You must also understand how to complete the columns or elements in each of the input files that you are loading.
        Marketing objects
        To load marketing objects with the Data Load utility, you must understand the information that you include in an input file to load the data. You must also understand how to complete the columns or elements in each of the input files that you are loading.
        Marketing activity objects
        Use a MarketingActivity.csv input file to load information to create marketing activities in a store. After you load the data, business users can manage the new activities with the Marketing tool.
        Marketing campaign objects
        Use a MarketingCampaign.csv input file to load information to create marketing campaigns for a store. After you load the data, business users can manage the new campaigns with the Marketing tool.
        Marketing element objects
        Use a MarketingElement.csv input file to load information to create elements for the marketing activities that belong to a store. After you load the data, business users can manage the new element information for marketing activities with the Marketing tool.
        Marketing element NVP objects
        Use a MarketingElementNVP.csv input file to load information to create name-value pair (NVP) information for the marketing elements that belong to marketing activities in a store. After you load the data, business users can manage the new name-value pair information for marketing activity elements with the Marketing tool.
        E-Marketing Spot objects
        Use a MarketingSpot.csv input file to load information to create e-Marketing Spots in a store. After you load the data, business users can manage the new e-Marketing Spots with the Marketing tool.
        E-Marketing Spot default content objects
        Use a MarketingSpotDefaultContent.csv input file to load data to create default content information for e-Marketing Spots that belong to a store. After you load the data, business users can manage the default content information for e-Marketing Spots with the Marketing tool.
        E-Marketing Spot default title objects
        Use a MarketingSpotDefaultTitle.csv input file to load data to create default title information for e-Marketing Spots that belong to a store. After you load the data, business users can manage the default title information for e-Marketing Spots with the Marketing tool.
        Customer segment objects
        Use a MemberGroup.csv input file to load information to create customer segments in a store. After you load the data, business users can manage the new customer segments with the Marketing tool.
        Customer segment condition objects
        Use a MemberGroupCondition.csv input file to load information to create the conditions for the customer segments that belong to a store. After you load the data, business users can manage the new customer segment conditions with the Marketing tool.
        Customer segment description objects
        Use a MemberGroupDescription.csv input file to load information to create descriptive information in multiple languages for the customer segments that belong to a store. After you load the data, business users can manage the new descriptive information for customer segments with the Marketing tool.
        Marketing content objects
        Use a MarketingContent.csv input file to load information to create marketing content for a store. After you load the data, business users can manage the new marketing content with the Marketing tool.
        Marketing content attachment objects
        Use a MarketingContentAttachment.csv input file to load data to create attachment information for the marketing content that belongs to a store. After you load the data, business users can manage the new content attachment information with the Marketing tool.
        Marketing content attachment description objects
        Use a MarketingContentAttachmentDescription.csv input file to load information to create descriptive information in multiple languages for the content attachments of the marketing content that belongs to a store. After you load the data, business users can manage the new descriptive information for the content attachments with the Marketing tool.
        Marketing content description objects
        Use a MarketingContentDescription.csv input file to load information to create descriptive information in multiple languages for marketing content that belongs to a store. After you load the data, business users can manage the new descriptive information for content with the Marketing tool.
        Marketing content image map objects
        Use a MarketingContentImageMap.csv input file to load data to create image map information for the marketing content that belongs to a store. After you load the data, business users can manage the new image map information with the Marketing tool.
        Marketing attachment objects
        Use a Attachment.csv input file to load information to create attachments for the marketing objects that belong to a store. After you load the data, business users can manage the new attachment information for the marketing objects with the Attachments tool.
        Marketing attachment description objects
        Use a AttachmentDescription.csv input file to load data to create descriptive information for the attachments that are associated with marketing objects in a store. After you load the data, business users can manage the new descriptive information with the Assets tool.
        Marketing attachment asset objects
        Use a AttachmentAsset.csv input file to load data to create assets for the marketing attachments that belong to a store. After you load the data, business users can manage the new assets for attachments with the Assets tool.
        Marketing attachment assets objects in multiple languages
        Use a AttachmentAssetLanguage.csv input file to load data to associate marketing attachment assets with multiple languages. After you load the data, business users can manage the new asset and language relationships with the Assets tool.
        xC objects
        Load custom xC extension objects to register and configure the extensions.
      - Business object mediators
        The data load business object mediator converts the business objects into physical objects. Two types of mediators that are provided with the Data Load utility are the component-based mediator and the table-based mediator. Several component-based mediators are available for catalog, inventory, and price components.
      - Data Load utility table-based mediator and builder
        Use the table object builder and table object mediator to load data directly into a table with the Data Load utility when a component-based business object mediator does not exist. You can use the TableObjectMediator and TableObjectBuilder to load your custom data directly into your target database tables. This mediator and builder can ensure that the data is loaded into the correct table and columns. You do not have to create a custom business object mediator and builder or extend an existing mediator or builder.
      - Data Load file difference preprocessing
        You can run a file difference preprocess for routine data loads to improve the Data Load utility performance for loading these files. Running a file difference can reduce the loading time that is required to load your routine updates to your HCL Commerce database, reduce server usage time, and improve server performance.
      - Data Load utility best practices
        When you use the Data Load utility, there are some general configuration recommendations to ensure that you take advantage of the full capability of data load. If you are loading catalog, price, member, or inventory-related data with the Data Load utility, review the component-related best practices.
      - Configuring and running the Data Load utility
        To configure and run the Data Load utility, create a file to load, define the data reader, load order, and environment configuration files. Then, enter the data load shell script command with modifying parameters from a command-line interface.
      - Scenarios: Data Load utility
        By reviewing different scenarios for using the Data Load utility, you can learn more about how you can use the utility.
      - Samples: Data Load utility
        The samples that are provided with the Data Load utility demonstrate best-practice methods for loading data using common loading scenarios. Use the samples as a template for loading your own data to your store.
      - Initializing the attribute dictionary
        If your store does not have an attribute dictionary, set the initAttributeDictionary property to initialize the attribute dictionary and then use the data load utility to create the attribute dictionary in Management Center.
      - Substituting data load attribute values with variables
        You can substitute the values of most attributes in the wc-dataload.xml data load order configuration file and wc-dataload-env.xml data load environment configuration files. By using variable substitutions, you can change the value of attributes without editing the configuration file. For example, you can substitute the value of the user ID attribute for a variable.
      - Loading data into workspaces using the Data Load utility
        The Data Load utility supports loading data into a workspace. By loading data into a workspace you can make and preview changes to managed assets, without affecting what is running on your site.
      - Loading values for single and multiple value attributes
        You can configure the loading process for Catalog Upload and the Data Load utility to load data separately for both single and multiple value descriptive attributes. By separating these load processes, you can ensure that the values for your single value and multiple value attributes are updated accurately.
      - Reuse attribute assigned values with the Data Load utility
        You can use the Data Load utility to reuse assigned values for attributes when the same value is needed for multiple catalog entries. By reusing attribute assigned values across catalog entries, you can reduce the number of duplicate values that are created in the database.
      - Loading customer segment members by email address
        You can create a customer segment that business users can manage in the Marketing tool by loading a list of email addresses.
      - Loading member group members by email address
        You can load members into member groups by resolving the unique ID for a member with only the member email address. By resolving the unique ID with the email address, you do not need to include the member logon ID or distinguished name in your input file.
      - Loading promotions with the Data Load utility
        You can configure the Data Load utility to load promotion data in an XML input file to create or change promotions in a store. By using the Data Load utility to load promotions, you can quickly create or change multiple promotions in a single operation.
      - Loading marketing objects with the Data Load utility
        You can configure the Data Load utility to load marketing data to create customer segments, e-Marketing Spots, activities, marketing content, and any associated assets. By using the Data Load utility to load this data, you can quickly create multiple marketing objects and types of objects in a single operation.
      - Configuring a Data Load utility scheduler job
        You can use the HCL Commerce Administration Console to schedule a Data Load utility job for your site. By using a scheduler job, you can configure the Data Load utility to routinely load an input file, such as for loading frequently updated data.
    - Data Extract utility
      The Data Extract utility is a command-line utility that you can use to extract data from the HCL Commerce database into an output file.
    - Catalog Upload feature
      You can configure the Catalog Upload feature in Management Center to change the behavior for how the Catalog Upload feature loads data. You can configure properties for the utility to change validation behavior, invalidate the cache, load SEO information, and more.
  - Payment plug-ins
    To configure a payment plug-in define payment and refund methods; payment and refund rules; and the payment protocols that you intend to use.
  - Search
    In keeping with HCL's commitment to current and open standards, HCL Commerce Search uses Apache Lucene as the basis of its Search framework. Lucene powers the Apache Solr search engine. This open-standards approach considerably eases the process of integrating Search with existing and third-party applications.
  - HCL Customer Service for HCL Commerce
    HCL Customer Service for HCL Commerce is a separately purchased product that provides a light-weight customer service solution that is embedded in the Aurora B2C and Aurora B2B storefronts. Even though this solution is a separately purchased product, it is not a separate application. Stores that are enabled with HCL Customer Service for HCL Commerce allow a customer service representative (CSR) to act on behalf of guest customers and registered customers. A CSR can manage customer accounts, cancel and reorder orders, and shop as customer. A CSR can also act on behalf of Buyer Administrators to help complete Aurora B2B tasks from the storefront, without having to access the Organization Administration Console.
  - HCL Commerce configuration file (wc-server.xml)
    Many aspects of the HCL Commerce runtime application are configured in an XML file. This XML file is located inside the HCL Commerce Java Platform, Enterprise Edition EAR.
  - Enabling the SSL Accelerator option
    An SSL Accelerator (or SSL Terminator) strips off HTTPS encryption at or before the Web server tier in a multitier setup. When you use an SSL Accelerator with HCL Commerce, you can use the SSL Accelerator option to configure HCL Commerce to correctly receive requests that require redirects.
  - Managing features
    You can administer the features for your store and site, such as attribute, catalog, promotion, marketing, order management features, and more. The administration tasks that you can complete differ depending on the type of feature and the tool that you use to administer your store and site.
  - Logging services
    HCL Commerce provides facilities for logging. For existing customers, ECTrace and ECMessage are still supported. For new implementations, use the WebSphere Application Server recommendation for logging and tracing.
  - Business auditing
    Business auditing is the capturing of the business logic and objects during a HCL Commerce operation. You may want to audit your business for various reasons: generic, such as to review various tasks performed weekly; or specific, such as to track the steps involved in a particular Customer Service Representative's order. A report on business auditing is available in the Administration Console.
  - Business events
    Each time that a command triggers a business event, a record is added to the BUSEVENT database table to persist data from the event. Event listeners and external systems (such as the Marketing component, a back end order management system, or an external analytics system) can use this data to perform further processing.
  - Business Object thresholds
    Applying limits on business operations reduces the risk of system attacks where unbound conditions might result in system failures.
  - Stores in HCL Commerce
    HCL Commerce supports several different types of entities that are defined as stores. The assets of these store entities may be edited using the HCL Commerce Accelerator.
  - Enabling registered users to access all stores in the Extended Sites business model
    HCL Commerce users can access storefronts by virtue of having the role of Registered Customer in the organization that owns the store, or in any organization above it. The roles a user has access to during registration are defined within the MemberRegistrationAttributes.xml file.
  - Hystrix on the Store server
    The Hystrix framework is used as a proxy for back-end resources such as the Transaction server and Search server by default. This can be disabled, but does have performance implications that must be considered.
- 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.

Marketing campaign input file definitions

Use a MarketingCampaign.csv input file to load information to create marketing campaigns for a store. After you load the data, business users can manage the new campaigns with the Marketing tool.

You can extract campaign objects with the Data Extract utility to create a MarketingCampaign.csv input file that you can then load with the Data Load utility. For example, if you want to copy or move campaigns between stores or instances, such as for creating one or more test environments. Sample configuration files are provided for you to use with the Data Extract utility to extract campaign data from the DMCAMPAIGN database table.

Sample configuration files are also provided for you to use with the Data Load utility to load the campaign data. When you load the MarketingCampaign.csv file, the Data Load utility populates the DMCAMPAIGN database table.

For more information about extracting and loading marketing data, see

After you create your campaigns, you can load additional information to associate marketing activities with the campaigns. For more information about the marketing activity-related data that you can load, see:

CSV column and XML element definitions

name

(Required, String) The campaign name.

This column or element maps to DMCAMPAIGN.NAME.

description

(String) The description of the marketing campaign.

This column or element maps to DMCAMPAIGN.DESCRIPTION.

state

(Integer) The current state of the marketing campaign. You can set the following values for this column or element:

0: The campaign is inactive. This value is the default value.
1: The campaign is active.

This column or element maps to DMCAMPAIGN.STATE.

season

(String) The season of the year in which the campaign is to run.

This column or element maps to DMCAMPAIGN.SEASON.

owner

(String) The name of the member organization that owns the campaign.

This column or element maps to DMCAMPAIGN.OWNER.

objective

(String) The objectives and goals that the marketing campaign intends to reach.

This column or element maps to DMCAMPAIGN.OBJECTIVE.

delete

(String) Indicates whether to delete the record. Specify 1 to delete the record.

Note: If you want to delete all of the database records that match the records in a file, you can run the Data Load utility in delete mode. For more information, see Configuring the data load order.