- Getting started
- Best practices
- Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Managing Robots
- Connecting Robots to Orchestrator
- Storing Robot Credentials in CyberArk
- Storing Unattended Robot Passwords in Azure Key Vault (read only)
- Storing Unattended Robot Credentials in HashiCorp Vault (read only)
- Storing Unattended Robot Credentials in AWS Secrets Manager (read only)
- Deleting Disconnected and Unresponsive Unattended Sessions
- Robot Authentication
- Robot Authentication With Client Credentials
- Audit
- Cloud robots
- Folders Context
- Automations
- Processes
- About Processes
- Managing Processes
- Managing Package Requirements
- Recording
- Jobs
- Apps
- Triggers
- Logs
- Monitoring
- Queues
- Assets
- Storage Buckets
- Test Suite - Orchestrator
- Resource Catalog Service
- Authentication
- Integrations
- Classic Robots
- Troubleshooting
About Processes
A process represents a package version linked to a particular folder. When you deploy a new process, it becomes available for all accounts that have access to that folder.
The Processes page enables you to deploy an uploaded package as a new process, manage previously created processes, keep all your processes up to date with the most recent package versions, and directly start a job using the desired process. This helps you distribute packages across all accounts in your organization and execute processes faster whether from the Processes or Jobs page.
In addition to executing processes from the Processes and Jobs pages, you can also configure any process to automatically start when the Robot agent is launched. As an administrator, this enables you to ensure that necessary processes are launched without delay or failure from the machine user, for example, to ensure adherence to company IT policies.
The table below contains field descriptions for the Processes page.
|
Field |
Description |
|---|---|
|
Name |
The display name of the process. The process type is illustrated with an icon displayed alongside the version. The icon represents the type of that specific process version.
|
|
Package Name | The name of the package that was deployed.
Not visible by default. To display the column, select it from the Columns menu. You can sort the processes list by Package Name. |
|
Version |
The number of the package version currently being used in a given process.
|
|
Job priority |
The priority of the job. You can sort and filter the processes list by Job priority. |
|
Scope |
The scope of a project, set at design time in Studio. The following options are available:
|
|
Execution type |
The type of the process execution. Linked to the Attended Automation project setting in Studio:
The Unspecified value is displayed for packages published prior to the 2021.10.3 Studio version. |
|
Compatibility |
The compatible operating system for the underlying target framework of the automation project. |
|
Entry point |
The workflow file used to start the execution of the process. By default, the
Main.xml file is set as the entry point. If your project contains multiple entry points, the one selected at process creation is displayed.
|
|
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. |
| Labels | The list of all labels associated with the process. |
| Properties | The list of all key-value pairs associated with the process. |
| Retention action | The retention policy outcome at the end of the retention duration. |
| Retention (days) | The duration of the retention policy. |
Main.xaml file. All other automation .xaml files included in the project should be linked to the Main.xaml through the Invoke Workflow File activity since in typical scenarios only the Main.xaml file is executed when you run a job, it being the default entry point of any automation project. Learn more about project organization and design principles in Studio.
.xaml file. Similarly, you can add multiple entry points for your RPA processes, which enables you to execute only a certain branch
of your automation project.
.xaml file or add multiple entry points in RPA processes in Studio by right-clicking a different .xaml file and setting it as main or adding it as an entry point.
Say you build a workflow that checks invoices. The invoice could be downloaded from cloud storage or it could be located on your device.
You design two workflows inside the project and set them both as entry points:
DownloadInvoiceFromStorage.xaml— workflow that downloads the invoice from an external storageGetInvoiceFromLocal.xaml— workflow that gets the invoice from your device.
GetInvoiceFromLocal.xaml as an entry point. This starts the execution beginning with that step and continues with the invoice checking workflow (the
Main.xaml file).
- 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
Defaultin the Entry point drop-down, and the field is disabled.
Designing your project in Studio to accept In or Out arguments enables you to use them in other third-party apps or Orchestrator. This means that any process you create can receive input arguments through the Orchestrator API or interface.
In Orchestrator, arguments and related information are displayed in multiple places: at the process level, job level, and trigger level in the dedicated arguments sections (Runtime Arguments or Arguments tab).
You can specify values for any input arguments. For more info on input and output arguments in Orchestrator, please visit this page.
This section describes existing process types according to the user interface requirements. The process type is configured in Studio on the Project Settings window and illustrated accordingly in Orchestrator after publishing the project.
There are two types of processes, according to the user interface requirements:
-
Background Process - Does not require a user interface, nor user intervention to get executed. For this reason, you can execute multiple such
jobs in unattended mode on the same user simultaneously. Each execution requires an Unattended/NonProduction license. Unattended
robots handle background processes in Session 0, under NT AUTHORITY\LOCAL SERVICE, which has no UI and cannot interact with a user session. -
Foreground Process - Requires user interface as the execution needs the UI to be generated, or the process contains interactive activities,
such as Click. You can only execute one such process on a user at a time.
Note: The same user can execute multiple background processes and a singular foreground at the same time.
The following table shows the UiPath® Robot version required to run foreground/background processes according to the robot credential considerations.
|
Process type |
Credential considerations |
Robot version |
|---|---|---|
|
Background |
Robot with credentials |
Any |
|
Foreground |
Robot with credentials |
Any |
|
Background |
Robot without credentials |
2021.10+ |
|
Foreground |
Robot without credentials |
Invalid configuration! Jobs cannot be executed. |
When creating an automation project in Studio, developers must configure a compatibility attribute that impacts the underlying target framework of the automation project and the compatible operating system.
The following table shows the UiPath Robot version required to execute processes according to their target frameworks and OS compatibility considerations.
|
Target framework |
Operating system |
Robot version |
|---|---|---|
|
.NET Framework 4.6.1 |
Windows - Legacy |
Any |
|
.NET 5.0+ |
Windows |
2021.10+ |
|
.NET 5.0+ |
Cross-platform |
2021.10+ |
If a new version of a package is available in Orchestrator (you published a new version from Studio), it is indicated with
the 
icon next to the process it is part of.
You may update processes to the latest available version individually, on the corresponding View Processes window, or you may update them in bulk, by selecting multiple of them and clicking the global Use Latest button.
If a package version associated with a process is no longer available in the configured NuGet repository, it is indicated
with the 
icon.
If you are using the latest available version of a package in a specific process, the 
icon is displayed next to the process.
Windows applications that are used by the underlying Studio package are displayed in the Applications section, as relevant to the selected package version.
If the package uses applications that cannot be identified, an Unknown apps entry is displayed, suffixed by the number of unidentified apps, in parentheses.
-
Your Studio version is older than 2023.2.
-
Your Studio version is 2023.2, but a governance rule is in place, preventing this information from being logged.
-
Your package was uploaded from an external feed. Only packages from internal feeds can provide this information.
-
The package does not use any applications.
Creating a process:
- View permission on Packages;
- View and Create permissions on Processes.
Starting a job from the Processes page:
- Permissions for creating a process
- Create on Jobs
Read more about roles.
