close

Filter

loading table of contents...

Connector for HCL Commerce Manual / Version 2401

Table Of Contents

12. Commerce Adapter Properties

wcs.always-use-master-category
Type java.lang.Boolean
Default false
Description

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.

wcs.auth-header-name
Type java.lang.String
Default  
Description

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

Default is empty, no Authentication header is used.

wcs.auth-header-value
Type java.lang.String
Default  
Description

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

wcs.category-validation-enabled
Type java.lang.Boolean
Default false
Description

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.

wcs.default-locale
Type java.util.Locale
Default  
Description

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

wcs.dynamic-pricing-enabled
Type java.lang.Boolean
Default false
Description

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.

wcs.password
Type java.lang.String
Default  
Description

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

This is mandatory and must be set.

wcs.search-engine
Type com.coremedia.commerce.adapter.wcs.client.common.SearchEngineType
Default  
Description

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.

wcs.search-profile-prefix
Type java.lang.String
Default CoreMedia
Description

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.

wcs.search-url
Type java.lang.String
Default  
Description

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.

wcs.secure-search-url
Type java.lang.String
Default  
Description

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.

wcs.secure-url
Type java.lang.String
Default  
Description

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

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

wcs.single-value-search-facets
Type java.util.List<java.lang.String>
Default  
Description

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.

wcs.url
Type java.lang.String
Default  
Description

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.

wcs.username
Type java.lang.String
Default  
Description

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

This is mandatory and must be set.

wcs.version
Type java.lang.String
Default  
Description

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

wcs.cookie.user.filter-pattern
Type java.lang.String
Default WCP?_.+
Description

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.

wcs.cookie.user.filter-pattern-for
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

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?_.+
wcs.cookie.user.user-session-pattern
Type java.lang.String
Default WCP?_USERACTIVITY_(-1002|\d+)
Description

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

wcs.link.asset-url
Type java.lang.String
Default  
Description

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.

wcs.link.asset-url-for
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

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.

wcs.link.link-templates
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

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:

  • {storefrontUrl} ... the current store front URL

  • {storeId} ... the current store id

  • {locale} ... the current locale in java format, eg. en_US

  • {language} ... the current language in java format, eg. en

  • {langId} ... the current language as WCS specific id, e.g. "-1" as default language

  • {catalogId} ... the current catalog id

  • {categoryId} ... the current category id

  • {productId} ... the current product id

  • {seoSegment} ... the current seo segment path (can contain path delimiters)

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

wcs.link.link-templates.categorylinkfragment
Type java.lang.String
Default <!--CM {"parentCategoryId":"{parentCategoryId}","topCategoryId":"{topCategoryId}","level":{level},"renderType":"url","categoryId":"{categoryId}","objectType":"category"} CM-->
Description

Used to generate category page links into CoreMedia fragments.

wcs.link.link-templates.categorynonseourl
Type java.lang.String
Default {storefrontUrl}/CategoryDisplay?categoryId={categoryTechId}&storeId={storeId}&langId={langId}&catalogId={catalogId}
Description

Non-seo-friendly shop URLs to category pages.

wcs.link.link-templates.categorypreviewurl
Type java.lang.String
Default {storefrontUrl}/CategoryDisplay?categoryId={categoryTechId}&storeId={storeId}&langId={langId}&catalogId={catalogId}&newPreviewSession=true&previewToken={previewToken}
Description

Used to build the preview URL to a category page.

wcs.link.link-templates.categoryseourl
Type java.lang.String
Default {storefrontUrl}/{language}/{storeName}/{pageId}
Description

Used to build seo-friendly URLs to category pages.

wcs.link.link-templates.checkoutredirecturl
Type java.lang.String
Default {storefrontUrl}/OrderCalculate?calculationUsageId=-1&storeId={storeId}&updatePrices=1&catalogId={catalogId}&orderId=.&langId={langId}&URL=AjaxOrderItemDisplayView
Description

Used to build the redirect URL to the checkout page.

wcs.link.link-templates.cmajaxlinkfragment
Type java.lang.String
Default <!--CM {"url":"{url}","renderType":"url","objectType":"ajax"} CM-->
Description

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

wcs.link.link-templates.cmcontentlinkfragment
Type java.lang.String
Default <!--CM {"externalSeoSegment":"{externalSeoSegment}","renderType":"url","objectType":"content"} CM-->
Description

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

wcs.link.link-templates.cmcontentpreviewurl
Type java.lang.String
Default {storefrontUrl}/{language}/{storeName}/cm/{seoSegment}?newPreviewSession=true&previewToken={previewToken}
Description

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

wcs.link.link-templates.cmcontenturl
Type java.lang.String
Default {storefrontUrl}/{language}/{storeName}/cm/{seoSegment}
Description

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

wcs.link.link-templates.contractpreviewurl
Type java.lang.String
Default true
Description

Used to build a preview url with a contract parameter.

wcs.link.link-templates.externalpagenonseopreviewurl
Type java.lang.String
Default {storefrontUrl}/{externalUriPath}&newPreviewSession=true&previewToken={previewToken}
Description

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

