Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Field Descriptions

The Processes Page

FieldDescription
Columns

visible_columns
Enables you to toggle column visibility. By default, all columns are displayed. Clear or select the check boxes corresponding to the columns you want to stay hidden or visible, respectively.
Click Reset in the Visible Columns drop-down to return to the default configuration with all columns enabled and visible.
SearchLooks for processes that match your input. Searches according to name, environment, and description.
Job Priority FilterEnables you to filter by job priority. The following options are available:
All
High
Normal
Low
Type FilterEnables you to filter by the job type. The following options are available:
All
Testing
Process
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.
NameThe name or display name or display name of the package that was deployed. The update_available icon next to this field indicates that you are not using the latest available version. If the package version associated with a process 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.
VersionThe number of the package version currently being used in a given process.
The process type is illustrated with an icon displayed alongside the version. The icon represents the type of that specific process version.
Requires User Interface requires_user_interface
Background Process requires_user_interface
Job PriorityThe priority of the job.
Click here for details about the job prioritization mechanism.
TypeThe process type out of the following options:

Process - a RPA process.
Business Process - a StudioX created process.
Testing - a TestAutomation process.
EnvironmentOnly available for classic folders.
The name of the environment assigned to a given package.
DescriptionThe description of a given process.
Start Job

start_job
Opens the Start Job window with this process selected.
More Actions

more_actions
Displays a menu with the following options:
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.
Add Trigger - Displays the Add Trigger window and enables you to set a new trigger for this process. Only available for classic folders.
Monitor Process - Displays the Monitoring page for the corresponding process.
Recording - Displays the Recording window which enables you to switch recording on or off. Read more about recording.
Remove - Enables you to delete a selected process from Orchestrator.
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

FieldDescription
Package Name Select the package that you want to use from the list.
Display NameThe display name of the process. This name is used in all locations where processes are mentioned, listed or monitored.
modern
If left empty, the name of the package is used instead.
classic
If left empty, the PackageName_AssociatedEnvironmentName syntax is used instead.

Note: Not available for TestAutomation processes.
Package VersionSelect 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.
EnvironmentOnly available for classic folders.
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 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 ValuesAll 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 ValuesRead-only.
All output parameters that have been configured in the Main.xaml of the process. These values cannot be edited.
Enable RecordingEnables 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.
Automatically Start ProcessEnables you to set the process to launch automatically when the user's Robot agent is launched.
Note: Available only for attended automation.
Create Creates the process with the settings you previously set and closes the Deploy Process window.
Cancel Closes the Deploy Process window without saving your settings.

The View Processes Window

The Version Management Tab

FieldDescription
PackageRead-only.
The name of the package that has been deployed to the opened process.
EnvironmentOnly available for classic folders.
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

FieldDescription
PackageRead-only.
The name and version of the package that has been deployed to the opened process.
EnvironmentOnly available for classic folders.
Read-only.
The name of the environment that has been deployed to the opened process.
Input ValuesOptional.
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 ValuesRead-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.
UpdateSaves the changes made to the selected process.
CancelCloses the View Process window without saving your settings.

The Process Settings Window

FieldDescription
Display NameThe display name of the process. This name is used in all locations where processes are mentioned, listed or monitored.
Enable RecordingEnables 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.
Automatically Start ProcessEnables you to set the process to launch automatically when the user's Robot agent is launched.
Note: Available only for attended automation.

Updated 2 years ago



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.