- 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.
- Reference
Topics in the Reference section contain all of the HCL Commerce reference documentation.
- 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 9.0.0.0 and 9.0.0.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.
- Docker container start up logic for HCL Commerce Version 9.0.0.2 or later
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 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.
- 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.
- Shopping flow URLs
HCL Commerce shopping flow URLs are organized by subsystem.
- Data models
Any given database data model displays the relationship among database tables in the schema.
- Analytics for HCL Commerce
HCL Commerce provides a framework that you can configure to integrate your store with an external Web analytics solution. This framework includes a tag library that you can use in store page JSP files to provide appropriate analytics information to the external analytics system.
- 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.