Robotic Process Automation Jobs

The following topics describe job types for robotic process automation (RPA) platforms and services:

Job:Automation Anywhere

Automation Anywhere is a robotic process automation (RPA) software, which enables you to create bots that observe human actions in the digital workplace, identify repetitive rules-based tasks, and automate these tasks.

To deploy and run an Automation Anywhere job, ensure that you have installed the Automation Anywhere plug-in with the provision image command or the provision agent::update command.

The following example shows how to define an Automation Anywhere job:

Copy 
"Automation Anywhere_Job_2": 
{
   "Type": "Job:Automation Anywhere",
   "ConnectionProfile": "AACONN",
   "Automation Type": "Bot",
   "Bot to run": "bot123",
   "Bot Input Parameters": "
   {
      "Param1":
      {
         "type": "STRING",
         "string": "Hello, World!"
      },
      "NumParam":
      {
         "type": "NUMBER",
         "integer": 11
      }
   },
   "Connection timeout": 10,
   "Status Polling Frequency": 5
}

The following table describes the Automation Anywhere job parameters.

Parameter

Description

ConnectionProfile

Defines the ConnectionProfile:Automation Anywhere name that connects Control-M to Automation Anywhere.

Automation Type

Determines the type of automation to execute, either a Bot or a Process.

Bot to run

(Bot Automation) Defines the bot name.

Process to run

(Process Automation) Defines the process name.

Process URI Path

(Process Automation) Defines the URI path of the folder that contains the process to execute.

Use / as the separator in this path—not \.

Bots/TEST/Folder1

Connection timeout

Defines the maximum number of seconds to wait for REST API requests to respond, before disconnecting.

Default: 10

Status Polling Frequency

(Optional) Defines the number of seconds to wait before checking the status of the job.

Default: 5

Bot Input Parameters

(Optional, Bot Automation) Defines optional input parameters, in JSON format, to use during bot execution.

You can define the following parameter types:

  • STRING

  • NUMBER

  • BOOLEAN

  • LIST

  • DICTIONARY

  • DATETIME

For more information about the syntax of the JSON-format input parameters, see the description of the botInput element in a Bot Deploy request in the Automation Anywhere API documentation.

For no parameters, specify {}.

Job:UI Path

UiPath is a robotic process automation (RPA) software, which enables you to create bots that observe human actions in the digital workplace, identify repetitive rules-based tasks, and automate these tasks.

To deploy and run a UiPath job, ensure that you have installed the UiPath plug-in with the provision image command or the provision agent::update command.

The following example shows how to define a UiPath job:

Copy 
"UI Path_Job":    
{
   "Type": "Job:UI Path",
   "ConnectionProfile": "UIPATH_Connect",
   "Folder Name": "Default",
   "Folder Id": "374999",
   "Process Name": "control-m-process",
   "packagekey": "209c467e-1704-4b6y-b613-6c5a2c9acbea",
   "Robot Name": "abc-ctm-bot",
   "Robot Id": "153999",
   "Optional Input Parameters":    
   {
      "parm1": "Value1",
      "parm2": "Value2",
      "parm3": "Value3"
   },
   "Status Polling Frequency": "30",
   "Host": "host1"
}

The following table describes the UiPath job parameters.

Parameter

Description

ConnectionProfile

Defines the ConnectionProfile:UI Path name that connects Control-M to UiPath.

Folder Name

Defines the name of the UiPath folder where UiPath projects are stored.

Folder Id

Defines the identification number for the UiPath folder.

Process Name

Defines the name of a UiPath process associated with the UiPath folder.

packagekey

Defines the UiPath package that is published from the UiPath Studio to the UiPath Orchestrator.

Robot Name

Defines the UiPath robot name.

Robot Id

Defines the identification number for the UiPath robot.

Optional Input Parameters

(Optional) Defines the input parameters, in the following format, that are passed to the job at execution.

Copy 
{"parm1": "val1", "parm2": "val2", "parm3": "val3"}

Status Polling Frequency

(Optional) Determines the number of seconds to wait before checking the status of the job.

Default: 15

Host

Defines the name of the host machine where the job runs. A Control-M/Agent must be installed on this host. Optionally, you can define a host group instead of a host machine.