UiPath Orchestrator

The UiPath Orchestrator Guide

Managing Jobs

Starting a Job

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

Note:

Unattended robots can execute processes only if the Windows credentials (username and password) are provided when registering UiPath robot in Orchestrator.

modern

  1. In the Jobs page, click the Start Job button. The Start Job window is displayed.
  2. From the Process drop-down, select a process that has been previously deployed to the current folder.
    • The Parameters tab is automatically populated with all the input parameters accepted by the selected process, the values inherited from the package as well.
    • The Job Priority field is automatically populated with the priority inherited from the package.
  3. 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 process level.
  4. From the Job Type drop-down, select the license mode in which the job is to be executed. Below the drop-down two numbers are displayed:
    • The number of available runtimes, calculated as the total number of runtimes minus the number of running jobs.
    • The total number of runtimes, calculated as the sum of runtimes on all machines associated to that folder, which are connected to Orchestrator.
    • Say you have 2 nonproduction runtimes and 1 unattended runtime on one machine template, 3 nonproduction runtimes and 2 unattended runtimes on another machine template. Both are associated to one folder. You have connected 2 Robot machines to Orchestrator, each using a key generated by one template. For unattended 3 Available, 3 Connected is displayed. For nonproduction 5 Available, 5 Connected is displayed. A running job of either type subtracts 1 from the number of available runtimes for that type.
  5. In the Execution Target tab select either of the two execution strategies:
    • Dynamic Allocation - the job is executed for the specified number of times on whatever Robot is available.
    • Specific User - the job is executed by the Robot associated with the selected user.
  6. In the Parameters tab, provide input parameters for the selected process, if desired.
  7. 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 status of the job is displayed in real time on the Jobs page.

classic

  1. In the Jobs page, click the Start Job button. The Start Job window is displayed.
  2. From the Process drop-down, select a previously deployed process.
    • The Parameters tab is automatically populated with all the input parameters accepted by the selected process, the values inherited from the package as well.
    • The Job Priority field is automatically populated with the priority inherited from the package.
  3. 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 process level.
  4. In the Execution Target tab, select the Robots that you want to execute the indicated process on, or select Allocate Dynamically and specify the number of times the process should be executed.
  5. In the Parameters tab, provide input parameters for the selected process, if desired.
  6. Click Start. The Start Job window closes and the execution starts. The status of each 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 the Jobs page can be stopped from the Jobs page only.

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

Whenever a process is sent the Kill command from Orchestrator, it first tries to Cancel the execution and if the execution is not finished within 3 seconds, the execution is killed.
Whenever a process receives the Cancel command, it cancels the execution of the current activity and starts executing the Finally block for clean-up reasons.

Note

A job started from the Robot Tray can be killed from the Robot Tray only.
A job started from the Jobs page can be killed both from the Jobs page and the Robot Tray.

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 an agent.

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.
  1. Make the desired changes.
  2. Click Start. The Start Jobs window closes and the execution starts. The status of each job is displayed, in real-time, in 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.

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. The execution media created according to your settings is downloaded.
File storage is impacted by the NuGet.Repository.Type parameter, and configured using the Storage.Type and Storage.Location parameters when NuGet.Repository.Type is set to Composite. Details here.

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.