Integrate Chatbot with SAP Build Process Automation

1. Open the project you created in SAP Build Process Automation Application Capture.

2. Add Agent Attribute.

   

3. Release the project.

   

4. Deploy the project. Click Deploy.

   

5. Select Create a Trigger and click Next.

   

6. Select API and click Next.

   

7. Select Get Order Details From Application automation and click Next.

   

8. Set Name to Get Order Trigger and click Next.

   

9. Click Confirm then hit Deploy.

   

   The project is now deployed.

1. Go to lobby landing page of SAP Build.

   

2. Go to Settings > API Keys.

   

3. To create your API Key. Click Add API Key.

   

4. Set Name to myAPIKey and click Next.

   • Select both options trigger_read and trigger_execute and click Next.
   

5. Click Add.

   

6. Click Copy and note down what was just copied to your clipboard.

   

   It’s important to save your API Key, since it can only be read once from the Setting.

   Your API Key is now created and ready to be used.

1. Navigate to SAP BTP Cockpit subaccount > Services > Instances and subscriptions.

2. Choose Create.

   

3. For the new instance:

   • Select SAP Build Process Automation as Service.
   • Select Standard Instance plan from the Plan list.
   • Select Other as Runtime Environment.
   • Set Instance Name as SPA-instance.
   • Choose Create.
   
   The instance is now added.

4. Create a new Service Binding by selecting your SPA-instance instance > Select … to expand > Create Service Binding.

   

5. Put the name as myServiceBinding and click Create.

   

6. Click … and then click View to view the Service Binding created.

   

7. Click Form and copy the clientid, clientsecret and URL under the uaa section. You will need it in the next steps.

   

1. Navigate to Home > Monitor > Manage > Automations.
2. From the shown triggers:
   • Find your trigger (Created in Step 1.4 during deployment).
   • Click on Actions and select Edit.
   

3. Copy URL and Payload.

   

   You can notice that the inputs of the automation are specified in the request body also called as the Payload.

A ready CAI bot is used here.
This bot has a goal of emitting an API Call to SAP Build Process Automation using API Trigger, API Key and Service Binding we created previously.

Using CONSUME API SERVICE feature in Conversational AI bot we can make API Calls.

1. Set URL to the one saved in step 4.

   

2. For Authentication tab:

• Set Authentication type to OAuth2 Authentication.
• Set Client ID, Client Secret and Authorization URL to those saved in step 3.

  For Authorization URL add /oauth/token at the end of the URL.

  

1. For Headers tab:

   • Click + New Fields to create a new field.
   • Set Key to irpa-api-key and Value to the one saved in step 2.
   

2. For Body tab:

   • Select Create a custom body.
   • Paste the following:
   JSON

   Copy

   {
       "invocationContext": {
       "conversationId": "{{conversation_id}}"
       },  
       "input": {
           "orderNumber": "Order {{memory.orderNumber.raw}}"
       }
   }
   

   

   memory.orderNumber.raw is just a variable where an order number given by a user is stored.

3. Click Save to save your changes.

1. To get Bot Developer Token:

   • Go to Settings > Tokens.
   • Note Developer Token somewhere and save it.
   

2. To get Designtime API Token:

   • Click Generate besides Designtime APIs.
   • Select Client Credentials and click Next.

   • Note Auth URL, Client ID and Client Secret somewhere and save it.

     Don’t confuse these 3 information with those of the service binding’s.

   
   We now have the proper tokens to create Notifiers.

1. Navigate to Home > Monitor > Manage > Automations.

   

2. Start Notifier:

   • Click three dots under Actions in the same row as your Trigger.
   
   • Select Add Notifier.
   • Select CAI and click Next.
   • Create the notifier as such:

   Field Name	Value
   Notify on	Start
   Name	Starting notifier
   Description	Indicates that the automation has started
   Conversation ID	${invocation_context.conversationId}
   Token	Developer token from step 6.1
   Auth URL	Designtime APIs token Auth URL from step 6.2
   Client ID	Designtime APIs token Client ID from step 6.2
   Client Secret	Designtime APIs token Client Secret from step 6.2
   What do you want to do?	Send a message
   Delay in second	0
   Message content	IRPA: Bot Started.

   • Click Create.

3. Success Notifier:

   • Click
     
     under Actions in the same row as your Trigger.
   • Select Add Notifier.
   • Select CAI and click Next.
   • Create the notifier as such:

   Field Name	Value
   Notify on	Success
   Name	Success notifier
   Description	Indicates that the automation has finished successfully
   Conversation ID	${invocation_context.conversationId}
   Token	Developer token from step 6.1
   Auth URL	Designtime APIs token Auth URL from step 6.2
   Client ID	Designtime APIs token Client ID from step 6.2
   Client Secret	Designtime APIs token Client Secret from step 6.2
   What do you want to do?	Send a message
   Delay in second	0

   • Set Message content:

     ${output.order.orderNumber}:
     Price: ${output.order.orderAmount}€.
     Status: ${output.order.orderStatus}.
     Order Date: ${output.order.orderDate}.
     Country: ${output.order.shippingCountry}.
   

   • Click Create.
   

4. Error Notifier:

   • Click
     
     under Actions in the same row as your Trigger.
   • Select Add Notifier.
   • Select CAI and click Next.
   • Create the notifier as such:

   Field Name	Value
   Notify on	Failure
   Name	Failure notifier
   Description	Indicates that the automation has failed
   Conversation ID	${invocation_context.conversationId}
   Token	Developer token
   Auth URL	Designtime APIs token Auth URL
   Client ID	Designtime APIs token Client ID
   Client Secret	Designtime APIs token Client Secret
   What do you want to do?	Send a message
   Delay in second	0
   Message content	Automation failed with error: ${error.details}

   • Click Create.
   
   The three notifiers are now created.

1. Open your SAP Conversational AI chatbot.

2. Click Connect tab.

3. Click on SAP Conversational AI Web Client.

   

4. Put CAI with IRPA in Channel Name and click Create.

   

5. Click on the Web Client standalone link to open the chatbot in browser.

6. The chatbot opens in a new window.

   

   Make sure your Desktop Agent is in Background (Unattended) mode.

7. To start my bot I type Start my automation according to what I set it up to respond to (Execute the API call) after asking for an order number.

8. The workflow of the execution:

   • The process starts with the user triggering it in the chatbot (sending Start my automation).
   • The chatbot asks for an Sales Order Number which will be used as an input for our automation.
   • Once the Order Number is submitted by the user, the bot sends the API Request to SAP Build Process Automation according to what we configured it, and displays CAI Bot: Emitting the API Call.
   • Once the API Request is reached, the SAP Build Process Automation Start notifier sends back a message declaring its start: IRPA: Bot Started.
   • Upon a successful execution of the automation, the Success notifier is triggered and the Sales Order’s details are returned to the bot that displays them.