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.
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.
WCRefreshController.refresh(parameters)
The WCRefreshController.refresh function refreshes the refresh area with the parameters specified. The parameters are passed as the data attribute into the JQuery.ajax call.

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.
      - WCRefreshController.refresh(parameters)
        The WCRefreshController.refresh function refreshes the refresh area with the parameters specified. The parameters are passed as the data attribute into the JQuery.ajax call.
      - WCRefreshController.updateFormId(newFormId)
        The WCRefreshController.updateFormId function updates the form id that is passed to the AJAX call. If specified, all input elements in the specified form are passed as the data attribute into the JQuery.ajax call.
      - WCRefreshController.updateUrl(newURL)
        The WCRefreshController.updateUrl function allows developers to update the URL of the refresh area. The URL is usually defined in the JSP by using the refreshurl attribute, but in some circumstances you might need to change the URL.
      - wcRenderContext.declare
        The wcRenderContext.declare function declares a new refresh controller, associates it with the refreshAreaIds passed in and initializes it with the specified initialization properties. The initialization properties are in addition to the new refresh controller's properties. A refresh controller control refresh area widgets, and listens to changes in the render context and model and decides whether the registered refresh areas must be updated.
      - wcRenderContext.getRefreshAreaIds
        The wcRenderContext.getRefreshAreaIds function returns the refresh area IDs that are associated with the specified render context.
      - wcRenderContext.addRefereshAreaId
        The wcRenderContext.addRefereshAreaId function adds a refresh area ID to an existing render context.
      - wcRenderContext.getRenderContextProperties
        The wcRenderContext.getRenderContextProperties function returns the render context declared by the specified identifier.
      - wcRenderContext.updateRenderContext
        The wcRenderContext.updateRenderContext function retrieves the render context with the specified ID and applies the updates that are found in the specified updates object. After a context object is updated, the framework automatically calls all the renderContextChangedHandler methods of all the controllers.
      - wcRenderContext.testForChangedRC
        The wcRenderContext.testForChangedRC function searches the specified array of property names for a render context property that has changed since the last time a render context changed event was detected. It returns a value of true if any of the specified render context properties have changed, and returns a value of false if none of the specified render context properties have changed.
      - wcRenderContext.checkIdDefined
        The wcRenderContext.checkIdDefined function checks if a render context with the specified ID already exists. It returns true if there is an existing render context defined, false otherwise.
      - wcService.declare
        The wcService.declare function declares a new AJAX service with the specified ID. In HCL Commerce, a service is a server URL that performs a server object create, update, delete, or other server processing. When needed, a Transaction server URL is called by using AJAX in the JavaScript code. When the service completes successfully, a JSON object that contain all the response properties of the URL request is returned to successHandler (the success response) or failureHandler (the failure response) defined JavaScript function. In addition, a WCTopic.publish is sent to any subscribed listeners if the service completes successfully. In this case, the WCTopic.subscribe events listening to the specified topic will be triggered.
      - wcService.getServiceById
        The wcService.getServiceById helper function is for getting a handle on the service object that was declared by using the wcService.declare function. Once the service object is obtained, you can update any information in the service object such as URL, formId, or others. This function is helpful when you find a service and update its parameters before you invoke it.
      - wcService.invoke
        The wcService.invoke function finds the registered service with the specified service ID and invokes the service via AJAX by using the specified parameters.
    - 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.
  - 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.

WCRefreshController.refresh(parameters)

The WCRefreshController.refresh function refreshes the refresh area with the parameters specified. The parameters are passed as the data attribute into the JQuery.ajax call.

Example

$("#MiniShopCartContents").refreshWidget("refresh", 
   wcRenderContext.getRenderContextProperties("MiniShopCartContentsContext"));

Parameters

parameters: (Object) The service parameters.