Extension for Citrix

By installing the Extension for Citrix you are capable of automating Citrix Apps natively. It can be installed from Studio or the Command Prompt.

Note: You need to install the Citrix client (Citrix Receiver or Citrix Workspace) per machine to be able to install the UiPath Extension for Citrix.

From UiPath Studio

Open Studio.
Navigate to Home > Tools > UiPath Extensions.
Select Citrix > Install. A confirmation dialog box is displayed.
Restart all your Citrix applications for the changes to take effect.

The UiPath Extension for Citrix is now installed to the Citrix install directory.

From the Command Prompt

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 UiPath installation folder (cd C:\Program Files\UiPath\Studio\UiPath for per-machine installations, cd %localappdata%\Programs\UiPath\Studio\UiPath for per-user installations).
Use the SetupExtensions /CitrixClient command to install the extension. A confirmation dialog box is displayed.
Restart all your Citrix applications for the changes to take effect. The UiPath Extension for Citrix is now installed.
Note: To generate native selectors for Citrix technology, you also need to deploy the UiPath Remote Runtime component on all your Citrix Application servers, as explained on this page. The UiPathRemoteRuntime.msi installer is obtained by requesting it here.

Uninstalling the UiPath Extension for Citrix

From Studio

Open Studio.
Navigate to Home > Tools > UiPath Extensions.
Select Citrix > Uninstall, and confirm your choice.

The UiPath Extension for Citrix is now uninstalled.

From the Command Line

Close all your running Citrix Apps.
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 UiPath installation folder (cd C:\Program Files\UiPath\Studio\UiPath for per-machine installations, cd %localappdata%\Programs\UiPath\Studio\UiPath for per-user installations).
Use the SetupExtensions /CitrixClient /uninstall command to uninstall the extension. A confirmation dialog box is displayed.

The UiPath Extension for Citrix is now uninstalled.

Troubleshooting

This page explains how to fix issues you might encounter when running automation in Citrix environments.

Interactive Selection in Citrix Apps Freezes And Nothing Is Selected

Observed Behavior

After you install the UiPath Extension for Citrix and try to select UI elements from a Citrix App, interactive selection freezes for one minute, and then nothing is selected.

Cause

This happens if the UiPath Remote Runtime is not running in the Citrix App session.

Solution

Check if the UiPathRemoteRuntime.msi is installed on the Citrix application server from which the Citrix App is opened.
On the Citrix application server, check if the UiPathRemoteRuntime.exe process is running. If the UiPathRemoteRuntime.msi is installed, then the process is started automatically on the Citrix App session login.

Note: If you can not install the UiPathRemoteRuntime.msi on the Citrix application servers, it is recommended to uninstall the UiPath Extension for Citrix from the client machine, as described here.

Could Not Copy Over File "C:\Program Files (x86)\Citrix\ICA Client\UIPathPluginCitrix.dll". It Is Being Used by Another Process.

Observed Behavior

When you try to install the UiPath Extension for Citrix, the following error is displayed:

Cause

This occurs when the UiPath Extension for Citrix is already installed and an open Citrix App is using it.

Solution

Close all your active Citrix App sessions, as described here and then try to install the UiPath Extension for Citrix again.

Could Not Read Citrix Registry Key: 'SOFTWARECitrixInstallICA Client' Value: 'InstallFolder'

Observed Behavior

When you try to install the UiPath Extension for Citrix, the following error is displayed:

Cause

This error message is displayed when the Citrix Receiver is not installed. It is also displayed if the Citrix Receiver for Universal Windows Platform is installed.