Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Managing Processes

Deploying Processes


Note that creating a process requires your user to have View permission on Packages and View and Create permissions on Processes. For deploying processes in classic folders, View permissions on Environments is also required. Read more about roles.

  1. Click Add. The Add Process window is displayed.
  2. Select a package from the Package Name drop-down or use the Add Package () to upload a new package. The latest version of the package is automatically selected. If the package has input and/or output parameters, they are also displayed.
  3. In the Display Name field, add the name to be displayed on all pages which mention, list, or monitor processes. If left empty, the name of the package is used instead.
  4. From the Package Version drop-down, select the version of the package that you want to use.
  5. From the Job Priority drop-down, select the execution priority of the process.
  6. Type a Description for the process. We recommend adding a description, especially when there are many processes deployed to Orchestrator.
  7. If the package has input parameters, you can also provide values for them in the Input Values tab.
  8. Switch on the Enable Recording option so that, in the event of a job failure, the last moments of the execution are recorded and available for download as execution media. Configure the Scaling, Frequency, and Duration options as desired

๐Ÿ“˜

Note

The Recording option is only displayed on the Deploy Process window if you have View permissions on Execution Media.

  1. Switch on the Automatically Start Process option to set this process to launch automatically when the Robot agent starts.
  2. Switch on the Always Running Process option to restrict process termination from the UiPath Assistant.
  3. Click Create. The Add Process window is closed and the process is displayed on the Processes page.

The display name, description, job priority, as well as the Enable Recording, Automatically Start Process, Always Running Process toggles can be modified after deploying a process on the Process Settings window (More Actions > Process Settings).

Managing Package Versions


Note that managing package versions for a process requires View and Edit permissions on Processes, and View permissions on Packages/Folder Packages.

Process Level

Single Process

If a process has multiple versions available, you can select which one to use from the View Processes page:

  1. Click More Actions > View Process button for a process with multiple package versions available. The View Process window is displayed.
  1. On the Version Management tab:
    a. Click the Use button for the corresponding version that you want to use. The View Process window is closed and your configuration is saved. If the version you updated the process to was not the latest, the exclamation mark icon is still displayed next to the process.
    b. Click the Latest button if you want to update the process to the latest available package version. The View Process window is closed and your configuration is saved.
    c. Click the Rollback button. This enables you to return to the previously used version.

Multiple Processes

Enables you to update multiple processes in a folder to the latest available package version.

  1. On the Processes page, select the processes you want to update to the latest available package version.
  2. Click Use Latest. The Use Latest button is only enabled if your selection contains at least one process not using the latest available package version. The button is disabled if your selection contains processes using the latest available package version.
  3. Click Yes on the displayed confirmation window. The selected processes are updated to the latest version, and the icons are updated accordingly. If for any reason, a process is not updated, an error message is displayed.

Package Level

Updating processes across multiple folders/subfolders at once can be performed at the package level. Orchestrator searches for and displays all processes associated with the selected packages, allowing you to select which of them should be updated to the latest available package version. The search is performed on a per-feed basis as follows:

  • Tenant Feed - Orchestrator searches for all processes associated with the selected packages in all folders/subfolders that use the tenant feed.
    Packages page (Tenant context > Packages tab)
  • Folder Feed - Orchestrator searches for all processes associated with the selected packages in that particular folder feed, subfolders included.
    Folder Packages page (Folder context > Automations tab > Folder Packages tab)

The upgrade process is similar at both tenant feed and folder feed levels. According to the context you're in, navigate to the location described above and then:

  1. Select the packages for upgrading and click Upgrade available processes to latest versions. The Upgrade multiple processes window is opened displaying a list with all processes not employing the latest version of a package. The following information is displayed on the Upgrade multiple processes window:
    a. The name of the package
    b. The latest version of the package
    c. The number of processes not using the latest package version
    d. The names of the processes, along with the current package version and the path of the folder/subfolder they reside in.

Upgrading processes that use packages residing in a folder feed.

Upgrading processes that use packages residing in the tenant feed.

  1. For each package select the processes that you would like to upgrade. When done, click Upgrade. Selected processes are bulk updated with the latest version of their packages.

Managing the Value of Input Parameters


If a process has one or more input parameters, you can edit their values at the process level:

  1. Click More Actions > View Process button for a process with multiple versions available. The View Process window is displayed.
  2. In the Parameters tab, click the Edit button next to the input parameter you want to add a value for.
  3. Add the desired value and click Save. The value of the input parameter is saved.
  4. Repeat step number 3 as many times as you need.
  5. Click Update. The values of all the input parameters are saved. For more information on how to fill in these values, please click here.

You can also remove the value of an input parameter by clicking the corresponding Clear Value button.

Monitoring a Process


Click More Actions > Monitor Process button of the desired process to see the Monitoring page associated with it. Due to the Monitor Process button being displayed on the Processes page, you also need View on Processes to access the monitoring page from here.
Alternatively, select it from the Processes Overview widget (Monitoring > Jobs).

Note that monitoring a process requires your user to have View permissions on Jobs and on Monitoring. Additionally, Edit on Monitoring is required in order to disable errors from the Error Feed widget on the Monitoring > Jobs page. View on Environments is required in order to filter the pages by the environment.

Removing Processes


Note that removing a process requires your user to have View and Delete permissions on Processes, as well as View permissions on Packages. For process deployed in classic folders, View permission on Environments is also required. Read more about roles.

  1. In the Processes page, select the processes that interest you.
  2. Click the Remove button. The process is deleted from the Processes page and the database. Please note that deleting a process is not going to delete the package from Orchestrator, but only its association with the environment/folder.

Alternatively, if you want to delete only one process, click the corresponding Remove button.

If you remove a process that has triggers associated with it, these are also removed, regardless if they are enabled or disabled.

๐Ÿ“˜

Note:

You cannot remove a process if it is associated with an active job (it has one of following statuses: Pending, Running, Stopping and Terminating).

Updated 28 days ago


Managing Processes


Suggested Edits are limited on API Reference Pages

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