UiPath Studio Guide

Installing the UiPath Remote Runtime

The UiPath Remote Runtime component is required to establish the connection between an application or desktop server and a corresponding UiPath extension installed on a client machine. This way, selectors are natively generated on the client machine where Studio is installed, without having to rely on OCR and image recognition activities.

You can install the UiPath Remote Runtime component 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.

Please note that the corresponding UiPath extensions need to be installed on the client machine.

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.

There are a couple of ways in which you can install the component, as explained below:

From the Installer

  1. Run the file to install the UiPath Remote Runtime. It needs to be installed on all the Citrix servers or Windows Remote Desktop machine on which you want to create your automation projects.
  2. Log off from the current Citrix window or RDP session on the client machine and log back in. This is required so that your changes take effect.
  3. Install either the UiPath Citrix or Windows Remote Desktop extension on the client machine, depending on the technology on which you want to create your automation projects.

You can also choose to deploy the Java Bridge and Chrome extension from the installer, by selecting the corresponding options, as depicted below:

From the Command Prompt

  1. Click the Windows Start button and type cmd in the search field.
  2. Right click on Command Prompt and run it as administrator.
  3. Change the directory to the UiPathRemoteRuntime.msi folder (For example: cd C:\Tools\Studio).
  4. Use the UiPathRemoteRuntime.msi ADDLOCAL=RemoteRuntime command to install the UiPath Remote Runtime component.
  5. Log off from the current Citrix window or RDP session on the client machine and log back in. This is required so that your changes take effect.
  6. Install either the UiPath Citrix or Windows Remote Desktop extension on the client machine, depending on the technology on which you want to create your automation projects.

Additionally, you can use the JavaBridge and ChromeExtension arguments to install the Java Bridge and Chrome Extension, as exemplified below:

  • UiPathRemoteRuntime.msi ADDLOCAL=RemoteRuntime,JavaBridge - installs the Remote Runtime component and the Java Bridge.
  • UiPathRemoteRuntime.msi ADDLOCAL=RemoteRuntime,ChromeExtension - installs the Remote Runtime component and the Chrome Extension.
  • UiPathRemoteRuntime.msi ADDLOCAL=RemoteRuntime,JavaBridge,ChromeExtension - installs the Remote Runtime component, the Java Bridge, and the Chrome Extension.

You can also perform a silent installation by using the /quiet parameter:

  • UiPathRemoteRuntime.msi ADDLOCAL=RemoteRuntime,JavaBridge,ChromeExtension /quiet - silently installs the Remote Runtime component, the Java Bridge, and the Chrome Extension.

You can now create processes to automate on Citrix Virtual Apps and Desktops, as well as over RDP connections just as you would on a standard machine. Because of the corresponding extensions, OCR and Image recognition activities are no longer required to properly identify UI elements. Instead, elements are natively recognized and can be used with any activity.


Installing the 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.