12. Commerce Adapter Properties

Number of cache entries per cache class until cache eviction takes place. The keys must match the cache classes as defined by the cache keys. Please refer to javadoc of com.coremedia.cache.CacheKey.

TTL in seconds until certain cache entries are invalidated.

Mapping of data lookup keys (cache classes) to circuit breaker names. Mapping to 'none' disables circuit breakers for the mapped data lookup keys.

Example: Mapping 'product' to 'products' will use a separate circuit breaker named 'products' for product calls. The new circuit breaker can have its own configuration via 'resilience4j.circuitbreaker.configs.products'. Mapping 'product' to 'none' will disable the circuit breaker for product requests.

The default breaker name.

Disable circuit breakers and cache failed calls in cache class failed.

The factor to be applied to the delay to compute the next delay.

The initial delay of the backoff.

The number of request/response pairs to cache persistently. The keys must be valid cache classes as configured for the data lookup service, e.g., catalog, catalogs, category, categories, etc.

Root resource to persistently store messages. If this property is not set, no messages will be persisted. Configure a value to enable persistent caching of messages.

Controls if a parent dependency is registered for a non-base product so that it is invalidated together with its base product.

Whether to recompute entities proactively on invalidation.

Whether or not to propagate invalidations of entities to the clients.

Map of additional metadata.

Can be used as customization hook. All properties starting with "metadata.additional-metadata.*" are transmitted to the generic client on the CMS side.

Format of the custom attribute values.

The keys are always plain strings.

Used to identify the deserialization format on the CMS side.

List of parameter names, which values need to be transmitted with every entity request from the CMS side.

Map of key value pairs.

Used as replacement map for example for link building in the generic client on the CMS side.

Name of the vendor.

Used to identify the connected vendor on the CMS side.

Determines that the master category is set on a product. A "master" category must exist in the master catalog and the sales catalog as well. If it is combined with categoryValidationEnabled = true and if the master category cannot be loaded then the next valid category is returned.

If set to "true" the master category is set on products.

The name of an authentication header the REST connector uses the access the WCS REST services.

Default is empty, no Authentication header is used.

The value of an authentication header the REST connector uses the access the WCS REST services.

Determines that only a loadable category is set on a product. All eligible categories are loaded one after the other. The first one that is successful is used.

If set to "true" only a loadable category is set on products.

Maximum number of connections used by the REST connector to access WCS REST services.

This property has been deprecated and will be removed in a future version.

Use commerce.rest.client.connection-pool-size instead.

Reason:

use base adapter configuration option

The connection request timeout in milliseconds used by the REST connector to access WCS REST services.

That is the time to wait for a response after a connection has been successfully established. A value of "-1" means the client will wait "forever".

This property has been deprecated and will be removed in a future version.

Use commerce.rest.client.connection-request-timeout instead.

Reason:

use base adapter configuration option

The connection timeout in milliseconds used by the REST connector to access WCS REST services.

That is the time until the server accepts the request. A value of "0" means "infinite".

This property has been deprecated and will be removed in a future version.

Use commerce.rest.client.connect-timeout instead.

Reason:

use base adapter configuration option

The regular expression pattern for which the client should filter the relevant cookies. This should narrow down the cookies on the client side to a subset of cacheable cookies.

