UiPath Studio Guide

About UiPath Remote Runtime

UiPath Remote Runtime is a component which facilitates the communication between a remote application or desktop, such as Citrix Apps, and the dedicated UiPath extension - UiPath Citrix or UiPath Windows Remote Desktop. It gathers info about targeted UI elements of remote applications and sends them to the corresponding extension so that selectors are natively generated in UIExplorer.

Depending on the type of environment you want to build your automation projects on, the UiPath Remote Runtime component can be installed as follows:

  • On Citrix App and Desktop servers - communicates with the UiPath Citrix extension.
  • On Windows Remote Desktop machines - communicates with the UiPath Windows Remote Desktop extension.

The UiPathRemoteRuntime.msi installer is included in UiPathPlatformInstaller.exe, or you can obtain it by contacting our Support Team. Please note that UiPathPlatformInstaller.exe does not support command line arguments.

Find out how you can install the UiPath Remote Runtime, the UiPath Citrix extension, as well as the UiPath Windows Remote Desktop extension.

Once the UiPath Remote Runtime component is installed, it registers a task in the TaskScheduler so that the UiPathRemoteRuntime.exe process is started at every user login.

Driver Dependencies

The UiPath Remote Runtime and the UiPath driver dependency for the UiPath.UIAutomation.Activities package must have the same version.

The Remote Runtime version is dictated by the Comments field, located in the Details tab of the UiPathRemoteRuntime.msi properties.

The version of the UiPath driver dependency is displayed in the Package Manager in the UiPathUIAutomation.Activities package info section.

You can view the dependencies shipped with each version of the UiPath.UIAutomation.Activities package on this page.

Remote Runtime Architecture

When you start a process, the Robot sends out the necessary commands to the Citrix or Windows Remote Desktop extension via an RPC channel. This information package also contains details about the version of the UIAutomation package used to build the process.

The corresponding extension then forwards the information package via an ICA virtual channel to the UiPath Remote Runtime component, which is on the Citrix servers or Remote Desktop machine.

Depending on the version of the UIAutomation package with which the process was built, the UiPath Remote Runtime component instructs the Robot Executor which driver to use.

Multiple ICA Channels

Communication between the Remote Runtime Component and the corresponding extension is done via an internally-developed ICA channel. Multiple ICA channels can be used, but the Citrix Receiver, for instance, already uses several channels for the clipboard, audio, and more.

Data Transfer and Bandwidth Considerations

Once the Remote Runtime component is installed, you can create your automation projects without having to create any firewall rules.

Data transfer between the Remote Runtime and extension requires little bandwidth usage. For example, each action the Robot performs (such as a Click activity) transfers around 3 KB of data.

Side-by-Side Support

The UiPath Runtime component was first introduced in v2018.4. To ensure backward compatibility, newer versions of the UiPathRemoteRuntime.msi include all previous driver versions since it was introduced. For example, a v2019.4 Robot is able to execute processes created with the UIAutomation package version 18.4.5 and above without any issues.

It is installed on the server or remote desktop machine in the %ProgramFiles(x86)%\UiPath folder. All installed versions are visible in the %ProgramFiles(x86)%\UiPath\RemoteRuntime\packages\uipath folder.

When you build or execute a process you need to use a UiPath.UIAutomation.Activities package which is compatible with the deployed driver version of the UiPath Remote Runtime. The driver is represented by the UiPath dependency of the UiPath.UIAutomation.Activities package. The table below displays which UiPath.UIAutomation.Activities package contains compatible driver versions for the UiPath Remote Runtime.

UiPath.UIAutomation.Activities
UiPath / Remote Runtime

18.4.5

10.0.7020.22745

18.4.6

10.0.7194.26789

19.4.1

19.4.7054.14370

19.4.2

19.4.7068.19937

Please note that if you use a version of the UiPath.UIAutomation.Activities package which does not contain one of the UiPath dependencies mentioned above, selectors are not generated and an exception is thrown, as displayed below.

Adding Remote Runtime Dependencies

Interactive selection on the target application does not build correct selectors unless the UiPath.UIAutomation.Activities matches the UiPath Remote Runtime dependency on the Citrix server or the Remote Desktop machine.

For example, if you want to build an automation project using the UiPath.UIAutomation.Activities package version 19.6.0, you also need to copy the corresponding UiPath dependency from the client machine (where Studio is installed) on the Citrix server or the Remote Desktop machine. This is done as follows:

  1. On the client machine (where Studio is installed), navigate to the %UserProfile%\.nuget\packages\uipath folder. All installed UiPath dependencies are located there.
  2. Copy the version which corresponds to the UiPath.UIAutomation.Activities package you want to use. You can view the list of dependencies shipped the UiPath.UIAutomation.Activities package on this page.
  3. On the Citrix server or the Remote Desktop machine, navigate to the %ProgramFiles(x86)%\UiPath\RemoteRuntime\packages\uipath folder and paste the previously copied UiPath dependency version here.

Selectors are now properly generated with your current version of the UiPath.UIAutomation.Activities. Changes take effect as soon as the dependency is copied.


About UiPath Remote Runtime


Suggested Edits are limited on API Reference Pages

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