add-ins
latest
false
UiPath logo, featuring letters U and I in white

Add-ins User Guide

Last updated Jul 17, 2024

Start Job(s)

The Start Job(s) action starts a specific job or jobs for a specific process in your UiPath Orchestrator tenant.

How It Works

The following steps are an example of how to configure the action and describes the input and output properties.

  1. Complete the Setup steps.
  2. On your recipe, place the Start Job(s) action.
  3. Enter values for the input properties.

Properties

The values for the following properties are specified below.

Note: The properties that appear on the Start Jobs action are dependent on the type of folder you selected in the Connection step.
If you choose a Modern folder, the following properties are available:
PropertyDescription
ProcessSelect the name of your process from dropdown list.
Job CountHow many times the process will be executed.
Job TypeChoose the type of job, the license type will be used accordingly.
Job ParametersIf your process has input arguments they will be listed here.
User/Robot (Optional) Select a specific User/Robot. If not selected the Orchestrator will choose one.
Machine (Optional) Select a pre-configured machine listed in your Orchestrator. If not selected the Orchestrator will choose one.
If you choose a Classic folder, the following properties are available:
PropertyDescription
Environment - Select the Environment.
ProcessSelect the name of your process from dropdown list.
StrategyIf the Strategy you choose is Specific, then you will also see Robots. If the Strategy you choose is JobsCount, then you will also see JobsCount.
Job ParametersIf your process has input arguments they will be listed here.

Input

Environment

Select the environment to use

Attributes

Details

Type

String

Required

Yes, if the connection is to a classic folder.

Default value

Empty

Allowed values

Select from a list or enter a String value.

Notes

Only available when the connection is to a classic folder

Jobs Count

Enter the number of jobs to start.

Attributes

Details

Type

String

Required

Yes, when folder is modern folder or Strategy is JobsCount for classic folder.

Default value

Normal

Allowed values

Enter a String

Notes

Only available when folder is modern folder or Strategy is JobsCount for classic folder.

Job Parameters

Set the values for the job parameters for the job(s).

Attributes

Details

Type

Dictionary<string,object>

Required

No

Default value

Empty

Allowed values

Enter a Dictionary<string,string> of values

Notes

N/A

Job Type

Select the runtime type of the machine session to consume for the job(s).

Attributes

Details

Type

String

Required

No

Default value

Empty

Allowed values

Select from a list or enter a String value.

Notes

If you select a value from the list, that value is fixed every time the recipe is executed. If you enter a value, it can be a data pill that can be used to set the value during recipe execution.

Machine

Select the machine on which to execute the process.

Attributes

Details

Type

String

Required

No

Default value

Empty

Allowed values

Select from a list or enter a String value.

Notes

If you select a value from the list, that value is fixed every time the recipe is executed. If you enter a value, it can be a data pill that can be used to set the value during recipe execution.

This is only available when the folder is a modern folder.

Process

Select the process to execute.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Select from a list or enter a String value.

Notes

If you select a value from the list, that value is fixed every time the recipe is executed. If you enter a value, it can be a data pill that can be used to set the value during recipe execution.

Robots

Select the robots on which to execute the process.

Attributes

Details

Type

String

Required

No

Default value

Empty

Allowed values

Select from a list or enter a String value.

Notes

If you select a value from the list, that value is fixed every time the recipe is executed. If you enter a value, it can be a data pill that can be used to set the value during recipe execution.

Only available when folder is classic folder. You can select more than one robot.

Strategy

Select the strategy to use

Attributes

Details

Type

enum

Required

Yes, if the connection is to a classic folder.

Default value

All

Allowed values

{ All, Specific, JobsCount

Notes

Only available when the connection is to a classic folder

User/Robot

Select the user/robot on which to execute the process.

Attributes

Details

Type

String

Required

Yes, when the folder is modern folder.

Default value

Empty

Allowed values

Select from a list or enter a String value.

Notes

If you select a value from the list, that value is fixed every time the recipe is executed. If you enter a value, it can be a data pill that can be used to set the value during recipe execution.

You can only select one robot.

Output

Job Id(s)

The IDs of the newly created job(s)

Attributes

Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String variable

Notes

N/A

  • How It Works
  • Properties
  • Input
  • Output

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.