orchestrator
2020.10
false
UiPath logo, featuring letters U and I in white
OUT OF SUPPORT

Orchestrator User Guide

Last updated Dec 12, 2023

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.
  1. In the Jobs page, click the Start Job button. The Start Job window is displayed.
  2. From the Process Name drop-down, select a process that has been previously deployed to the current folder.
  3. Configure the required fields, as follows:
    1. Set the job priority.
      From the Jobs Priority drop-down, select the priority of the job to be executed, if you want it to be different from the priority set at the process level. This field is automatically populated with the priority inherited from the package.
    2. Select the execution runtime.
      From the Job Type drop-down, select the license model of the runtime under which the job is to be executed. The number of available and connected runtimes is displayed below the drop-down.

      _ Available

      _ Connected

      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 with 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 with 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.
    3. Configure the execution target.
      Configure your execution target by setting the options below as desired on the Execution Target tab.

      Allocate Dynamically

      A foreground process is executed multiple times under the user and machine which become available first.

      If the user is also selected, only machine allocation is done dynamically.

      Background processes get executed on any user, regardless if it's busy or not, as long as you have sufficient runtimes.

      Using the Allocate Dynamically option you can execute a process up to 10,000 times in one job.

      User

      The process is executed under a specific user.

      Machine

      The process is executed on a specific host machine. 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. Add parameters.
      On the Parameters tab, provide input parameters for the selected process. This tab is automatically populated with all the input parameters accepted by the selected process, and the corresponding values inherited from the package.
  4. 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.

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:

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.
  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, 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. Execution media is downloaded according to your settings.

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2025 UiPath. All rights reserved.