UiPath Studio

The UiPath Studio Guide

Configuration Steps

Native Citrix support enables you to create automation projects that work with Citrix Apps just as if they were local applications. A few simple steps need to be performed to enable this support. Afterwards, you can use Studio on your client machine to build processes with the help of UI Automation activities and wizards.

Installation Prerequisites

The following components are required to enable Native Citrix support in UiPath:

  • Studio v2018.4 or greater on the client machine to install the UiPath Citrix Extension.
  • Citrix Receiver or Citrix Workspace on the client machine.
  • Citrix XenApp v6.5 or greater.
  • Citrix XenDesktop v7.0 or greater.

Setting up the Client

  1. In Studio, go to the Tools page from the Studio Backstage View. Available extensions are displayed there.
  2. Click the Citrix button to install the UiPath Citrix Extension. A confirmation dialogue box is displayed.
  3. Click the OK button. The extension is now installed.

The UiPath Citrix Extension can also be installed from the Command Prompt. You can find out more details on this page.

Setting up the Server

  1. Download the UiPathRemoteRuntime.msi or UiPathPlatformInstaller.exe installer. You can request either of them from here. The download link is then sent to you via email.
  2. Install UiPath Remote Runtime on the Citrix application servers that you wish to automate. More details about this process can be found here. Once the installation finishes, you’re good to go on the server side.

More details about the UiPath Remote Runtime can be found here.

Once installation finishes, you’re good to go on the server side.

Restarting Active Citrix Sessions

After you install the UiPath Remote Runtime and the UiPath Citrix Extension, you need to restart your active Citrix sessions for the changes to take effect. This is done as follows:

  1. Right-click the Citrix Receiver tray icon, and click Connection Center. The Citrix Connection Center window is displayed.
  2. Select an active session from the Connections pane, and click the Log Off button. Do this for all your active sessions.
  3. Click the Close button to confirm all the changes and close the window.



Make sure you save or backup any important data before you restart the active Citrix sessions.

Updating Project Dependencies

To use Native Citrix automation in your process, you need to add the UiPath.UIAutomation.Activities package v18.4.1 as a dependency for your project.

  1. In Studio, open the Package Manager.
  2. From the Project Dependencies pane, select the UiPath.UIAutomation.Activities package.
  3. Ensure that the selected package version is v18.4.1 or greater. If it is not, select it from the drop-down and click the Update button.
  4. Click the Save button to update your dependencies.

Congratulations, you are now ready for Native Citrix automation!



If you encounter any issues during installation, check out the Troubleshooting guide.

Updated 3 years ago

Configuration Steps

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.