UiPath Orchestrator Guide

Field Descriptions

The Processes Page

Field
Description

Packages tab

Displays the Packages page.

Search

search

Looks for processes that match your input. Searches according to name, environment, and description.

Add

add

Displays the Deploy Process window.
Note: Adding a process requires your user to have View and Create permissions on Processes, as well as View permissions on Packages and Environments. Read more about roles.

Name

The name of the package that was associated with an environment. The update_available icon next to this field indicates that you are not using the latest available version. If the package version associated with an environment is no longer available in the configured NuGet repository, it is indicated with the following icon version_not_available. If you are using the latest available version, the following icon using_latest_version is displayed.

Version

The number of the package version currently being used in a given process.

Environment

The name of the environment assigned to a given package.

Description

The description of a given process.

View Process

view_process

Displays the View Process window for the corresponding process, and enables you to update or rollback the associated package, as well as edit input parameters.

Monitor Process

monitor_process

Displays the Monitoring page for the corresponding process.

Recording

process_recording

Displays the Recording window which enables you to switch recording on or off. Read more about recording.

Remove

remove

Enables you to delete a selected process from Orchestrator.
Note: Removing a process requires your user to have View and Delete permissions on Processes, as well as View permissions on Packages and Environments. Read more about roles.

Use Latest

use_latest

Enables you to update multiple processes to the latest available package version.
It is only enabled if your selection contains at least one process not using the latest available package version.
Note that managing process versions requires View and Edit permissions on Processes, and View permissions on Packages.

The Deploy Process Window

Field
Description

Package Name

Mandatory.
Select the package that you want to use from the list.

Package Version

Mandatory.
Select the package version that you want to use from the list. This field is automatically populated with the latest available version of the selected package.

Environment

Mandatory.
Select the environment that you want to associate with the chosen package. By default, it is populated with the first environment available, in alphabetical order.

Description

Optional.
A custom description for the process. It is recommended that you populate this field, especially when dealing with multiple users and processes in Orchestrator.

Input Values

Optional.
All input parameters that have been configured in the Main.xaml of the process. All these values are editable.
If a parameter has a default value set in Studio, it is marked with the "Inherited from package" message. If a parameter has no value, it is marked accordingly.

Output Values

Read-only.
All output parameters that have been configured in the Main.xaml of the process. These values cannot be edited.

Enable Recording

Enables you to switch recording on or off. When enabled, the last moments of a failed job execution are recorded and available for download. By default, this option is disabled. If you enable it, the following settings are displayed:

  • Scaling - Enables you to set the scaling of the screenshots in percent. The maximum value is 100. By default, this field is set to 100.
  • Frequency - Enables you to configure the time interval between screenshots, in milliseconds. The minimum value is 250. By default, this field is set to 500.
  • Duration - Enables you to configure the length of time before failure to start the recording, in seconds. The maximum value is 120. By default, this field is set to 40.
    The Enable Recording option is only displayed on the Deploy Process window if you have View permissions on Execution Media.

Create

Creates the process with the settings you previously set and closes the Deploy Process window. This button is available only if the Package Name, Package Version, and Environment fields are filled in.

Cancel

Closes the Deploy Process window without saving your settings.

The View Processes Window

The Version Management Tab

Field
Description

Package

Read-only.
The name of the package that has been deployed to the opened process.

Environment

Read-only.
The name of the environment that has been deployed to the opened process.

Latest

Updates the package used in the selected process to the latest available version.
This button is displayed only if you are not using the latest available version of the package.

Rollback

Restores the package in the selected process to the previously used version. For example, consider a package with 3 versions (a, b, c). If the last used was c before you updated to a, and you click Rollback, the process is going to revert to version c.

Version

All the available versions of the package in the selected process. A Current label is displayed next to the version that is being used at the given moment.

Published

The amount of time elapsed since a version of the package was published.

Used

The amount of time elapsed since a given package version was last used in the process. Hovering over this field displays the exact time and date.

Use

Enables you to use the corresponding package version. This button is displayed only when hovering over a version. Additionally, it is not available for the version that is currently in use.

The Parameters Tab

Field
Description

Package

Read-only.
The name and version of the package that has been deployed to the opened process.

Environment

Read-only.
The name of the environment that has been deployed to the opened process.

Input Values

Optional.
All input parameters that have been configured in the Main.xaml of the process. All these values are editable.
If a parameter has a default value set in Studio, it is marked with the "Inherited from package" message. If a parameter has no value, it is marked accordingly.
If no In or In/Out arguments have been defined in Studio, the following message is displayed: Input parameters are not defined for this version.

Output Values

Read-only.
All output parameters that have been configured in the Main.xaml of the process. These values cannot be edited.
If no Out or In/Out arguments have been defined in Studio, the following message is displayed: Output parameters are not defined for this version.

Update

Saves the changes made to the selected process.

Cancel

Closes the View Process window without saving your settings.

The Recording Window

Field
Description

Enable Recording

Enables you to switch recording on or off. When enabled, the last moments of a failed job execution are recorded and available for download. By default, this option is disabled. If you enable it, the following settings are displayed:

  • Scaling - Enables you to set the scaling of the screenshots in percent. The maximum value is 100. By default, this field is set to 100.
  • Frequency - Enables you to configure the time interval between screenshots, in milliseconds. The minimum value is 250. By default, this field is set to 500.
  • Duration - Enables you to configure the length of time before failure to start the recording, in seconds. The maximum value is 120. By default, this field is set to 40.
    The Enable Recording option is only displayed on the Deploy Process window if you have View permissions on Execution Media.


Field Descriptions


Suggested Edits are limited on API Reference Pages

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