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

The default locale for accessing the commerce system if no locale parameter was passed into request.

Configure the view type name of image groups used for large product images.

Configure the view type name of image groups used for small product images.

Map of link templates. Only lookup keys lowercase and without "_" are valid.

Known default lookup keys are defined in StorefrontRefKeysCommerceLed.

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.

Used to build the preview URL to a category 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 the preview URL to a shop page.

Used to the link to the home page.

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

Used to build product detail page links into CoreMedia fragments.

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

Used to build URLs to shop pages into CoreMedia fragments.

Base URL of the commerce storefront

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:

sfcc.link.storefront-url-for.us=https://sandbox-us.demandware.net/on/demandware.store/

sfcc.link.storefront-url-for.de=https://sandbox-de.demandware.net/on/demandware.store/

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=us`

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

Enable the conversion of a Studio preview date (perviewDate param) to a sfcc-side preview date (siteDate param). An additional call (shop API /site) is made to determine the "site timezone". Access to the site call must be permitted in the OCAPI Settings of your sandbox for this to work. Set this to "false" to restore the old behavior.

ClientID used for all Data and Shop REST API Calls to the Salesforce Commerce System. Used to set permissions for the ClientID on Shop and Data API - for example, which resources the ClientID is allowed to access

Password used together with the clientId.

Host name of central SFCC endpoint for authentication.

No need to customize.

Path to retrieve access token.

Protocol used to request access token.

The time after which a retry is attempted to fetch an ocapi access token. Until then, all requests that require an access token will end with an IllegalStateException in log.

Configure attribute names, which are transmitted to the client as customAttributes. The key is the name of the OCAPI Document in lowercase and removed "_" (com.coremedia.commerce.adapter.sfcc.ocapi.AbstractOCDocument.getOcType()).

The value is a comma separated list of attributes, which shall be available on the client side via com.coremedia.livecontext.ecommerce.common.CommerceBean#getCustomAttributes.

The value is transmitted as String representation of the JSON Object.

Example:

sfcc.ocapi.custom-attributes-for.product=image_groups,c_isSale

Configure expand parameter names, which are requested from the commerce system via the "expand" parameter. The keys should be defined in lower case without special characters.

The value is a list of expand parameter values.

Example:

sfcc.ocapi.custom-expand-parameters-for.products=images,prices,variations

Same as customAttributesFor but for localized properties. Only the value for the current locale of the request is transmitted to the client.

Optional count for retrieving only a subset of all customer groups. If not set, the default behaviour of the salesforce Data API will apply.

Host name (FQDN) of your SFCC Instance.

Setting if cookies should be accepted.

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

Use commerce.rest.client.cookie-spec instead.

Reason:

use base adapter configuration option

Defines the overal connection limit for a connection pool.

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

Http Client Configuration for Rest communication with SFCC OCAPI Services.

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

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

Reason:

use base adapter configuration option

Http Client Configuration for Rest communication with SFCC OCAPI Services.

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

Defines a connection limit per one HTTP route.

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

Use commerce.rest.client.max-connections-per-route instead.

Reason:

use base adapter configuration option

Http Client Configuration for Rest communication with SFCC OCAPI Services.

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

Http Client Configuration for Rest communication with SFCC OCAPI Services.

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

Setting if client should trust all ssl certificates.

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

Set to true if your base products often have no images assigned. With this flag enabled also SKU image groups are loaded alongside with the product data. If no image is assigned to a product a sku image is used as fallback. Note that this may increase the data footprint between commerce system and adapter. see "all_images" below SFCC Documentation

Protocol used for OCAPI REST communication.

Set to true if integrating with a sandbox instance. Adjust base paths for REST API requests

On sandbox instances the base paths must be prefixed with '/s/{siteId}' see: SFCC Documentation

Configures the OCAPI type to be used to load data from the commerce system. Available types are shop and data.

Version of OCAPI Rest Service used.

The default search limit as supported by the SFCC backend.

List of facet keys. These facets only support single values to be selected.