Documentation Center

Setting up the Connector for SAP Commerce

The setup process for the Tridion Connector for SAP Commerce includes adding the connector itself to your Tridion Sites implementation as well as a few additional steps to enable the integration.

Before you begin

Before beginning the connector setup process, be sure you have the following:

  • One of the following versions of Tridion Connector for SAP Commerce:
    • v6.x
    • 1808
    • 1811
    • 1905
  • Connector Add-on package has been provided by SDL Customer Support.
  • SDL Tridion Sites 9.1 or later, is installed and fully operational .
  • If using SDL Tridion Sites 9.1, the following hotfixes are applied:
    • CM_9.1.0.16685
    • ECL_9.1.0.18607
  • If using the connector with Content Delivery, the PCA extension (connector-framework-pca-extension) is installed to the Content Service.

About this task

This topic describes the general process for setting up the Connector for SAP Commerce.

Procedure

  1. In the OAuth user interface, create an OAuth user for SAP Commerce.
    For details, refer to the related topic on OAuth setup.
  2. Upload the Connector for SAP Commerce ZIP package to the Add-ons Service.
  3. Create a JSON configuration that includes appropriate settings for this connector and your environment. In particular, be sure of the following:
    • When the connector will be accessed through the Tridion Sites Content Manager user interface:
      • The 'sitesCm' property is set to true.
      • The configuration defines the TCM-URI of the stub folder.
    • To use the connector with Content Delivery, configure the correct environment name (for example 'staging', 'live') and make sure that it is enabled.
  4. Upload the connector's JSON configuration file to the Add-ons Service.
  5. To complete and verify the connector setup for Content Delivery, do the following:
    1. Restart the Content Service.
      The Content Service should automatically pick up the connector package and configuration from the Add-ons Service and deploy the connector.
    2. Open the GraphQL console at [Content Service URL]/cd/api/graphiql and verify the presence of appropriate GraphQL types for this connector.

Results

A successfully deployed connector will result in one or both of the following changes to your implementation (depending on your choices in the installation process):

  • If you enabled the connector for use the Tridion Sites Content Manager, the name of the connector should appear as a mount point after refreshing a Publication that has been associated with the connector (using the stubs folder TCM-URI).
  • If you configured the connector for use in Tridion Content Delivery, the GraphQL console ([Content Service URL]/cd/api/graphiql) will show GraphQL types for SAP Commerce products and categories, such as in the following example: