Start Job activity

An activity that starts a job in UiPath on a specified number of robots.


Start Job activity

Configure the Start Job activity

To configure the Start Job activity, do the procedure in this topic.

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the UiPath RPA tab.

    Open UiPath
  3. On the UiPath RPA tab, drag the Start Job activity onto your process.

    Drag Start Job

General Configuration

Specifies the basic settings for the Start Job activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field NameDefinition

Display Name
Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description
Description:
Specifies an optional text description for your activity.
Allowed Values:
More than one line of text.
Default Value:
None
Accepts Variables:
No

Start Job Configuration > Execution Target tab

Specifies whether to create a new job and associate it with specific robots or assign the job to the robots that are available.

Figure: Start Job Configuration > Execution Target tab

Start Job Configuration Execution Target tab

Fields

Field NameDefinition

UiPath
Description:
Specifies the access token that connects to your UiPath service.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon
Opens this Screen:
Access Token for UiPath
Function of this Screen:
Configure an access token to connect to UiPath.

Folder
Description:
Specifies the name of the folder from which to start the job.

When you select the access token from the UiPath field, this field shows the folders associated with the access token from UiPath.

Allowed Values:
A UiPath folder name from the list.
Default Value:
None
Limitations:

This field is available in these releases:

Environment
Description:
Specifies the name of the environment to use.

When you select the folder in the Folder field, this field shows the environments associated with the specified folder.

Allowed Values:
A UiPath environment from the list.
Default Value:
None
Accepts Variables:
No

Process
Description:
Specifies the name of the process to execute.

When you select the environment from the Environment field, this field shows processes associated with the environment from UiPath.

Allowed Values:
A UiPath process from the list.
Default Value:
None
Accepts Variables:
No

Robot
Description:
Specifies the name of the robot that executes the process you select in the Process field.

When you select the access token from the UiPath field, this field shows all the robots in UiPath.

To Open this Field:
  1. On the Start Job Configuration screen, in the Execution Target tab, select Specific robots.
Allowed Values:
A UiPath robot from the list.
Default Value:
None
Accepts Variables:
Yes

Machine
Description:
Shows the name of the machine where each robot is hosted.

When you select the robot in Robot field, this field shows the machine name.

To Open this Field:
  1. On the Start Job Configuration screen, in the Execution Target tab, select Specific robots.
Allowed Values:
Read only.

Status
Description:
Shows the status of each robot assigned to the selected process in the Process field.

When you select the robot in Robot field, this field shows the status of robot.

To Open this Field:
  1. On the Start Job Configuration screen, in the Execution Target tab, select Specific robots.
Allowed Values:
Read only.
The status can be one of these:
  • Available - The robot is not running a process and is free to use.
  • Busy - The robot is running a process.
  • Disconnected - The UiPath robot service is not running.
  • Unresponsive - The robot and Orchestrator have not communicated in the last two minutes.

Create Create icon
Function:
Adds a row for a robot to assign more than one robot to a process.
To Open this Field:
  1. On the Start Job Configuration screen, in the Execution Target tab, select Specific robots.

Delete Delete icon
Function:
Deletes the row.
To Open this Field:
  1. On the Start Job Configuration screen, in the Execution Target tab, select Specific robots.

No. of times to Execute the Process

Description:
Specifies how many times the selected process in the Process field to execute.

You can execute a process up to 10000 times in one job.

To Open this Field:
On the Start Job Configuration screen, in the Execution Target tab, select Allocate dynamically.
Allowed Values:
An integer.

Range:

  • 1-10000
Default Value:
None
Accepts Variables:
Yes

Start Job Configuration > Parameters tab

Specifies the name and type of an argument.

Figure: Start Job Configuration > Parameters tab

Start Job Configuration Parameters tab

Fields

Field NameDefinition

UiPath
Description:
Specifies the access token that connects to your UiPath service.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon
Opens this Screen:
Access Token for UiPath
Function of this Screen:
Configure an access token to connect to UiPath.

Folder
Description:
Specifies the name of the folder from which to start the job.

When you select the access token from the UiPath field, this field shows the folders associated with the access token from UiPath.

Allowed Values:
A UiPath folder name from the list.
Default Value:
None
Limitations:

This field is available in these releases:

Environment
Description:
Specifies the name of the environment to use.

When you select the folder in the Folder field, this field shows the environments associated with the specified folder.

Allowed Values:
A UiPath environment from the list.
Default Value:
None
Accepts Variables:
No

Process
Description:
Specifies the name of the process to execute.

When you select the environment from the Environment field, this field shows processes associated with the environment from UiPath.

Allowed Values:
A UiPath process from the list.
Default Value:
None
Accepts Variables:
No

Parameters
Description:
Specifies the parameters for the process.

When you select the process in the Process field, this field shows all available parameters that you created for the selected process in UiPath.

Allowed Values:
The parameters from the list.
Default Value:
None
Accepts Variables:
Yes

Value
Description:
Specifies the value for parameters.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
Yes

Create Create icon
Function:
Adds a row for a parameter and value.

Delete Delete icon

Function:
Deletes the row.

Start Job Configuration > Response tab

Specifies how to store the information about the start job in your schemas.

Figure: Start Job Configuration > Response tab

Start Job Configuration Response tab

Fields

Field NameDefinition

UiPath
Description:
Specifies the access token that connects to your UiPath service.
Allowed Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon
Opens this Screen:
Access Token for UiPath
Function of this Screen:
Configure an access token to connect to UiPath.

Folder
Description:
Specifies the name of the folder from which to start the job.

When you select the access token from the UiPath field, this field shows the folders associated with the access token from UiPath.

Allowed Values:
A UiPath folder name from the list.
Default Value:
None
Limitations:

This field is available in these releases:

Environment
Description:
Specifies the name of the environment to use.

When you select the folder in the Folder field, this field shows the environments associated with the specified folder.

Allowed Values:
A UiPath environment from the list.
Default Value:
None
Accepts Variables:
No

Process
Description:
Specifies the name of the process to execute.

When you select the environment from the Environment field, this field shows processes associated with the environment from UiPath.

Allowed Values:
A UiPath process from the list.
Default Value:
None
Accepts Variables:
No

Save Response to this Variable / Map Response to AgilePoint Schema
Description:
Specifies where to store the response from UiPath.
Allowed Values:
  • Save Response to this Variable – Select this option if you expect UiPath to return only one data item.

    In the text field, specify a variable to store the data UiPath returns.

  • Map Response to AgilePoint Schema – Select this option if you expect UiPath to return more than one data item.

    Click the Schema Mapping Schema Mapping icon button to open the Schema Mapper.

    Use this screen to connect the response to the data model for your process.

Default Value:
Map Response to AgilePoint Schema
Accepts Variables:
  • If you select Save Response to this Variable, you must enter a variable.
  • If you select Map Response to AgilePoint Schema, this does not apply.
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?