Once you complete the initial login to the SAP CX AI Toolkit as an admin user, it’s time to set up the integration between the SAP CX AI Toolkit tenant and SAP Commerce Cloud.
First, prepare SAP Commerce Cloud for integration by completing these three essential tasks:
- Prepare the manifest.json file.
- Validate and configure the settings of the necessary integration objects.
- Create the OAuth client for authentication with the SAP CX AI Toolkit.
Task 1: Prepare the manifest.json File
To prepare the SAP Commerce Cloud server for integration with the SAP CX AI Toolkit, include the necessary extensions in the manifest.json file.
12345678910111213
inboundservices
integrationbackoffice
integrationbackofficetest
integrationmonitoringbackoffice
integrationservices
odata2services
odata2webservices
outboundservices
outboundsync
outboundsyncbackoffice
webhookbackoffice
webhookservicesAdditionally, ensure the odata2webservices service is configured in one of the nodes in the manifest.json file, as shown in the following example:
12345678910111213"aspects": [
{
"name": "backoffice",
"properties": [ ... ],
"webapps": [
...,
{
"name": "odata2webservices"
},
…],
…
}
]The odata2webservices component facilitates communication between SAP Commerce Cloud and the SAP CX AI Toolkit. Determine which server node will host the odata2webservices service. In this example, the backoffice node will host it for demonstration purposes, but the API node is typically more suitable.
Finally, trigger a build based on the prepared manifest.json file and deploy the successful build to the designated SAP Commerce Cloud environment.
Task 2: Validate and Configure the Settings of the Necessary Integration Objects
In the successfully deployed SAP Commerce Cloud environment, ensure that the following predefined integration objects are correctly configured:
- IntegrationService
- ScriptService
- OutboundChannelConfig
Specifically, we need to:
- Ensure all listed integration objects are OAuth-enabled.
- Validate that the exposed attributes of the integration objects align with the required attributes for future communication with the SAP CX AI toolkit.
- Ensure the OAuthUrl attribute is exposed as part of the ConsumedDestination attribute in the OutboundChannelConfig object.
Watch the following video for a step-by-step guide on how to perform these tasks:
For the final step demonstrated in the video, use the following ImpEx script as a reference:
123
INSERT_UPDATE IntegrationObjectItemAttribute;integrationObjectItem(integrationObject(code), code)[unique = true];attributeName[unique = true];attributeDescriptor(enclosingType(code),qualifier)
;OutboundChannelConfig:ConsumedOAuthCredential;oAuthUrl;ConsumedOAuthCredential:oAuthUrl;Task 3: Create OAuth Client for Authentication with SAP CX AI Toolkit
To enable the CX AI Toolkit to obtain authentication and authorization keys for data communication with SAP Commerce Cloud, create an OAuth Client. Watch the following demo to learn how to create one.
With these tasks completed, the SAP Commerce Cloud server is now ready for integration.