Documentation Center

Connector for SAP Commerce configuration properties

Implementing the Tridion Connector for SAP Commerce requires a JSON configuration file, which defines your specific integration of Tridion with Tridion Connector for SAP Commerce.

This topic describes the configuration properties that are needed specifically for the Connector for SAP Commerce. For full details on the standard Connector configuration format, refer to the related topics.

url
The URL to the SAP Commerce instance; example: https://prod-SAPcommerce.company.com:9002
catalogs
An array that defines one or more SAP Commerce product catalogs to be exposed. Each catalog is associated with a locale and optional a set of publication IDs, which the Connector uses to map Tridion Connector for SAP Commerce locales with Tridion Blueprint publications. For each catalog, set the following properties (as they are expressed in SAP Commerce):
  • name — The name of the catalog, such as "appearal-uk"
  • versionId — The version identifier for the catalog, such as "apparelProductCatalog/Staging" and "apparelProductCatalog/Online"
  • defaultA Boolean value (true/false) that indicates whether the catalog is the default one, which is used as fallback when no matching publication ID (with locale) is found
  • locale — The locale of the catalog, such as "en_US"
  • publicationIds — A list of one or more publication identifiers that are associated with the catalog, such as ["26", "27"]
clientId
API username to be used to authenticate over OAuth.
Use the consumer secret of the Connector application you defined when setting up OAuth.
clientSecret
API password to be used to authenticate over OAuth.
Use the consumer secret of the Connector application you defined when setting up OAuth.
pageSize
Default page size when doing search and list operations.
This property is optional. When no value is specified, the default page size is 100.
requestTimeout
Maximum time allowed for each request after the connection is established.
Specify the timeout in milliseconds.

The following sample code illustrates the configuration file of a Connector for SAP Commerce:

{
  "configuration": { 
    "SAPCommerce": {
      "configuration":  {
        "pageSize": 100,
      },
      "namespaces": {
        "SAPcommerce": {
          "configuration": {
            "catalogs": [
              {
                "name": "apparel-uk",
                "versionId": "apparelProductCatalog/Online",
                "locale": "en_GB",
                "default": true,
                "publicationIds": ["23", "24"]
              },
              {
                "name": "apparel-de",
                "versionId": "apparelProductCatalog/Online",
                "locale": "de_DE",
                "default": false,
                "publicationIds": ["26", "27"]
              }
            ]
          }
        }
      }
    }
  },
  "sitesCm": { 
    "isEnabled": true,
    "SAPCommerce": {
      "displayName": "SAP Commerce",
      "stubFolders": ["tcm:2-71-2"],
      "configuration": {
         "url": "https://stage-SAPcommerce.company.com:9002",
         "clientId": "tridionapi",
         "clientSecret": "secret"
      }
    }
  },

  "staging": { 
     "isEnabled": true,
     "SAPCommerce": {
         "configuration": {
            "url": "https://stage-SAPcommerce.company.com:9002",
            "clientId": "tridionapi",
            "clientSecret": "secret"
         }
     }
  },
  "live": { 
     "isEnabled": true,
     "SAPCommerce": {
         "configuration": {
            "url": " https://prod-SAPcommerce.company.com:9002",
            "clientId": "tridionapi",
            "clientSecret": "secret"
         }
     }
  }
}