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.
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.
User interface widgets
The user interface widgets in the Aurora starter store extend the functionality of available jQuery widgets to create a versatile, customer-friendly store. They add new functionality, changing the appearance and interaction experience in the store.
wc.widgets.Carousel
The Carousel widget wraps around a third-party plug-in, Owl Carousel. The Carousel widget is used in Content Carousel and Recommendation widgets to display multiple contents that transition from one image to the next. By default, the pagination control that is inherited from Owl Carousel is disabled. HCL Commerce generates pagination control with specified pagination buttons.

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.
  - 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 AJAX framework
      The HCL Commerce AJAX framework is an extension of the jQuery AJAX framework. It provides an easy to use framework that meets most AJAX requirements for storefront development, and hides some of the complexity and repetitive code that a storefront developer often encounters.
    - AJAX framework
      The AJAX framework helps determine the refresh areas of pages, and the content that populates them. The framework helps track the status of store pages, and the content that is generated when customers interact with the store.
    - User interface widgets
      The user interface widgets in the Aurora starter store extend the functionality of available jQuery widgets to create a versatile, customer-friendly store. They add new functionality, changing the appearance and interaction experience in the store.
      - wc.widgets.Carousel
        The Carousel widget wraps around a third-party plug-in, Owl Carousel. The Carousel widget is used in Content Carousel and Recommendation widgets to display multiple contents that transition from one image to the next. By default, the pagination control that is inherited from Owl Carousel is disabled. HCL Commerce generates pagination control with specified pagination buttons.
      - wc.widgets.Grid
        The Grid widget is used to display product tables in various pages. The Grid widget helps to easily build a responsive table.
      - wc.widget.RefreshArea
        The RefreshArea widget is used to wrap a Document Object Model (DOM) node that is refreshed by replacing the innerHTML property with new content loaded from the server. That is, a refresh area is a section of a page, which is dynamically updated with new content. A refresh area widget is associated with a registered refresh controller that handles listening for events that require this widget to be refreshed.
      - wc.widget.ScrollablePane
        The ScrollablePane widget displays a scrolling thumbnail picker that displays product images and details. It provides a scrolling effect for the items or images that are contained within the content of the widget. Each item within the scrollable pane must be in contained in a ContentPane widget. The scrollable pane supports both automatic and manual scrolling of the items that are displayed in the widget.
      - wc.widgets.Select
        The Select widget is an extension of the JQuery UI API selectmenu. The Select widget inherits all the functionality from JQuery widget selectmenu and displays a select box to match the overall style of the Aurora starter store.
      - wc.widgets.ValidationTextbox
        The ValidationTextbox widget is used as input box with validation function in forms. With ValidationTextbox widget and JQuery datepicker widget, you can input a date by either typing or selecting from a calendar. ValidationTextbox requires wcTooltip widget to display invalid messages.
      - wc.widgets.wcTooltip
        The wcTooltip widget is used to display error messages or information when a shopper hovers over an anchored element. wcTooltip is usually anchored on a Document Object Model (DOM) element.
      - wc.widgets.WCDialog
        The WCDialog widget is an extension of JQuery UI API dialog and is used to display a pop up window, such as the mini shopping cart on the header, Language/Currency selection box, or quick info pop up box.
  - 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.

wc.widgets.Carousel

The Carousel widget wraps around a third-party plug-in, Owl Carousel. The Carousel widget is used in Content Carousel and Recommendation widgets to display multiple contents that transition from one image to the next. By default, the pagination control that is inherited from Owl Carousel is disabled. HCL Commerce generates pagination control with specified pagination buttons.

Sample Output

Carousel sample output

Example

<div data-widget-type="wc.Carousel" data-widget-options="
   {‘prevButton’: ‘a.prevPageButton’, ‘nextButton’: ‘a.nextPageButton’, ‘overflowVisible’: true, 
      ‘owlCarouselOptions’: {‘singleItem’: true}}" >
</div>

Parameters

prevButton: (String) The jQuery selector for the Previous button. You can specify a false, unused value if a Previous button does not exist.
nextButton: (String) The jQuery selector for the Next button. You can specify a false, unused value if a Next button does not exist.
paginationButtons: (String) The jQuery selector for the pagination button. You can specify a false, unused value if a pagination button does not exist.
overflowVisible: (Boolean) Determine whether to display content that is bigger than the container.
owlCarouselOptions: (Object) Specify options that are supported by Owl Carousel, such as slideSpeed or singleItem.
contentContainer: (String) The element that contains the content.