wcs.link.link-templates.externalpagenonseourl
Type java.lang.String
Default {storefrontUrl}/{externalUriPath}
Description

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

wcs.link.link-templates.externalpagepreviewurl
Type java.lang.String
Default {storefrontUrl}/{language}/{storeName}/{pageId}?newPreviewSession=true&previewToken={previewToken}
Description

Used to build the preview URL to a shop page.

wcs.link.link-templates.externalpageseourl
Type java.lang.String
Default {storefrontUrl}/{language}/{storeName}/{pageId}
Description

Used to build seo-friendly URLs to shop pages.

wcs.link.link-templates.homepagelinkfragment
Type java.lang.String
Default <!--CM {"externalSeoSegment":"","renderType":"url","objectType":"page"} CM-->
Description

Used to the link to the home page.

wcs.link.link-templates.homepagepreviewurl
Type java.lang.String
Default {storefrontUrl}/{language}/{storeName}/{pageId}?newPreviewSession=true&previewToken={previewToken}
Description

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

wcs.link.link-templates.loginurl
Type java.lang.String
Default {storefrontUrl}/UserRegistrationForm?catalogId={catalogId}&langId={langId}&storeId={storeId}
Description

Used to build the URL to the Login page.

wcs.link.link-templates.logouturl
Type java.lang.String
Default {storefrontUrl}/Logoff?storeId={storeId}
Description

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

wcs.link.link-templates.productlinkfragment
Type java.lang.String
Default <!--CM {"productId":"{productId}","renderType":"url","categoryId":"{categoryId}","objectType":"product"} CM-->
Description

Used to build product detail page links into CoreMedia fragments.

wcs.link.link-templates.productnonseourl
Type java.lang.String
Default {storefrontUrl}/ProductDisplay?productId={productTechId}&storeId={storeId}&langId={langId}&catalogId={catalogId}
Description

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

wcs.link.link-templates.productpreviewurl
Type java.lang.String
Default {storefrontUrl}/ProductDisplay?productId={productTechId}&storeId={storeId}&langId={langId}&catalogId={catalogId}&newPreviewSession=true&previewToken={previewToken}
Description

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

wcs.link.link-templates.productseourl
Type java.lang.String
Default {storefrontUrl}/{language}/{storeName}/{pageId}
Description

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

wcs.link.link-templates.searchredirecturl
Type java.lang.String
Default {storefrontUrl}/SearchDisplay?storeId={storeId}&catalogId={catalogId}&langId={langId}&pageSize=12&searchTerm={searchTerm}
Description

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

wcs.link.link-templates.shoppagelinkfragment
Type java.lang.String
Default <!--CM {"externalSeoSegment":"{externalSeoSegment}","externalUriPath":"{externalUriPath}","renderType":"url","objectType":"page"} CM-->
Description

Used to build URLs to shop pages into CoreMedia fragments.

wcs.link.product-max-url-segments
Type java.lang.Integer
Default 3
Description

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.

wcs.link.storefront-url
Type java.lang.String
Default  
Description

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.

wcs.link.storefront-url-for
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

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.

cache.capacities
Type java.util.Map<java.lang.String,java.lang.Long>
Default  
Description

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.

cache.timeout-seconds
Type java.util.Map<java.lang.String,java.lang.Long>
Default  
Description

TTL in seconds until certain cache entries are invalidated.

entities.circuit-breaker-names
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

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.

entities.default-circuit-breaker-name
Type java.lang.String
Default base
Description

The default breaker name.

entities.disable-circuit-breakers
Type java.lang.Boolean
Default false
Description

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

entities.exponential-backoff.factor
Type java.lang.Double
Default 1.5
Description

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

entities.exponential-backoff.initial-delay
Type java.time.Duration
Default 2s
Description

The initial delay of the backoff.

entities.message-store.files
Type java.util.Map<java.lang.String,java.lang.Long>
Default  
Description

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.

entities.message-store.root
Type org.springframework.core.io.Resource
Default  
Description

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.

entities.products.register-parent-dependency
Type java.lang.Boolean
Default true
Description

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

entities.recompute-on-invalidation
Type java.lang.Boolean
Default false
Description

Whether to recompute entities proactively on invalidation.

entities.send-invalidations
Type java.lang.Boolean
Default true
Description

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

metadata.additional-metadata
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

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.

metadata.custom-attributes-format
Type com.coremedia.commerce.adapter.base.entities.CustomAttributesFormat
Default  
Description

Format of the custom attribute values.

The keys are always plain strings.

Used to identify the deserialization format on the CMS side.

metadata.custom-entity-param-names
Type java.util.Collection<java.lang.String>
Default  
Description

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

metadata.replacement-tokens
Type java.util.Map<java.lang.String,java.lang.String>
Default  
Description

Map of key value pairs.

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

metadata.vendor
Type java.lang.String
Default  
Description

Name of the vendor.

Used to identify the connected vendor on the CMS side.

Table 12.1. HCL Commerce Adapter related Properties


Search Results

Table Of Contents
warning

Your Internet Explorer is no longer supported.

Please use Mozilla Firefox, Google Chrome, or Microsoft Edge.