- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- Types of Workflows
- Control Flow
- File Comparison
- Automation Best Practices
- Source Control Integration
- Debugging
- Logging
- The Diagnostic Tool
- Workflow Analyzer
- About Workflow Analyzer
- ST-NMG-001 - Variables Naming Convention
- ST-NMG-002 - Arguments Naming Convention
- ST-NMG-004 - Display Name Duplication
- ST-NMG-005 - Variable Overrides Variable
- ST-NMG-006 - Variable Overrides Argument
- ST-NMG-008 - Variable Length Exceeded
- ST-NMG-009 - Prefix Datatable Variables
- ST-NMG-011 - Prefix Datatable Arguments
- ST-NMG-012 - Argument Default Values
- ST-NMG-016 - Argument Length Exceeded
- ST-NMG-017 - Class name matches default namespace
- ST-DBP-002 - High Arguments Count
- ST-DBP-003 - Empty Catch Block
- ST-DBP-007 - Multiple Flowchart Layers
- ST-DPB-010 - Multiple instances of [Workflow] or [Test Case]
- ST-DBP-020 - Undefined Output Properties
- ST-DBP-021 - Hardcoded Timeout
- ST-DBP-023 - Empty Workflow
- ST-DBP-024 - Persistence Activity Check
- ST-DBP-025 - Variables Serialization Prerequisite
- ST-DBP-026 - Delay Activity Usage
- ST-DBP-027 - Persistence Best Practice
- ST-DBP-028 - Arguments Serialization Prerequisite
- ST-USG-005 - Hardcoded Activity Arguments
- ST-USG-009 - Unused Variables
- ST-USG-010 - Unused Dependencies
- ST-USG-014 - Package Restrictions
- ST-USG-020 - Minimum Log Messages
- ST-USG-024 - Unused Saved for Later
- ST-USG-025 - Saved Value Misuse
- ST-USG-026 - Activity Restrictions
- ST-USG-027 - Required Packages
- ST-USG-028 - Restrict Invoke File Templates
- ST-USG-032 - Required Tags
- ST-USG-034 - Automation Hub URL
- Variables
- Arguments
- Imported Namespaces
- Coded automations
- Introduction
- Registering custom services
- Before and After contexts
- Generating code
- Generating coded test case from manual test cases
- Trigger-based Attended Automation
- Recording
- UI Elements
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Automating Citrix Technologies
- RDP Automation
- VMware Horizon Automation
- Salesforce Automation
- SAP Automation
- macOS UI Automation
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- Extensions
- About extensions
- SetupExtensions tool
- UiPathRemoteRuntime.exe is not running in the remote session
- UiPath Remote Runtime blocks Citrix session from being closed
- UiPath Remote Runtime causes memory leak
- UiPath.UIAutomation.Activities packages and UiPath Remote Runtime versions mismatch
- The required UiPath extension is not installed on the remote machine
- Screen resolution settings
- Chrome Group Policies
- Cannot communicate with the browser
- Chrome extension is removed automatically
- The extension may have been corrupted
- Check if the extension for Chrome is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and Incognito mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Chrome
- Chrome Extension on Mac
- Edge Group Policies
- Cannot communicate with the browser
- Edge extension is removed automatically
- The extension may have been corrupted
- Check if the Extension for Microsoft Edge is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and InPrivate mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Edge
- Extension for Safari
- Extension for VMware Horizon
- Extension for Amazon WorkSpaces
- SAP Solution Manager plugin
- Excel Add-in
- Test Suite - Studio
- Troubleshooting
UiPath Remote Runtime
UiPath Remote Runtime is a component which enables the communication between a remote desktops or applications, such as Citrix Virtual Apps, and certain UiPath extensions. These include the UiPath Extension for Citrix, for Windows Remote Desktop and Apps, for VMware Horizon, and for Amazon WorkSpaces. It gathers information about targeted UI elements of remote applications and passes this data to the corresponding extension. This allows for native generation of selectors in the UI Explorer.
Starting with Citrix Virtual Apps and Desktops 7 2109, all custom virtual channels are blocked by default. This prevents the UiPath Remote Runtime from working correctly. To solve this issue the UiPath virtual channel must be added to the allow list policy:
UIPCTX,C:\Program Files
(x86)\UiPath\RemoteRuntime\UiPathRemoteRuntime.exe
The Remote Runtime component was granted a Citrix Ready certification, making it a trusted, effective solution for working with Citrix technologies.
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 Application servers – communicates with the UiPath Extension for Citrix.
- On VMware Horizon virtual machines – communicates with the UiPath Extension for VMware Horizon.
- On Windows Remote Desktop machines – communicates with the UiPath Extension for Windows Remote Desktop and Apps.
- On Amazon WorkSpaces machines – communicates with the UiPath Extension for Amazon WorkSpaces.
The corresponding UiPath extensions must be installed on the client machine.
UiPathRemoteRuntime.msi
installer can be
downloaded from:
- Product Downloads in the UiPath Customer Portal.
- Resource Center in the UiPath Automation Cloud. To access Resource Center, log in to your Automation Cloud Organization and click the Help button on the navigation bar.
UiPathRemoteRuntime.exe
process is started at every user login, for every user logged in to the remote
server.
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.
The UiPath Remote Runtime has the same requirements as the UiPath Robot. See the full list of requirements in Hardware and Software Requirements.
- Run the
UiPathRemoteRuntime.msi
file to install the UiPath Remote Runtime. It needs to be installed on all the Citrix Application servers, VMware Horizon virtual machines, Windows Remote Desktop machines, or the Amazon WorkSpaces virtual desktops where the target applications for automation run. - Log off from the current Citrix window, VMware Horizon window, RDP session, or the Amazon WorkSpaces virtual desktop on the client machine and log back in. This is required so that your changes take effect.
- Install either the UiPath Extension for Citrix, for VMware Horizon, for Windows Remote Desktop and Apps, or for Amazon WorkSpaces on the client machine, depending on the technology on which you want to create your automation projects.
You can also choose to deploy the extension for Java, Chrome, Microsoft Edge, Firefox, Microsoft Remote Desktop and Apps, VMware, Citrix, and Amazon WorkSpaces from the installer, as well as the Task Scheduler entry, by selecting the corresponding options, as depicted below:
UiPathRemoteRuntime.msi
installer and choose the corresponding option.
UiPathRemoteRuntime.msi
requires administrator rights.
- Click the Windows Start button and type
cmd
in the search field. - Right click on Command Prompt and run it as administrator.
- Change the directory to the
UiPathRemoteRuntime.msi
folder (for example:cd C:\Tools\Studio
). - Use the
UiPathRemoteRuntime.msi ADDLOCAL=RemoteRuntime,RemoteRuntimeTask
command to install the UiPath Remote Runtime component. - Log off from the current Citrix window, VMware Horizon window, RDP session, or the Amazon Workspaces virtual desktop on the client machine and log back in. This is required so that your changes take effect.
- Install either the UiPath Extension for Citrix, for VMware Horizon, for Windows Remote Desktop and Apps, or for Amazon WorkSpaces on the client machine, depending on the technology on which you want to create your automation projects.
Additionally, you can use the following options to install extensions:
UiPathRemoteRuntime.msi ADDLOCAL=RemoteRuntime,RemoteRuntimeTask,JavaBridge,ChromeExtension,EdgeChromium,CitrixClient,FirefoxExtension,WindowsRdpExtension,VMwareExtension,AmazonWorkSpacesClient
– installs the Remote Runtime component, the Task Scheduler entry, and the extensions for Java, for Chrome, for Microsoft Edge, for Citrix, for Firefox, for Microsoft Remote Desktop and Apps, for VMware Horizon, and for Amazon WorkSpaces.
/quiet
parameter:
UiPathRemoteRuntime.msi ADDLOCAL=RemoteRuntime,RemoteRuntimeTask /quiet
- silently installs the Remote Runtime component and the Task Scheduler entry.
APPLICATIONFOLDER
option:
UiPathRemoteRuntime.msi APPLICATIONFOLDER="D:\UiPathRemoteRuntime" ADDLOCAL=RemoteRuntime,RemoteRuntimeTask /quiet
– silently installs the Remote Runtime component inD:\UiPathRemoteRuntime
, and adds the Task Scheduler entry.
You can now create processes to automate on Citrix Virtual Apps and Desktops, VMware Apps, Amazon WorkSpaces virtual 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.
UiPathRemoteRuntime.msi
installer, which you can choose to disable,
if necessary.
UiPathRemoteRuntime.exe
process using another
method, like a startup script.
The UiPath Remote Runtime has a dependency on the version of the UiPath.UIAutomation.Activities package, not on the version of UiPath Studio/Robot.
The Remote Runtime installed on a remote machine must have the version of the latest UI Automation package you want to use in your projects, and it is compatible with the previous UI Automation releases (it is backwards compatible).
The UiPath.UIAutomation.Activities package and the UiPath Remote Runtime have the same UiPath driver dependency. For each UI Automation package released version, a download link for the UiPath Remote Runtime component with the same version number is provided.
https://download.uipath.com/versions/23.10.8/UiPathRemoteRuntime.msi
.
UiPathRemoteRuntime.msi
installer from:
- Product Downloads in the UiPath Customer Portal.
- Resource Center in the UiPath Automation Cloud. To access the Resource Center, you need to log in your Automation Cloud Organization, click the Help button on the toolbar and choose Resources > Downloads.
- Or you can request it through the Contact Technical Support page.
%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.
%ProgramFiles(x86)%\UiPath\RemoteRuntime\packages\uipath
folder.
UiPathRemoteRuntime.msi
installer contains the latest UiPath dependency, as well as the latest supported Long Term Support (LTS) UiPath dependencies.
The table below enlists the dependencies between the UiPath.UIAutomation.Activities package and UiPath Remote Runtime:
UI Automation package version |
UiPath Remote Runtime build number |
UiPath driver dependency |
UI Automation compatible versions for UiPath Remote Runtime |
---|---|---|---|
24.10.7 | 24.10.108.16096 | 24.10.108.16096 |
24.10.7 23.10.13 23.4.11 22.10.9 22.4.11 21.10.10 20.10.15 |
23.10.13 |
23.10.97.53968 |
23.10.97.53968 |
23.10.13 23.4.11 22.10.10 22.4.12 21.10.10 20.10.15 |
23.4.11 |
23.10.86.3201 |
23.4.81.50665 |
23.10.11 23.4.11 22.10.10 22.4.12 21.10.10 20.10.15 |
22.10.10 | 23.4.67.63183 | 22.10.67.59238 |
23.4.10 22.10.10 22.4.12 21.10.10 20.10.15 |
22.4.12 | 23.4.67.63183 | 22.4.67.58669 |
23.4.10 22.10.10 22.4.12 21.10.10 20.10.15 |
21.10.10 | 23.4.67.63183 | 23.4.67.63183 |
23.4.10 22.10.10 22.4.12 21.10.10 20.10.15 |
20.10.15 | 23.4.67.63183 | 20.10.8676.29744 |
23.4.10 22.10.10 22.4.12 21.10.10 20.10.15 |
19.11.5 |
22.4.43.27553 |
19.10.7601.15369 |
22.4.7 21.10.7 20.10.12 19.11.5 18.4.8 |
18.4.8 |
22.4.43.27553 |
10.0.7772.19184 |
22.4.7 21.10.7 20.10.12 19.11.5 18.4.8 |
UiPathRemoteRuntime.msi
file Properties, in the Details tab, in the Comments field.
The UiPath.UIAutomation.Activities package is incompatible
with the UiPath Remote Runtime running on the server
.
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 Application server, VMware virtual machine, the Remote Desktop machine, or the Amazon WorkSpaces virtual desktop,
For example, if you want to build an automation project using the UiPath.UIAutomation.Activities package version 23.10.8, you need to copy the corresponding UiPath dependency from the client machine (where Studio/Robot is installed) on the Citrix Application server, VMware virtual machine, the Remote Desktop machine, or the Amazon WorkSpaces virtual desktop.
This is done as follows:
- On the client machine (where Studio is installed), navigate to the
%UserProfile%\.nuget\packages\uipath
folder. All installed UiPath dependencies are located here. - Copy the folder with the version which
corresponds to the UiPath.UIAutomation.Activities package you want to use.
You can view the list of dependencies shipped with the
UiPath.UIAutomation.Activities package on the About UIAutomation Activities
page or by checking the package dependencies as described in
Side-by-side support.
- On the Citrix Application server, VMware virtual
machine, the Remote Desktop machine, or the Amazon WorkSpaces virtual desktop,
navigate to the
%ProgramFiles(x86)%\UiPath\RemoteRuntime\packages\uipath
folder and paste the previously copied UiPath dependency version here.- For example, for UiPath.UIAutomation.Activities version 23.10.8, the corresponding UiPath dependency is 23.10.71.64399. This is the name of the folder you need to copy from the Studio/Robot machine to the remote machine.
Selectors are now properly generated with your current version of the UiPath.UIAutomation.Activities. Changes take effect as soon as the dependency is copied.
The Remote Runtime Dependencies described above are required both for the design time and execution time.
When you start a process, the Robot sends out the necessary commands to the extension for Citrix or Windows Remote Desktop via an RPC channel. This information package also contains details about the version of the UI Automation 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 Application servers or Remote Desktop machine.
Depending on the version of the UI Automation package with which the process was built, the UiPath Remote Runtime component instructs the Robot Executor which driver to use.
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.
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.
If you jump through multiple remote connections (RDP, Citrix, or VMware) to reach a destination remote computer, where the automation is developed, you must install Remote Runtime on each intermediary remote computer, not just on the target one. For more details, check the Configure a multi-hop connection page.
- About UiPath Remote Runtime
- Hardware and software requirements
- Installing the UiPath Remote Runtime
- From the Installer
- From the Command Prompt
- Task Scheduler
- UI Automation dependency
- Side-by-side support
- Adding Remote Runtime dependencies
- Remote Runtime architecture
- Multiple ICA channels
- Data transfer and bandwidth considerations
- Multiple remote connections