14. Commerce Adapter Properties

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.

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 "for ever".

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".

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

If set to true, product search by category will include products from sub categories.

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.

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

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

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

This is mandatory and must be set.

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.

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 BOD-based 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".

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.

The general WCS URL to access the BOD-based 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 login into WCS.

This is mandatory and must be set.

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

The host where the WCS commerce system is installed.

This is a convenience property to be used in conjunction with the Spring profile for version of the WCS commerce system versions to be connected:

In these profiles, the URL paths for the different WCS versions are configured relative to the WCS host.

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 side e.g. `commerce.hub.data.customEntityParams.environment=PREVIEW|LIVE``

IMPORTANT! The keys used here, must match those used on the CM App side via metadata.custom-entity-param-names={environment}

Use this property if the adapter needs to distinguish environments. In this case it is required to set the above mentioned custom entity param.

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

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

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 on the CM App side e.g. `commerce.hub.data.customEntityParams.environment=PREVIEW|LIVE`` IMPORTANT: The keys used here, must match those used on the CM App side via metadata.custom-entity-param-names={environment}

Use this property if the adapter needs to distinguish environments. In this case it is required to set the above mentioned custom entity param.

Examples:

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

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

Map of com.coremedia.commerce.adapter.base.entities.StorefrontRef of type com.coremedia.commerce.adapter.base.entities.StorefrontRefType.URL. Used to build shop urls for the Studio Preview and Content-Led integration scenarios.

Known default lookup keys are defined in com.coremedia.commerce.adapter.wcs.repositories.LinkConstants. Only lookup keys 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:

Used to generate category page links into CoreMedia fragments.

Non-seo-friendly shop URLs to category pages.

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 seo-friendly URLs to shop pages displaying CoreMedia Articles and Channels.

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

Used to build a preview url with a contract parameter.

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

Used to build seo-friendly URLs to shop pages.

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.

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

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.

Examles:

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

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

Storefront URL prefixes 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 environment is the hardcoded name of the entity param which must be configured on the CM App side e.g. `commerce.hub.data.customEntityParams.environment=PREVIEW|LIVE``

IMPORTANT! The keys used here, must match those used on the CM App side via metadata.custom-entity-param-names={environment}

Use this property if the adapter needs to distinguish environments. In this case it is required to set the above mentioned custom entity param.

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

Path token that is used for content pages (shop pages with a CMS seopath as parameter). The default is "cm" with a path like "../cm/cms-seo-path".

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.

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 {@link CustomAttributesFormats}.

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.

Flag if commerce adapter implementation supports multiple catalogs.