Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Managing Jobs

Starting a Job


This procedure starts from the presumption that you previously created a process.

  1. Navigate to Automations > Jobs in the folder the process resides in.
  2. Click Start. The Start Job window is displayed.
  3. From the Process Name drop-down, select a process that has been previously deployed to the current folder.
  4. From the Jobs Priority drop-down, select the priority of the job to be executed if you want it different from the priority set at the process level. This field is automatically populated with the priority inherited from the package.
  5. From the Runtime license drop-down, select the runtime type under which the job is to be executed. The number of available and connected runtimes is displayed below the drop-down. You cannot start a job unless you have runtimes of that type associated with the machine object used for execution. Assign runtimes on the Machines page (tenant context). See Managing Machines for details.

📘

Note

You cannot start a job in unattended/nonproduction/testing/development mode unless you have runtimes of that type associated with the machine object used for execution. Assign runtimes to your machine objects on the Machines page (tenant context). See Managing Machines for details.

  • _ Available - The number of available runtimes, calculated as the total number of runtimes minus the number of running jobs.
  • _ Connected - The total number of runtimes, calculated as the sum of runtimes on all machines connected to Orchestrator that is associated with the active folder.

Runtime license

Description

Unattended

The job is executed in unattended mode consuming an Unattended runtime.

NonProduction

The job is executed in unattended mode consuming a NonProduction runtime.

Testing

The job is executed in unattended mode consuming a Testing runtime.

Development

The job is executed in unattended mode using a Development runtime. This allows developers to run jobs from Orchestrator in their personal workspace, for testing and debugging purposes, without consuming an Unattended, NonProduction or Testing license. See details about debugging using personal workspaces.

Example: Say you have 2 nonproduction runtimes and 1 Unattended runtime on machine template A, and 3 NonProduction runtimes, and 2 Unattended runtimes on machine template B. Both are associated with one folder. On each template, you connect one host machine. The resulting runtime state is the following:

  • Unattended: 3 Available, 3 Connected
  • NonProduction: 5 Available, 5 Connected

A running job occupying a runtime subtracts 1 from the number of available runtimes for that type.

  1. In the Execution Target tab select the execution strategy:

Description

1. Allocate Dynamically

Dynamic allocation with no explicit account and machine selection allows you to execute a foreground process multiple times under the account and machine that become available first. Background processes get executed on any account, regardless if it's busy or not, as long as you have sufficient runtimes.

Using this option you can execute a process up to 10000 times in one job.

2. Account

Specifying an account means the process is executed under that specific user or robot account.
Specifying both the account and the machine means the job launches on that very account-machine pair. Only valid account-machine pairs are available for selection.
Specifying no account results in Orchestrator allocating the account dynamically.

3. Machine

Specifying a machine object means the process is executed on one of the host machines attached to the selected machine template. Select a specific host machine from the pool of connected host machines on the Connected Machines field.
Specifying both the account and the machine means the job launches on that very account-machine pair. Only valid account-machine pairs are available for selection.
Specifying no machine results in Orchestrator allocating the host machine dynamically.

Make sure that runtimes matching the job type are allocated to the associated machine template. Only connected host machines associated with the active folder are displayed.

4. Keep Account/Machine allocation on job resumption

This field allows you to configure whether the different fragments of a long-running job are executed on the same account-machine pair.
By default, a suspended job is resumed by any available Robot on any available machine.
Based on your license or resource requirements, you have the option to resume a job on the same machine and in the same account context that started the job.

Say you need an SAP license to execute a job. Instead of installing an SAP license on every available machine (increased costs), you can install it on a single machine and use that machine to start and resume the job. The same strategy may apply to user licenses. You can allocate only one user license and use it to execute the job.

Orchestrator prevents starting jobs on invalid configurations. Trying to start a job in an invalid setup results in a descriptive error message providing you with details about how to fix your configuration.

Starting a job using dynamic allocation, i.e. no machine or account specified, with an incompatible folder setup results in an error. Make sure to correct the setup, otherwise, jobs stay pending indefinitely. For example, trying to run a .NET Framework 4.6.1 background job when there are only cross-platform templates in the folder does not work, as jobs stay pending until the configuration is fixed.

  1. In the Arguments tab, provide input arguments for the selected process. This tab is automatically populated with all the input arguments accepted by the selected process, and the corresponding values inherited from the package.
  2. Click Start. The Start Job window closes and, if there are available runtimes on the currently active folder, the job starts on a Robot according to the settings you made. The State of the job is displayed in real-time on the Jobs page.

Stopping a Job


Click the corresponding More Actions button, and then Stop. The automation project is executed until it finds a Should Stop activity. During this time, the job is in the Stopping state. If the activity is encountered, the execution is stopped, and the job's final status is Successful. If a Should Stop activity is not found, the job execution does not stop until it reaches the end of the project. The final status, in this case, is Successful as well.

📘

Note

A job started from Orchestrator can be stopped only from Orchestrator.
A job started from the Assistant can be stopped both in Orchestrator, from the Jobs page, and using the UiPath Assistant.

Resuming a Job


Click the corresponding More Actions button, and then Resume.

Killing a Job


Click the corresponding More Actions button, and then Kill. The automation project is forcefully stopped, the job is marked as Stopped, and "Job canceled" is displayed in the Job Details window.

📘

Note

A job started from Orchestrator can be killed both in Orchestrator, from the Jobs page, and using the UiPath Assistant.
A job started from the Assistant can be killed both in Orchestrator, from the Jobs page, and using the UiPath Assistant.

Restarting a Job


This feature enables you to quickly run a job from the jobs list, without going through the configuring job flow. You can restart any job with a final state – Stopped, Faulted or Successful.

📘

Note

You can’t restart jobs triggered by agents such as the Assistant or through Studio remote debugging sessions.

This procedure starts from the presumption that you previously started a job that already reached a final status.

  1. Click the corresponding More Actions button, and then Restart. The Start Job window is displayed, with the job's initial settings.
  2. Make the desired changes.
  3. Click Start. The Start Jobs window closes and the execution starts. The status of each job is displayed, in real-time, on the Jobs page.

Viewing Job Logs


To view the logs for a specific job, click the corresponding More Actions button, and then View Logs. The Logs page is displayed and contains data regarding the indicated job.

📘

Note

Logs generated for jobs started through remote debugging sessions are not available.

Viewing Job Details


Click the corresponding View Details button. The Job Details window is displayed. Here you can find information such as the name of the process, the environment where the job had been executed, the Robot which executed it, start and end times of the job, and input and output values if defined.

Downloading Execution Media


To download the recording for a faulted job, click More Options > Download Recording. Execution media is downloaded according to your settings.

Updated about a month ago


Managing Jobs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.