Creating a Web Service Type Robot
Prerequisites for Creating a Web Service Type Robot
List of requisites for creating a Web Service Type Robot.
- Technical user group, authorized to manage and administrate Robots.
Administration – New Robot
To begin connecting a Robot, click on the New Robot button on the Bot Console page.
The screen to configure it, which has different tabs, is shown below.
1. Robot Data
In this tab, you will configure the Web Service robot data.
| Field | Description |
|---|---|
| SELECT NEW ROBOT | Possible options: Web Service, Blue Prism, Power Automation, Automation Anywhere, SQLServer Stored Procedure, UiPath, WWW Alive, Zafiro. |
| ROBOT NAME | Enter the name with which the Robot will be recognized. |
| GROUP | Select from a drop-down list the Group to which the Robot will belong. |
| ROBOT DESCRIPTION | Enter a short description of the Robot being connected. For example: Purchase Order Invoice Generator. |
| OPERATION TIME IN MINUTES | Enter how long (in minutes) it takes a person to execute a transaction of the operation the Robot is automating. |
| OPERATION NAME | Enter a description of the operation the Robot is executing. For example: Generation of an invoice/Verification/Transaction. |
| OPERATION NAME (PLURAL) | Enter a plural description of the operation the Robot is executing. For example: Generation of invoices/Verifications/Transactions. |
2. Configuration
In this tab, you will see the execution data of the web service to be configured.
Connection Data
| Field | Description |
|---|---|
| URL | Enter the address wherein the web service is located. |
| WEB SERVICE TYPE | Determine the type of Web Service: Traditional: SOAP. /WCF. /WEBAPI. (See subsection Configuring the Type of Web Service) |
| DESCRIPTION | Enter as many details as necessary to clarify the configuration. |
Configuring the Type of Web Service
The types of web service to be configured are:
- Traditional: SOAP. See subsection Traditional: SOAP
- WCF. See subsection WCF
- WEBAPI. See subsection WEBAPI They are described below:
Traditional: SOAP
In case you select a TRADITIONAL type Web Service.
| Field | Description |
|---|---|
| METHOD | Enter the name of the method from the list of operations available from the WSDL. |
| RESULT TYPE | Enter the name of the XML response tag containing the information about the transaction to be registered. |
| BODY TEMPLATE | Enter the XML containing the body of the message to be sent to the web service. (See subsection Body Template) |
WCF
In case you select a WCF type Web Service.
| Field | Description |
|---|---|
| METHOD | Enter the name of the method from the list of operations available from the WSDL. |
| RESULT TYPE | Enter the name of the XML response tag containing the information about the transaction to be registered. |
| WCF CONTRACT NAME | Enter the name of the WFC interface implementing the web service. |
| BODY TEMPLATE | Enter the XML containing the body of the message to be sent to the web service. (See subsection Body Template) |
WEB API
In case you select a WEB API type Web Service.
| Field | Description |
|---|---|
| HTTP METHOD | Enter the type of http method to be consumed. GET, POST, PUT, DELETE or PATCH |
| BODY TEMPLATE | Enter the JSON content including the body of the message to be sent to the API. (See subsection Body Template). For DELETE AND GET HTTP, this datum is not required. |
Body Template
The Body Template field allows using replacement variables. The texts between curly brackets {} will be modified before executing the web service based on the parameters defined in the lower section of the screen.
BODY TEMPLATE
The body of the service is taken as an example: http://wsf.cdyne.com/WeatherWS/Weather.asmx
PARAMETERS
The ZipCode parameter is defined.
Execution Parameters
| Field | Description |
|---|---|
| NAME | Editable field entered in “New Column”. |
| DESCRIPTION | Field detail. Optional. |
| DATA TYPE | Editable field entered in “Data Type”. |
| PRECISION | Enter the field length for chains of characters or the decimal precision for numbers. |
| LOGICAL NAME | Modify it if a non-technical name is preferred. |
| VALUE | Enter the value to be assigned to the parameter during the execution of the web service. |
Available Actions
- Add Button: It adds a new execution parameter.
- Delete Button
: It deletes parameters registered for executing the Service.
3. Work Schedules
In this tab, you must configure the Robot's execution schedules and behavior.
| Field | Description | Possible Options |
|---|---|---|
| SCHEDULED BY BOTREADY? | It allows you to configure if BotReady is in charge of the execution. | YES/NO |
| WORKING? | It allows you to select whether or not the Robot will be active and working. | YES/NO |
| TIMING | It allows you to select the type of work schedule for the Robot. (See Note) | Every X Minutes/Customized/All the Time |
| RETRIES WHEN ERROR | It allows you to enter the number of times the Robot will re-attempt to process the operation when it finds an error. | Free value |
| IF THE EXECUTION ERROR PERSISTS | It allows you to select the action to be taken if the error persists after exceeding the established number of attempts. | Stop/Continue working |
Note: You can find more information on how to configure the Robot's Work Schedules in Section: Administrator Guide - Robot Execution Schedule
4. Notifications
In this tab, you can configure the notifications the Robot will send in each event and how it will perform the notification (through a contact channel).
| Field | Description |
|---|---|
| EVENT TO NOTIFY | Select which event will be notified by the Robot. Possible options: When executing an error transaction, When executing a successful transaction, At the end, At the beginning, When an unexpected error occurs, When a robot does not finish the transaction after more than X minutes have passed, When a robot does not finish/is not executing the transaction after more than X minutes have passed. |
| COMMUNICATION CHANNEL | Select the channel to be used to send the notification to the user. Available options: Dashboard/Email/Mobile App. (See subsection Communication Channel) |
| NOTIFY TO | Select which user the Robot will notify. Available options: Mail/User, Robot Owner User, Robot Executor User. (See subsection Communication Channel) |
4.1 Communication Channel
This feature allows you to configure how the Robot's notifications will be sent. The possible options are detailed below:
4.1.1 Dashboard
When you choose this option, the event notification will be shown on the “Notifications Panel”.
When “Dashboard” notifications are configured, they may have 3 criticality levels (Low, Medium, High).
When a notification of that criticality is generated, it will be grouped under the corresponding level in the Notifications Panel.
Type of Criticality
Select the Criticality Level of the notification. Available options:
Low: the notification will be displayed under the KPI in Yellow on the Panel.
Medium: the notification will be displayed under the KPI in Orange on the Panel.
High: the notification will be displayed under the KPI in Red on the Panel.
Note: You can find more information about the Notifications Panel in Section: User Guide - Notifications Panel
4.1.2 Email
The notification of the event will be sent by email to the configured accounts.
Upon choosing this option, the Notify To field is enabled, with the following available options to choose from:
- Mail: in the field located to the right of “Notify To”, you may write the email address of only one recipient, or the email addresses of several recipients, using “;” as an address separator.
- Robot Owner User.
- Robot Executor User.
4.1.3 Mobile APP
The notification of the event will be a PUSH type notification in the Mobile App.
- Upon choosing this option, the Notify To field is enabled, with the following available options to choose from:
- User: in the field located to the right of “Notify To”, you must write the User Name (System or Domain user) that will receive them.
- Robot Owner User.
- Robot Executor User.
Available Actions
Add Notification
For every new event to be notified (with its corresponding communication channel), you must click on the Add button.
Delete Notification
You may delete all the notifications by clicking on the button.
Finish Connection
The last step to successfully finish the creation and configuration of the Robot is to click on the Finish button on Tab 4: Notifications.
On the Robot Administration page, the new Robot will appear as follows:
