10. Commerce Adapter Properties

The base path of the REST API ("/ws410/rest")

Default catalog version. On preview-cae and studio the defaultCatalogVersion.preview value is used

The full qualified hostname of the Hybris system

Base URL for assets (e.g. https://shop-hybris.yourdomain.com)

Map of link templates.

Only lookup keys in 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 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.

The storefront url

ClientID used for OAuth2 Authentication with SAP Commerce System. Used to get authorized to access protected OCC API calls.

Password used together with the clientId.

Timeout for DNS cache entries in milliseconds

Path used to request new OAuth Tokens

Port used for OAuth token requests

Protocol used for OAuth token requests

Base path of OCC Rest Services

Configure attribute names, which are transmitted to the client as customAttributes. The key corresponds to the prefix of the document for json mappgings in lowercase. For example for ProductDocument it is "product".

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:

hybris.occ.custom-attributes-for.product=metaKeywords,metaDescription

The password belonging to the administrative user

Port of SAP Commerce REST Services (9001)

Secure port of SAP Commerce REST Services (9002)

The preview token user passed to the Preview Token Service

The preview token usergroup passed to the Preview Token Service

Protocol used for REST communication with SAP Commerce (http)

Secure protocol used for REST communication with SAP Commerce (https)

The administrative user used to access the SAP Hybris REST Services

Cache invalidation chunk size.

Maximum wait time for cache invalidation.

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.