orchestrator

2024.10

true

Orchestrator User Guide

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Nov 22, 2024

Managing Processes

Deploying Processes

Note: You need View permissions on Packages and View and Create permissions on Processes to create a process.

Navigate to Automations > Processes in the folder where you want to deploy the process. The Processes window is displayed.
Click Add. The Add Process window is displayed.
Select a package from the Package Source Name drop-down or click the upload area below to upload a new package. The latest version of the package is automatically selected. If the package version has tags that are not applied to the process, a New tags have been found notification window is displayed informing you about the number of tags.
On the New tags have been found window, click Add and continue if you want to apply package tags to the process or click Don't add if you do not want to apply package tags to the process.
From the Package Version drop-down, select the version of the package that you want to use. If the package has input and/or output arguments, they are displayed in the Runtime Arguments section.
Select an entry point from the Entry point drop-down. By default, the .xaml set as main Studio is selected. The arguments view is refreshed to display the arguments in the selected workflow. Learn more about runtime arguments.
Note:
- For packages published before July 2020, Orchestrator cannot determine the main entry point, hence no entry point is selected by default. You need to select the entry point from the drop-down manually.
- If the process doesn't support multiple entry points, Orchestrator displays Default in the Entry point drop-down, and the field is disabled.
If the package has input arguments, you can provide values for them in the arguments table. Edit the arguments by clicking Edit for the corresponding entry.
Once you are done with the changes, click Next. The Package Requirements window is displayed.

The Package Requirements tab allows you to identify objects that have been used in the design of the underlying workflow and are required for successful job execution.

See Managing package requirements for details on how to manage package requirements.
Once you have handled the package requirements, click Next. The Additional Settings window is displayed.
The Display Name field is prepopulated with the package name and will be displayed on all pages which mention, list, or monitor processes. However, the process name can be edited with a different name, if preferred.
Type a Description for the process. We recommend adding a description, especially when there are many processes deployed to Orchestrator.
In the Tags section, manage the process tags. You can see tags inherited from the underlying package, if any, and you can add new tags or remove existing ones, provided you have the necessary permissions. See Organizing resources with tags for details.
In the Retention policy section, create a rule for when a job associated to this process is deleted. See Process data retention policy for details.
From the Job Priority drop-down, select the execution priority of the process.
Switch on the Hide process for attended users option if you want this process to be withheld from Assistant. When this is enabled, the Process can’t be stopped from UiPath Assistant option becomes inactive.

Note:
This only works with Assistant and Robot versions 2023.10+.
Switch on the Process can’t be stopped from UiPath Assistant option to restrict process termination from the UiPath Assistant.
Switch on the Automatically Start Process option to set this process to launch automatically when the Robot agent starts.

Switch on the Enable Recording option so that, in the event of a job failure, the execution is recorded and available for download as execution media.

Note:

If you do not see the Enable Recording option:

You recently upgraded to Enterprise or Enterprise Trial licensing; please allow a few days for migration, after which the option becomes available.
Make sure you have the Execution Media - View permission assigned to your account.

Configure the Scaling, Frequency, and Duration options as needed.

Field	Description
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.

(Optional, only available for cross-platform processes) If you want to run this process using Automation Suite Robots, select an option for the machine size to use:

Option	Details	Robot unit (RU) consumption
Automatic	Default setting. Selects the optimum machine size based on high-level process dependencies.	Depends on machine size
Small	1 GB (~0.5 CPUs) For most unattended processes.	1 RU / minute
Standard	2 GB (~1 CPUs) For unattended processes that use UI Automation.	2 RUs / minute
Medium	4 GB (~2 CPUs) For slightly more complex unattended processes, such as remote debugging.	4 RUs / minute
Large	10 GB (~6 CPUs) For heavy processes, such as ones that include activities.	10 RUs / minute

Important: If the selected machine size is too small, your process will time out without completing, but you still consume robot units for the duration that the machine was running.

Editing Process Settings

The display name, description, job priority, as well as the Enable Recording,Automatically Start Process,Process can’t be stopped from UiPath Assistant options can be modified after deploying a process on the Process Settings window.

