Connector for HCL Commerce Manual / Version 2107
Table Of ContentsThe store specific properties that logically define a shop instance are part of the content settings. They configure the Commerce Adapter endpoint, which storeId should be used, which catalog, the currency and other shop related settings.
Refer to the Javadoc of the class com.coremedia.blueprint.base.livecontext.client.settings.CommerceSettings for further details.
Each site can have one single shop configuration (see the Blueprint site concept to learn what a
site is). That means only shop items from exactly that shop instance (with a particular view to
the product catalog) can be interwoven to the content elements of that site. In the example
settings there is a LiveContext settings document linked with the root
channel. This is the perfect place to make these settings.g
The following store specific settings can be configured below the struct property named
commerce:
| Name | Type | Description | Example | Required |
|---|---|---|---|---|
endpoint
| String Property | Host and Port of the Commerce Adapter. | wcs-commerce-adapter:6565 | true (if endpointName is not set) |
endpointName
| String Property | The endpoint name to lookup the Spring gRPC service configuration . | wcs | true (if endpoint is not set) |
locale
| String Property | The ISO locale code for the connected Catalog. This overwrites the Site locale. It is only needed if the CoreMedia Site locale differs from the Shop locale and if you need the exact Shop locale to access the catalog. | en-US | false |
currency
| String Property | The displayed currency for all product prices. | USD | false. If not set, the currency will be retrieved from the site locale. |
storeConfig
| Struct Property | Struct property containing store configuration. | true | |
storeConfig.id
| String Property |
Store id that is used to access the store. If the StoreInfoHandler is deployed
on the HCL Commerce Server side, it can be retrieved automatically by mapping an existing store name.
| 700012345678 | false |
storeConfig.name
| String Property |
Store name that is used to access the store. If the StoreInfoHandler is deployed
on the HCL Commerce Server side, the name is used to retrieve the store id.
| AuroraESite | true |
catalogConfig
| Struct Property | Struct property containing catalog configuration | true | |
catalogConfig.id
| String Property |
Catalog id that is used to access the catalog. If not set, the ID of the default catalog is used.
In a multi-catalog scenario you would also leave it out. In such a case the used
catalogs are retrieved from the livecontext.catalogAliases setting.
| 300012345678 | false |
catalogConfig.name
| String Property |
Catalog name that is used to display a catalog name (e.g in the Studio library).
If not set, the ID of the default catalog is used. In a multi-catalog scenario you would also leave it out.
In such a case the used catalogs are retrieved from the livecontext.catalogAliases
setting.
| AuroraESiteSalesCatalog | false |
catalogConfig.alias
| String Property |
Catalog alias that is used in content to store links to catalog items. The alias catalog
is reserved and used for the default catalog. If not set, the string catalog is used.
In a multi-catalog scenario you would also leave it out. In such a case the used catalogs and aliases are
retrieved from the livecontext.catalogAliases setting.
| master | false |
customEntityParams
| Struct Property | Site specific custom entity parameters, which are attached to the communication with the commerce adapter. See Section 7.4, “Configuring Custom Entity Parameters” for more information. | false. If not set, no site specific custom entities will be used. |
Table 7.1. Livecontext settings
Note
Be aware, that the locale is also part of each shop context. It is defined by the locale of the site. That means all localized product texts and descriptions have the same language as the site in which they are included and one specific currency.
