Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

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.

Runtime Arguments


Entry Points

There are cases when your automation projects consist of multiple workflows. For such projects, it is a good practice to hold your project's main workflow in the 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.

You can change the entry point of an automation project, i.e. change its execution "gate" by changing the main .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.

You can change the main .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.

🚧

Important

This feature only works for unattended execution, i.e. jobs started from Orchestrator. When launching a job using the Assistant, the Robot executes the main entry point set at design time in Studio, regardless of the entry point set in Orchestrator.

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 storage
  • GetInvoiceFromLocal.xaml — workflow that gets the invoice from your device.

At run time in Orchestrator, you select as an entry point the workflow that corresponds to your scenario. If the invoice is already on your local device, you set 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).

📘

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.

In, Out, In/Out Arguments

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.

1 - Select the entry point. Only enabled if multiple entry points are available.
2 - Filter the displayed arguments according to their direction (Input, Output, All)
3 - See arguments and related information for the `.xaml` set as the entry point.1 - Select the entry point. Only enabled if multiple entry points are available.
2 - Filter the displayed arguments according to their direction (Input, Output, All)
3 - See arguments and related information for the `.xaml` set as the entry point.

1 - Select the entry point. Only enabled if multiple entry points are available.
2 - Filter the displayed arguments according to their direction (Input, Output, All)
3 - See arguments and related information for the .xaml set as the entry point.

📘

Note

Default values provided for In arguments in Studio are not displayed in Orchestrator, at any level.

Process Types


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:

  • doesnot_require_user_interfacedoesnot_require_user_interface 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.
    Learn more about background process automation in Studio.
  • requires_user_interfacerequires_user_interface 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

21.8+

Foreground

Robot without credentials

Invalid configuration! Jobs cannot be executed.

Process Compatibility


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.
Learn more about target frameworks in Studio.

Target framework

Operating system

Robot version

.NET Framework 4.6.1

Windows - Legacy

Any

.NET 5.0+

Windows

21.8+

.NET 5.0+

Cross-platform

21.8+

Version Management


If a new version of a package is available in Orchestrator (you published a new version from Studio), it is indicated with the update_processupdate_process icon next to the process it is part of. For more information, see the Managing Package Versions page.

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. For more information, see the Managing Package Versions page.

If a package version associated with a process is no longer available in the configured NuGet repository, it is indicated with the cannot_find_processcannot_find_process icon.

If you are using the latest available version of a package in a specific process, the using_last_package_versionusing_last_package_version icon is displayed next to the process.

Processes Permissions


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

Deploying processes in classic folders:

  • Permissions for creating a process
    View on Environments is also required.

Read more about roles.

Updated about a month ago


About Processes


Suggested Edits are limited on API Reference Pages

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