8.3 Automation in Virtual Environments & UiPath Remote Runtime

8.3 Automation in Virtual Environments & UiPath Remote Runtime

Core Concept: In enterprise virtualization environments—including Citrix Virtual Apps and Desktops, VMware Horizon, Windows Virtual Desktop / Azure Virtual Desktop (AVD), and standard Remote Desktop Protocol (RDP)—target business applications execute on remote servers while only graphical display updates are transmitted back to client endpoints. UiPath Remote Runtime is an administrative component installed on the remote server that acts as an in-session automation proxy. By communicating directly with local UiPath Studio and Robot instances over the native virtual channel of the remote desktop protocol, Remote Runtime enables 100% native selector generation, deep UI tree inspection via UI Explorer, and background execution in remote sessions.

Virtual desktop infrastructure (VDI) is ubiquitous across regulated industries such as banking, insurance, and healthcare. VDI enables centralized data protection, regulatory isolation, and remote worker mobility. However, from a traditional robotic automation perspective, VDI environments present a formidable barrier: the automation robot running on the developer workstation or local runner machine cannot inspect the internal memory, process trees, or accessibility APIs of applications running inside the virtual desktop session. Without dedicated architectural intervention, the remote session remains an impenetrable "black box" of pixels.

---

1. The Challenges of Automating Virtual Environments

When automating over virtual environments without native integration tools, robots are restricted to client-side visual automation (Classic Image Matching, OCR, or Computer Vision). While Computer Vision provides excellent visual targeting, visual-only automation carries distinct operational limitations in high-volume unattended production:

• Screen Resolution and DPI Sensitivity: If a remote desktop session initializes with an unexpected resolution (e.g., 1280x720 instead of 1920x1080) or if the Windows display scaling differs between user sessions (e.g., 100% vs. 125%), pixel-based targeting can fail or require continuous recalibration.
• Network Latency Jitter: Latency fluctuations across WAN connections can cause screen rendering delays. If a robot attempts to click a visual image before the remote frame buffer renders on the client display, race conditions and timeout exceptions occur.
• Inability to Execute in Background: Pure visual automation requires the remote desktop window to remain open, maximized, in the foreground, and completely un-occluded on the client desktop. Minimizing or locking the local client window immediately halts image recognition.
• No Access to Underlying Metadata: Visual techniques cannot query underlying DOM attributes, accessibility states, hidden form values, or native application properties that make automations robust.

---

2. UiPath Remote Runtime Architecture

UiPath Remote Runtime solves the VDI challenge by shifting element discovery and execution inside the remote session itself.

Architectural Components

The Remote Runtime architecture consists of three interconnected layers:

1. The Client Workstation (Local Host):
   • UiPath Studio / UiPath Robot: Executes the automation workflow.
   • UiPath.UIAutomation.Activities Package: The automation library generating and executing UI queries.
   • Local Protocol Extension: The matching UiPath extension installed on the client machine: UiPath Extension for Citrix, for Windows Remote Desktop and Apps, for VMware Horizon, or for Amazon WorkSpaces. It works with the local client software (such as Citrix Workspace app, VMware Horizon Client, or the Windows Remote Desktop client mstsc.exe).
2. The Virtual Communication Channel:
   • Communication between the local client and the remote server does not rely on external TCP/IP network sockets or HTTP web services. Instead, it utilizes the native, encrypted Virtual Channel embedded within the virtualization protocol:
     • Citrix: ICA / HDX virtual channel.
     • VMware Horizon: VMware Horizon Virtual Channel.
     • Microsoft RDP / AVD: Remote Desktop Dynamic Virtual Channel (DVC).
   • Zero Port Security Advantage: Because communication multiplexes over the existing, authenticated VDI connection, organizations do not need to open any firewall ports (such as port 80, 443, or 8080) between client machines and the remote server.
3. The Remote Server / VDI Host:
   • UiPath Remote Runtime (UiPathRemoteRuntime.exe): Installed on the remote desktop host, Citrix server, or master VDI image. The installer adds a Task Scheduler entry so the process starts at every user login, for every user on the server.
   • Installed versions: All installed Remote Runtime versions are listed under %ProgramFiles(x86)%\UiPath\RemoteRuntime\packages\uipath.
   • Target Applications: Local software running on the remote server (e.g., SAP GUI, Oracle ERP, desktop CRM, web browsers).

+-----------------------------------------------------------------------------------------+
|                                 REMOTE RUNTIME ARCHITECTURE                             |
|                                                                                         |
|  [LOCAL CLIENT WORKSTATION]                                                             |
|  +-----------------------------------------------------------------------------------+  |
|  | UiPath Studio / UiPath Robot                                                      |  |
|  | UiPath.UIAutomation.Activities Package                                            |  |
|  | Local Extension (Citrix Workspace / mstsc.exe / VMware Horizon Client)             |  |
|  +-----------------------------------------------------------------------------------+  |
|                                          │                                              |
|                                          ▼                                              |
|                      [SECURE PROTOCOL VIRTUAL CHANNEL]                                  |
|                      - Citrix ICA / HDX Virtual Channel                                 |
|                      - Microsoft RDP Dynamic Virtual Channel (DVC)                      |
|                      - VMware Horizon Virtual Channel                                   |
|                      (Multiplexed inside existing VDI session — No Open Firewall Ports)  |
|                                          │                                              |
|                                          ▼                                              |
|  [REMOTE VDI / TERMINAL SERVER]                                                         |
|  +-----------------------------------------------------------------------------------+  |
|  | UiPath Remote Runtime (UiPathRemoteRuntime.exe, started at each user login)       |  |
|  | Installed versions listed under ...\UiPath\RemoteRuntime\packages\uipath         |  |
|  |                                                                                   |  |
|  | Direct OS Accessibility Hooks:                                                    |  |
|  | ├── Microsoft UI Automation (UIA)                                                  |  |
|  | ├── Microsoft Active Accessibility (MSAA)                                         |  |
|  | ├── Java Access Bridge (JAB)                                                      |  |
|  | └── Chrome / Edge Web Extensions                                                  |  |
|  |                                                                                   |  |
|  | Target Applications: [SAP WinGUI] [Java Client] [Chrome/Edge Web] [WPF Desktop]   |  |
|  +-----------------------------------------------------------------------------------+  |
+-----------------------------------------------------------------------------------------+