Cookie filter pattern for specific environment. The structure of the Map should be: key=environment, value=cookie pattern. The environment is the hardcoded name of the entity param which must be configured on the CM App client side e.g. `commerce.hub.data.customEntityParams.environment=PREVIEW|LIVE``

Examples:

wcs.link.filter-pattern-for.preview=WCP?_.+

wcs.link.filter-pattern-for.live=WC?_.+

The regular expression pattern for the WCS user session cookie. See description for WC_USERACTIVITY_ID in:

The default locale the REST connector is using if no locale is given.

Determines if dynamic pricing is enabled.

If set to "true" the PriceRepository tries to get personalized prices from the WCS, otherwise an empty price list is returned.

Asset URL prefix that is used to build asset links to shop images in the live system.

Typically, a proxy url is set including protocol and possibly a context path prefix.

Should only be set if the adapter does not need to distinguish environments. In this case no environment metadata.custom-entity-param-names parameter is required.

Examles:

https://shop-hcl.coremedia.vm

https://shop-preview-hcl.coremedia.vm

This and the further wcs.link properties are not needed when only connecting to HCL Commerce 9.1+ React stores.

Asset URL prefixes which are used to build asset links to shop images for different environments.

Typically, a proxy url is set including protocol and possibly a context path prefix. The structure of the Map should be: {key=environment, value=url}. The environment is the hardcoded name of the entity param which must be configured in the CMS app, e.g. commerce.hub.data.custom-entity-params.environment=preview|live. IMPORTANT: The keys used here must match those used in the CMS app via commerce.hub.data.customEntityParams.environment={environment}.

Examples:

wcs.link.asset-url-for.preview=https://shop-preview-hcl.coremedia.vm

wcs.link.asset-url-for.live=https://shop-hcl.coremedia.vm

For configuration options see also documentation of wcs.link.storefront-url-for.

This and the further wcs.link properties are not needed when only connecting to HCL Commerce 9.1+ React stores.

Map of StorefrontRef. Used to build shop urls for the Studio Preview and Content-Led integration scenarios.

Known default lookup keys are defined in StorefrontRefKeysCommerceLed and StorefrontRefKeysContentLed. Only lookup keys in lowercase and without "_" are valid.

These patterns can include tokens which will be replaced. These tokens must be well known. The following tokens are predefined:

This and the further wcs.link properties are not needed when only connecting to HCL Commerce 9.1+ React stores.

Used to generate category page links into CoreMedia fragments.

Non-seo-friendly shop URLs to category pages.

Used to build the preview URL to a category page.

Used to build seo-friendly URLs to category pages.

Used to build the redirect URL to the checkout page.

Used to generate ajax urls to CoreMedia contents into CoreMedia fragments.

Used to build links to shop pages displaying CoreMedia Articles and Channels into CoreMedia fragments.

Used to build the preview URL to a shop page which displays a CoreMedia content.

Used to build seo-friendly URLs to shop pages displaying CoreMedia Articles and Channels.

Used to build a preview url with a contract parameter.

Used to build the preview URL to a shop page which has no seo support.

Used to build non-seo-friendly URLs to shop pages.

Used to build the preview URL to a shop page.

Used to build seo-friendly URLs to shop pages.

Used to the link to the home page.

Used to build the preview URL to the shop home page.

Used to build the URL to the Login page.

Used to build the URL which logs off the current user.

Used to build product detail page links into CoreMedia fragments.

Url pattern that is used to build non-seo-friendly shop URLs to product detail pages.

Used to build the preview URL to a product detail page.

Url pattern that is used to build shop URLs for product detail pages.

Used to build the parameterized search url to be redirected to the shop search result page.

Used to build URLs to shop pages into CoreMedia fragments.

Max url segments of an seo url for products

This and the further wcs.link properties are not needed when only connecting to HCL Commerce 9.1+ React stores.

Storefront URL prefix that is used to build storefront links to shop pages and resources in the live system.

Typically, a proxy url is set, including protocol and possibly a context path prefix.

Should only be set if the adapter does not need to distinguish environments In this case no environment metadata.custom-entity-param-names parameter is required.

Examples:

https://shop-hcl.coremedia.vm/webapp/wcs/shop

https://shop-preview-hcl.coremedia.vm/webapp/remote/preview/servlet

This and the further wcs.link properties are not needed when only connecting to HCL Commerce 9.1+ React stores.

Storefront URLs which are used to build storefront links to shop pages and resources for different environments. The structure of the Map should be: {key=environment, value=url}.

The multi-environment support needs to be activated via metadata.custom-entity-param-names=environment.

Examples:

wcs.link.storefront-url-for.preview=https://shop-preview-hcl.coremedia.vm/webapp/remote/preview/servlet

wcs.link.storefront-url-for.live=https://shop-hcl.coremedia.vm/webapp/wcs/shop

The environment name for the custom entity param must be configured on the client side (CAE, Studio, etc.). Global configuration example: commerce.hub.data.customEntityParams.environment=preview|live

You may also configure multiple storefront URLs for different sites/environments via the commerce settings struct: commerce (Struct) customEntityParams (Struct) environment=siteus (String) Keep the lookup keys simple. Use lowercase with no special characters.

Be aware that you need to configure the environment values on the client site first, otherwise lookups can't work and will fail. There is no default fallback as this could lead to even more confusion.

This and the further wcs.link properties are not needed when only connecting to HCL Commerce 9.1+ React stores.

The time a network address will be cached from the WCS REST Connector.

A value of "-1" means network addresses will be cached "forever".

This property has been deprecated and will be removed in a future version.

Use commerce.rest.client.network-address-cache-ttl instead.

Reason:

use base adapter configuration option

The service user password the REST connector uses to log in into WCS.

This is mandatory and must be set.

The threshold for response sizes. A warning is logged for responses exceeding the configured size.

This property has been deprecated and will be removed in a future version.

Use commerce.rest.response-size-threshold-kilo-bytes instead.

Reason:

use base adapter configuration option

Configures the search engine type of the HCL Commerce System.

It is only used since HCL Commerce 9.1 and the search engine ES is used as the default.

Configures the prefix of the HCL Commerce Search profile.

For HCL Commerce 9.0 and older the prefix CoreMedia is used as the default search profile prefix. With HCL Commerce 9.1 the prefix should be set to HCL.

The general WCS URL to access the search-based WCS REST services via http.

If a REST service does not need secure access this url prefix is used.

The secure WCS URL to access the search-based WCS REST services via https.

If a REST service needs secure access this url prefix is used.

The secure WCS URL to access the WCS REST services via https.

If a REST service needs secure access this url prefix is used.

Configures the keys of the facets that that can only be added with a single value to product search requests.

Should e.g. be configured with parentCatgroup_id_search when connecting to WCS 8.0, because it doesn't allow searching with multiple category facets.

The socket timeout in milliseconds used by the REST connector to access WCS REST services.

That is the time to wait for a response after a request has been sent. A value of "0" means "infinite".

This property has been deprecated and will be removed in a future version.

Use commerce.rest.client.socket-timeout instead.

Reason:

use base adapter configuration option

Determines if the REST connector accepts any certificates from the WCS.

Note, this value has to be set to "false" in production environments. For internal test systems it is ok bypassing the server authentication.

This property has been deprecated and will be removed in a future version.

Use commerce.rest.client.trust-all-ssl-certificates instead.

Reason:

use base adapter configuration option

The general WCS URL to access the WCS REST services via http.

If a REST service does not need secure access this url prefix is used.

The service user the REST connector uses to log in into WCS.

This is mandatory and must be set.

The WCS version. Some WCS REST services are version specific.