Subscribe

UiPath Studio

The UiPath Studio Guide

Installing the UiPath Remote Runtime

The UiPath Remote Runtime component is required to establish the connection between the Citrix App server and the UiPath Citrix Extension on the client machine. The Remote Runtime can be set up through the UiPathRemoteRuntime.msi or the UiPathPlatformInstaller.exe installers.
It is important that you first deploy the UiPath Remote Runtime component on all your Citrix App servers, and then install the UiPath Citrix extension on the client machine.

From the Installer

  1. Contact our Support Team to obtain the UiPathRemoteRuntime.msi installer.
  2. Run the file to install the UiPath Remote Runtime. It needs to be installed on all the Citrix server machines from which Citrix Apps are published.
  3. The changes take effect after you log off and log back in to the Windows session on the Citrix server machine.
  4. Install the UiPath Citrix extension on the client machine.

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=CitrixSupport command to install the UiPath Remote Runtime component.
  5. The changes take effect after you log off and log back in to the Windows session on the Citrix server machine.
  6. Install the UiPath Citrix extension on the client machine.

Command Line Arguments Description

CommandDescription
/qHelps you install the specified UiPath features silently, without displaying the user interface.
ADDLOCALEnables you to select what features you want to install. It currently supports only the following option:
CitrixSupport - Installs the UiPath Remote Runtime component.
APPLICATIONFOLDEREnables you to install the UiPath Remote Runtime component in a custom location.

Examples

  • UiPathRemoteRuntime.msi ADDLOCAL=CitrixSupport APPLICATIONFOLDER=C:\UiPath_RemoteRuntime - installs the Remote Runtime component in the C:\UiPath_RemoteRuntime folder.
  • UiPathRemoteRuntime.msi ADDLOCAL=CitrixSupport /quiet - silently installs the Remote Runtime component.

Installing the Java Extension

To automate Java applications published as Citrix Apps you need to also install the JavaBridge extension on the Citrix server machine, as follows:

  1. Close any running Java applications.
  2. Open an elevated Command Prompt instance.
  3. Navigate to the UiPath Remote Runtime installation folder. For the default installation folder, the command is cd C:\Program Files (x86)\UiPath\RemoteRuntime\UiPath.Common.
  4. Run the SetupExtensions.exe /Java command. The JavaBridge extension is now installed on the Citrix server machine.

You can now use Native Citrix Automation to create processes. You can still use the Image automation as before. Moreover, processes created with OCR and Image recognition activities are not affected by the Citrix App support.

Known Issues and Limitations

Installation is Only Possible on Citrix Server Machines

📘

Note:

The UiPath Remote Runtime component can only be installed on Citrix Server machines (where the Citrix Virtual Delivery Agent is installed).

If you try to install the UiPath Remote Runtime component on a machine where the Citrix Virtual Delivery Agent is not available, the installer terminates with the UiPath Remote Runtime Setup Wizard ended prematurely error message.

UiPath Remote Runtime Version Compatibility

The UiPath Remote Runtime v18.4.x is not compatible with the UiPath.UIAutomation.Activities package version 19.4.1 and above.

If you have installed the UiPath Remote Runtime v18.4.x, you can use the following UiPath.UIAutomation.Activities package versions:

  • 18.4.x
  • 19.1.0
  • 19.2.0
  • 19.3.0

If you wish to use UiPath.UIAutomation.Activities package version 19.4.1 and above, you need to upgrade to UiPath Remote Runtime v19.4.x. This is also compatible with the UiPath.UIAutomation.Activities package version 18.4.x.

Updated about a year ago

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.