SAP Knowledge Base Article - Public

3200793 - Execution of BOTs Using APIs

Symptom

This documentation have the detailed steps about, how to trigger “Business Document Extraction from Email” bots using API call?

Environment

SAP Business Bydesign

Resolution

Reference Documentation - Help Center

Postman Collection API - iRPA API Testing.postman_collection.json

Steps to setup the Triggered Bots using API call:

  1. Create communication scenarios under work center view Application and User Management - Communication Scenarios

Service Name: iRPAServiceInboundSI

image2.png

2. Create communication arrangement under work center view Application and User Management - Communication Arrangements

image3.png

3. Now to go to WCV Application and User Management - Service Explorer, search with iRPA*, download the WSDL file and make a note of URL

image4.png

4. Register the tenant in desktop Studio

image5.png

image6.png

5. Go to the Intelligent Robotics Process Automation Factory

image7.png

6. Go to Environments tab-> Add package

image8.png

image9.png

image10.png

7. Add agents

image11.png

image12.png

8. Create API Key under environments-> Make a note of API Key as it will generate only once

image13.png

image14.png

image15.png

image16.png

Make a note of API Key as it will generate only once

image17.png

image18.png

9. Add triggered

image19.png

Select the package

image20.png

Select radio button API

image21.png

Give the name and click on create button

image22.png

Copy the payload and URL

image23.png

image24.png

10. Below is the process to run the bots using Postman-> Import below collection in your local postman

Refer to the Attachment "iRPA API Testing.postman_collection.json"

You can get the two requests; one is to get authorization token and another one is to run the bots

Below GET request URL is coming from Service explorer created from step 3

image26.png

Give the Content Type: text/xml

image27.png

Below is the XML payload from Service explorer created from step 3

image28.png

Below is the script to set authorization token at collection level

image29.png

Now in the second request, Enter the URL from step 9

image30.png

Enter the iRPA API Key from step 8, and authorization and content type as below

image31.png

Give the payload as per step 9

image32.png

Now run the collection

image33.png

image34.png

Check the status of request

image35.png

11. To check the bot’s execution, go to iRPA Monitoring->Jobs, you can find the bots is scheduled.

image36.png

Same can be verify at desktop agent as well

image37.png

Keywords

Bots; IRPA; bots using APIs, triggered , KBA , AP-ML-RPA-EXE , ByDesign - Robotics process Automation - Bots Execution , How To

Product

SAP Business ByDesign all versions

Attachments

iRPA API Testing.postman_collection.json