---

3. Native Selector Extraction in Remote Sessions

When UiPath Remote Runtime is active, the entire development and execution experience transforms from flat-image guessing to full native targeting:

UI Explorer Over Virtual Desktops

A developer running UiPath Studio on their local machine can open UI Explorer, click Indicate Element, and move their cursor directly into the remote Citrix or RDP window. Instead of highlighting the entire remote desktop container as a single giant window, UI Explorer reaches across the virtual channel, inspects the remote operating system's accessibility tree, and highlights the precise button, input field, or table cell inside the remote application.

Full Selector Richness

The generated selectors are standard, rich, multi-attribute XML strings identical to those generated for local desktop applications:

The generated selectors use the same attributes you would see for a local application, because Remote Runtime reads the remote application's UI tree and passes it to the extension.

Developers can leverage:

• Strict Selectors: Exact control IDs, automation names, and hierarchical tags.
• Fuzzy Selectors: Matching attributes with configurable tolerance.
• Wildcards (* and ?): Dynamic handling of shifting window titles or session IDs.
• Relative Anchors: Relational visual and selector-based anchoring to static labels.

Input Methods in Remote Sessions

Because the element is identified inside the remote session, input modes such as Simulate and Window Messages can be used where the remote application supports them, instead of relying only on image clicks. That also reduces the dependence on the remote window being maximized and in focus.

---

4. Installation, Configuration & Compatibility Matrix

Deploying UiPath Remote Runtime requires coordination between the local developer/robot environment and the remote server infrastructure:

Installing Remote Runtime on the Server

1. Download UiPathRemoteRuntime.msi from the Customer Portal's Product Downloads or from the Automation Cloud Resource Center.
2. Install it with administrator rights on every Citrix application server, VMware Horizon machine, Remote Desktop machine, or Amazon WorkSpaces desktop that runs the target applications. A silent install looks like this:

   UiPathRemoteRuntime.msi ADDLOCAL=RemoteRuntime,RemoteRuntimeTask /quiet
   

   RemoteRuntimeTask adds the Task Scheduler entry that starts UiPathRemoteRuntime.exe at user login.
3. Log off from the Citrix, Horizon, RDP, or WorkSpaces session on the client machine and log back in so the change takes effect.

Enabling Local Extensions

On the local machine running Studio or the Robot:

• Open Studio and navigate to Home > Tools > UiPath Extensions.
• Install the specific extension matching your virtualization protocol: Citrix, Windows Remote Desktop and Apps, VMware Horizon, or Amazon WorkSpaces.
• Restart the virtualization client software (e.g., Citrix Workspace or mstsc.exe) to initialize the virtual channel driver.

The UIAutomation Dependency

Remote Runtime depends on the version of the UiPath.UIAutomation.Activities package, not on the Studio or Robot version. UiPath's rule is:

• The Remote Runtime on the remote machine must be at the version of the latest UIAutomation package you use in your projects.
• It is backward compatible, so older UIAutomation package versions keep working with a newer Remote Runtime.

---

5. Enterprise Security, Governance & Troubleshooting

High-Density and Multi-Session Environments

In enterprise environments where multiple human users and software robots share a single Windows Server via Remote Desktop Services (RDS) or Citrix Virtual Apps:

• UiPath Remote Runtime operates in a multi-session architecture.
• A master background coordinator manages virtual channel endpoints, while an isolated instance of UiPathRemoteRuntime.exe executes inside each individual Windows user session.
• Process isolation is strictly maintained: a robot executing in Session 2 cannot view, intercept, or interact with applications running in Session 3, ensuring complete tenant and user data security.

Troubleshooting Virtual Channel Connectivity

If UI Explorer fails to extract native selectors and continues to select the entire remote desktop container as a single window, developers follow a standardized diagnostic checklist:

1. Check the Citrix virtual channel allow list:
   • Starting with Citrix Virtual Apps and Desktops 7 2109, custom virtual channels are blocked by default. Add the UiPath channel to the allow list policy: UIPCTX,C:\Program Files (x86)\UiPath\RemoteRuntime\UiPathRemoteRuntime.exe.
2. Verify Remote Runtime Process:
   • Open Windows Task Manager inside the remote VDI session and verify that UiPathRemoteRuntime.exe is running under the active user account.
3. Compare versions:
   • Confirm that the Remote Runtime version is at least the UIAutomation package version used by the project.
4. Check the client extension:
   • Confirm that the matching UiPath extension is installed on the client machine, and restart the client software after installing it.
5. Review Windows Event Logs:
   • Check the Application event log in Windows Event Viewer on both client and server for UiPathRemoteRuntime informational and error entries.