For the desired process, click More Actions > Process Settings. The Process Settings window is displayed.
Change the desired option, and click Update to save the changes.
Note:
- By default, any process can be edited while having associated running or pending jobs. Please take into account the following:
- Running jobs associated with a modified process use the initial version of the process.
- Newly created jobs or new triggers of the same job use the new version.
- Pending jobs associated with a modified process use the updated version.
  - The Process filter on the Automations > Logs page searches for the latest name given to the process. Logs recorded under old process names cannot be filtered anymore.

Managing Package Versions

Important:

When first publishing a package, the main entry point defined in Studio is also set as the current entry point in Orchestrator.
Upon publishing a new package version, the current entry point is preserved as long as it exists in the new version; otherwise, it defaults to the main entry point defined in Studio.
Switching to a package version that does not have the initial entry point will default to the main entry point defined in Studio. The current entry point is kept upon upgrading if it exists on the new version as well.
Updating a process by uploading a package from an external feed is possible via the /odata/Processes/UiPath.Server.Configuration.OData.SetArguments endpoint. It is your responsibility to make sure the process arguments are the same as the arguments in the new package, as Orchestrator does not perform any validation on packages from external feeds.

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

Updating a Process in a Folder

If a process has multiple versions available, you can select which one to use from the Package Version drop-down either when creating or editing a process.

Click More Actions > Edit . The Edit Process window is displayed.
On the Package Versions drop-down, select the specific package version you want to use or click Rollback to return to the previously used version.

To upgrade a process to the latest version easily without accessing the Edit Process window, follow the next steps:

Click More Actions > Upgrade to latest version for the desired process. The Upgrade to latest version button is read-only for processes already using the latest package version.
Click Confirm 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.

Updating Multiple Processes in a Folder

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

On the Processes page, select the processes you want to update to the latest available package version.
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.
Click Confirm 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.

Updating Processes Across Folders

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. Find it on the 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. Find it on the 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:

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:
1. The name of the package
2. The latest version of the package
3. The number of processes not using the latest package version
4. 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:
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 Arguments

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

Click More Actions > Edit for a process. The View Process window is displayed.
On the Runtime Arguments section, in the Arguments table, click the Edit button next to the input argument meter you want to add a value for.
Add the desired value and click Save. The value of the input argument is saved.
Repeat step number 3 as many times as you need.
Click Update. The values of all the input arguments are saved. For more information on how to fill in these values, please click here.

You can also remove the value of an input argument 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.

Adding Tags to Processes

Note:

You need Edit on Processes and View on Tags to add existing tags to processes.

You need Edit on Processes and Create on Tags to add new tags to processes. If you do not have Create on Tags, Orchestrator allows you to add new tags but does not save them.

Note:

Each process can have a maximum of one million key/value pairs.
Labels and key/value properties are limited to 256 characters.
Tag names can't contain these characters: <, >, %, &, \, ?, /, :

You can apply tags to a process either when creating one or editing an existing one. To add tags to a process when editing it, follow these steps:

From the Processes page, click More Actions > Edit next to the desired process. The process is opened for editing.
On the Labels field, start typing the name of the label. You can choose an existing label or create a new one.
On the Properties (key-value pairs) field, click Add new.
Add new keys and values. You can choose existing keys and/or values or you can create new ones.
When done, click Update. Your process is updated and the newly created tags, if any, become available for other objects.

Removing Tags From Processes

To remove tags from a process, follow these steps:

From the Processes page, click More Actions > Edit next to the desired process. The process is opened for editing.
On the Labels field, click the X adjacent to the name of the label to remove it. The label is removed.
On the Properties (key-value pairs) field, click the X adjacent to the keys and/or values to remove them. The keys and/or values are removed.
To delete a key/value pair click the Remove icon corresponding to that entry. The key/value pair is removed.
When done, click Update. Your processes is updated and tags are removed.

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. Read more about roles.

In the Processes page, select the processes that interest you.
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).

On this page

Deploying Processes
Editing Process Settings
Managing Package Versions
Updating a Process in a Folder
Updating Multiple Processes in a Folder
Updating Processes Across Folders
Managing the Value of Input Arguments
Monitoring a Process
Adding Tags to Processes
Removing Tags From Processes
Removing Processes

Was this page helpful?

PREVIOUSAbout Processes

NEXTManaging Package Requirements

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy