Subscribe

UiPath Installation and Upgrade

The UiPath Installation and Upgrade Guide

Installing the Robot

Prerequisites

Before you proceed with installing the Robot, we highly recommend checking out the compatibility matrix, as well as the Hardware and Software requirements.

GUI Installation

The Robot can be deployed on a machine using one of the following installers:

  • UiPathPlatformInstaller.exe
  • UiPathStudio.msi
  • UiPathStudioSetup.exe

📘

Note:

It is NOT supported to have both the User Mode installer (UiPathStudioSetup.exe) and the Windows installer (UiPathStudio.msi) versions of Studio and the Robot on the same machine.

The installation artifacts are provided when you first purchase Robot or they can be provided by your customer success manager or our support team.

After reading and accepting the terms of the License Agreement, you can proceed with the installation.

UiPathPlatformInstaller.exe

The UiPathPlatformInstaller.exe file allows you to install the Robot, Studio, and Orchestrator. Administrator rights are required for installation. Please note that this file does not accept command line arguments.

By default, the Robot is installed in the C:\Program Files (x86)\UiPath\Studio directory, but you can change it by adding a custom path in the Installation Path field.

From the Products section, you need to choose the component you want to install.

  • Install UiPath Robot Only - Recommended if you only need to execute automation projects on that machine.
  • Install UiPath Studio + Robot - The default option. Recommended if you want to both design and execute automation projects on that machine.

From the Installation Type section, you need to choose the type of Robot you want to install.

  • Service Mode - recommended for unattended automation scenarios and large-scale platform deployments, and runs with the same rights as the user under which it is registered.
  • User Mode - recommended for attended automation scenarios, and runs under the user that started it, and has the exact rights as that particular user.
    :information-source: Note: To enable interactive sign-in, install the Robot in user mode. When the Robot is installed in service mode, you can connect to Orchestrator using the machine key.

Additional Options

The installation can be further customized with some additional options.

  • Other Settings:
    • Enable Signed Execution - If selected, only signed packages can be installed and executed. Read more about signing and verifying packages.
    • Disable Secured XAMLs - If selected, no security for process .xaml files is used, meaning users are allowed to read and modify the process files and logic.
    • Disable Telemetry - If selected, UiPath will not collect any usage or performance data. Read more about Opting Out of Telemetry.

In the Regular tab, the following options are available:

  • License Code - Optional. Allows you to add your stand-alone trial or enterprise license key, if available. If left blank, you are prompted to activate Studio when it is first launched.
  • Orchestrator Connection String - Provide the connection string to automatically connect your Robot(s) to Orchestrator. More details here.
  • Automatically Start Robot in Tray - If selected, the Robot is launched automatically after the installation is completed.
  • Use legacy Robot Tray - If selected, deploys the Robot Tray (legacy) instead of UiPath Assistant.
  • StudioX Excel Addin - Select to also install the integration addin for StudioX and Microsoft Excel.

In the Advanced tab, the following options are available:

UiPathStudio.msi

The UiPathStudio.msi file allows you to install the Robot and Studio. Administrator rights are required for installation. Command Line Arguments can be used with this file.

The installer file name varies depending on the type of deployment and license:

  • UiPathStudio.msi - Obtained after purchasing the on-premises UiPath Platform.
  • UiPathStudioCloud.msi - Obtained after purchasing UiPath Automation Cloud.
  • UiPathStudioOnPremTrial.msi - Obtained as part of a trial of the on-premises UiPath Platform.
  • UiPathStudioCloudTrial.msi - Obtained as part of a trial of UiPath Automation Cloud.

This file installs the Robot in the C:\Program Files (x86)\UiPath\Studio directory. It can only be changed with command line arguments.

  1. Double-click the installer.

  2. Select the option to install:

    • Studio - Installs UiPath Studio, Assistant, and the user-mode Robot for creating and testing automations.
    • Assistant - Installs UiPath Assistant and the user-mode Robot for running attended automations.
    • Unattended Robot - Installs the service-mode Robot for running scheduled unattended automations (via Orchestrator) and UiPath Assistant for troubleshooting.

    :information-source: Note: To enable interactive sign-in, install the Robot in user mode. When the Robot is installed in service mode, you can connect to Orchestrator using the machine key.

  1. Read and accept the Terms of use. Please note that by accepting the aforementioned terms of use, you implicitly accept the terms of use of UiPath activity packages and their dependencies.
    • To install using the default settings preselected for your choice in the previous step, click Install and proceed to step 5.
    • To customize the installation, click Advanced to proceed to step 4.
  1. (Optional) Customize the installation using the following Advanced options, and then click Next:

    • UiPath Studio - Installs Studio. This option is enabled if you selected the Studio option in step 2. If you only want to install the Robot, click the buttonbutton button next to the UiPath Studio feature and select the Entire feature will be unavailable option.

      • StudioX Excel Add-in - Installs the Excel Add-in for StudioX. This option is disabled by default.
    • UiPath Robot - Installs the Robot on the local hard drive with the chosen options. If you want to install the Robot and all its sub-features, click the buttonbutton button next to the UiPath Robot feature and select the Entire feature will be installed on the local hard drive option.
      The following options are available:

      • Register as Windows Service - Specifies how to install the Robot. If you selected the Unattended Robot option in step 2, this option is enabled and the Robot is installed in service mode. Otherwise, the option is disabled and the Robot is installed in user mode.
      • Install local activities feed - The local activities feed is created by default in the C:\Program Files (x86)\UiPath\Studio\Packages folder. This option is enabled by default. Having the activities packages locally is useful if you do not intend to connect your Robot to Orchestrator, or you want to have better control of the activities used in an automation project. Check out the list of default activities packages here.
      • Automatically start client - Starts the Robot tray at Windows startup. This option is disabled by default.
      • Use legacy Robot Tray - Installs and uses the legacy Robot Tray, instead of the UiPath Assistant. This option is disabled by default.
      • UiPath extension for Java - Installs the UiPath extension for Java for a better integration and automation in regards to Java applications. This option is disabled by default. Please note that installing the Java Bridge may cause the installation to last longer than usual. This option installs the Java Bridge only in the system drive Java folders. If you are using custom JRE not located on the system drive, you have to manually install it with the ScreenScrapeJavaSupport Tool.
      • UiPath extension for Chrome - Installs the UiPath extension for Chrome needed for automating processes in Chrome. This option is disabled by default.
      • UiPath extension for Microsoft Edge Chromium-based - Installs the UiPath extension for Microsoft Edge Chromium-based versions v79 or higher. This option is disabled by default. Read more about this here.
      • JavaScript Add-on for Robot - Installs the JavaScript add-on for the Robot. This option is enabled by default. Read more about this here.
      • UiPath extension for Citrix - Installs the UiPath extension for Citrix for automating Citrix Apps natively. This option is disabled by default.

      To install an additional feature, click the buttonbutton button next to it and select the Will be installed on the local hard drive option.

  1. Click Install, wait for the installation to complete, and then click Finish.

UiPathStudioSetup.exe

The UiPathStudioSetup.exe file enables you to install the Community Edition of Studio with a user-mode Robot. The installation path is %localappdata%\UiPath, and all other advanced options are already configured to help you get Studio up and running right away. When the installation completes, you proceed to activating and getting started with Studio.

📘

Note:

The UiPathStudioSetup.exe installer does not require administrator permissions, meaning that it is installed per user and is limited to the rights that the user has.

Command Line Installation

Studio and Robot can also be installed using command line arguments with the UiPathStudio.msi file. Administrator rights are required for command line installation.

Installing Unattended Robots

In order to install Unattended Robots, the user under which the Robot runs requires the following:

  • To be added to the Remote Desktop Users local group, in Computer Management.

📘

Important!

You can add the Remote Desktop Users group to all these rights, as you previously added the user to this group.

📘

Note:

Usage data collection is enabled by default in Studio and the Robot. Learn more about Opting out of Telemetry.

Updated about a month ago


Installing the Robot


Suggested Edits are limited on API Reference Pages

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