In order to use the custom adapter service with the CoreMedia system. A minimum set of configuration and setup is needed.

Configuring the adapter service Endpoint

To enable the generic client to connect to a custom adapter service an endpoint for that service has to be added on the client side. Therefore a new key value pair has to be configured via the commerce.hub.data.endpoints property.

The key can freely be defined, but it should easily identify the connected commerce system. The key will be also used as health-indicator key.

Please refer to the Java documentation of the method com.coremedia.blueprint.base.livecontext.client.settings.CommerceSettings#getEndpoint()

The value should consist of the host name and the port of the adapter service.

The Vendor Name

To integrate an adapter service with the CoreMedia system, a vendor name for the commerce system has to be configured via metadata.vendor in the adapter service. This name is used as a prefix for all commerce IDs by the coreMedia system and should therefore never be changed.

The Commerce Settings

The CoreMedia Commerce Hub generic client expects a commerce system to have at least one catalog and a root category. If this is the case, no further configuration is needed to set up the commerce connection. If the commerce system provides multiple catalogs or stores, both may be configured via the site's commerce settings document.

Caution

The commerce connection is an instance of the GenericCommerceConnection managed by the generic client. It is valid only if the generic client is able to create an instance of the GenericStoreContext while communicating with the custom adapter service.

After the commerce connection for the adapter service is set up correctly, the catalog along with its categories and products can be displayed in the CoreMedia Studio library.

Note

If the CAE is used for augmenting the commerce storefront the LinkRepository needs to be implemented.