close

Filter

loading table of contents...

Connector for SAP Commerce Cloud Manual / Version 2307

Table Of Contents

9. Commerce Adapter Properties

hybris.base-path
Type java.lang.String
Default /ws410/rest
Description

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

hybris.default-catalog-version-preview
Type java.lang.String
Default Staged
Description

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

hybris.host
Type java.lang.String
Default  
Description

The full qualified hostname of the Hybris system

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

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

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

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:

  • {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

  • {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)

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

  • {previewTicket} ... the preview ticket id

  • {userGroup} ... the current user group, if available

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

hybris.link.link-templates.categorypreviewurl
Type java.lang.String
Default {storefrontUrlPreview}/cmpreview?site={storeId}&catalogId={catalogId}&catalogVersion={catalogVersion}&ticketId={previewTicket}&userGroup={userGroup}&id={categoryId}&type=category
Description

Used to build the preview URL to a category page.

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

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

hybris.link.link-templates.cmcontentpreviewurl
Type java.lang.String
Default {storefrontUrlPreview}/cmpreview?site={storeId}&catalogId={catalogId}&catalogVersion={catalogVersion}&ticketId={previewTicket}&userGroup={userGroup}&id={seoSegment}&type=content
Description

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

hybris.link.link-templates.externalpagepreviewurl
Type java.lang.String
Default {storefrontUrlPreview}/cmpreview?site={storeId}&catalogId={catalogId}&catalogVersion={catalogVersion}&ticketId={previewTicket}&userGroup={userGroup}&id={pageId}&type=externalpage
Description

Used to build the preview URL to a shop page.

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

hybris.link.link-templates.productpreviewurl
Type java.lang.String
Default {storefrontUrlPreview}/cmpreview?site={storeId}&catalogId={catalogId}&catalogVersion={catalogVersion}&ticketId={previewTicket}&userGroup={userGroup}&id={productId}&type=product
Description

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

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

Used to build URLs to shop pages into CoreMedia fragments.

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

The storefront url

hybris.oauth.client-id
Type java.lang.String
Default  
Description

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

hybris.oauth.client-secret
Type java.lang.String
Default  
Description

Password used together with the clientId.

hybris.oauth.network-address-cache-ttl-in-millis
Type java.lang.Integer
Default -1
Description

Timeout for DNS cache entries in milliseconds

hybris.oauth.path
Type java.lang.String
Default /authorizationserver/oauth/token
Description

Path used to request new OAuth Tokens

hybris.oauth.port
Type java.lang.Integer
Default 9002
Description

Port used for OAuth token requests

hybris.oauth.protocol
Type java.lang.String
Default https
Description

Protocol used for OAuth token requests

hybris.occ.base-path
Type java.lang.String
Default /occ/v2
Description

Base path of OCC Rest Services

hybris.occ.custom-attributes-for
Type java.util.Map<java.lang.String,java.util.List<java.lang.String>>
Default  
Description

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
hybris.password
Type java.lang.String
Default  
Description

The password belonging to the administrative user

hybris.port
Type java.lang.Integer
Default 9001
Description

Port of SAP Commerce REST Services (9001)

hybris.port-ssl
Type java.lang.Integer
Default 9002
Description

Secure port of SAP Commerce REST Services (9002)

hybris.preview-token-user
Type java.lang.String
Default anonymous
Description

The preview token user passed to the Preview Token Service

hybris.preview-token-user-group
Type java.lang.String
Default  
Description

The preview token usergroup passed to the Preview Token Service

hybris.protocol
Type java.lang.String
Default http
Description

Protocol used for REST communication with SAP Commerce (http)

hybris.protocol-secure
Type java.lang.String
Default https
Description

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

hybris.user
Type java.lang.String
Default  
Description

The administrative user used to access the SAP Hybris REST Services

hybris.http-client.invalidation-chunk-size
Type java.lang.Integer
Default 500
Description

Cache invalidation chunk size.

hybris.http-client.invalidation-max-wait-in-milliseconds
Type java.lang.Integer
Default 0
Description

Maximum wait time for cache invalidation.

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