Robot User Guide

Last updated Oct 25, 2024

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.

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.
To have the following user rights, in the Local Computer Policy:
- Allow log on locally
- Access this computer from the network - only for HD Unattended Robots.
- Allow log on through Remote Desktop Services - only for HD Unattended Robots.
  
  Note: 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.

GUI Installation

The UiPath.Studio.msi installer enables you to install Studio, StudioX, Robot, and Assistant. Use the Enterprise Edition of the installer if your organization purchased the UiPath Platform or you are installing as part of a trial of the UiPath Platform. If you are an Automation Cloud for community user, use the Community Edition of the installer.

The installer can be downloaded from the Resource Center in UiPath Automation Cloud or provided by your customer success manager or the support team. To request a trial, go to https://cloud.uipath.com/portal_/register.

By default, a 64-bit version of the installer is available (UiPathStudio.msi). There is a single installer, but the file name differs depending on the type of deployment and license:

For the Enterprise Edition, the installer is named as follows:
- 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.
For the Community Edition, the installer is named UiPath.StudioCommunity.msi.

For the Enterprise Edition, a 32-bit version that can only be installed on 32-bit operating systems is also available (-x86 is appended to the file name).

If you are running the installer to update from an older version:

Use the 64-bit version of the installer (UiPathStudio.msi) to update existing 32-bit and 64-bit installations on 64-bit operating systems.
Use the 32-bit version of the installer (UiPathStudio-x86.msi) to update existing installations on 32-bit operating systems.

For more information, see Updating the Robot.

About Quick and Custom Installation

You can perform the installation for the current user in a default configuration by selecting the Quick option in the installation wizard (no administrator privileges required) or configure the installation by selecting the Custom option (requires administrator privileges).

Note:

If you are using Microsoft Windows Server, per-user installations may not be completed successfully. If an error occurs stating that policies have been set to prevent the installation, you can do one of the following if you are an administrator on the machine:

Open the Registry Editor, and then, in the registry key HKLM\Software\Policies\Microsoft\Windows\Installer, configure the policy DisableMSI = 0 to enable the Windows installer for all applications.
Perform the installation per machine by installing using the Custom option.

See the following table for more information about the differences and similarities between quick and custom installations.

	Quick	Custom
Supported robot installation types	User mode	User mode for per-user installations. User mode or service mode for per-machine installations `1`
Administrator privileges required for the installation	No	Yes
Installation available for	User who performs the installation	User who performs the installation or all users on the machine
Installation directory	%LocalAppData%\Programs	A custom location can be selected. The default location is: %LocalAppData%\Programs for per-user installations. %ProgramFiles% for per-machine installations.
Activation with Community license	Supported	Supported
Activation with Enterprise license	Supported	Supported
Administrator privileges required for connecting to Orchestrator	No	Required only for the service-mode robot
Connection to Orchestrator using interactive sign-in	Supported	Supported `2`
Connection to Orchestrator using the machine key	Supported	Supported
Unattended execution without user login	Not supported	Supported only for the service-mode robot

1 - User mode not available for Unattended Robot custom installations.

2 - For the service-mode robot, you must first connect to Orchestrator using the machine key, and then you can use interactive sign-in to change the user who connects to Orchestrator.

Performing the Installation

Double-click the installer to launch the installation wizard.
Read and accept the License Agreement. Please note that by accepting the terms of the license agreement, you implicitly accept the terms of use of UiPath activity packages and their dependencies.
Select the type of installation to perform:
- Quick - Install Studio in a default configuration that includes the following:
  - Studio, StudioX and Assistant
  - User-mode Robot
  - StudioX Excel Add-in (if Microsoft Excel is installed on your machine)
  - Chrome extension (if Google Chrome is installed on your machine)
  - Edge Chromium extension (if Microsoft Edge Chromium is installed on your machine)
  - JavaScript Robot Add-on
  - Extension for Microsoft Remote Desktop
    
    The installation path (%localappdata%\Programs\UiPath) and all other advanced options are already configured to help you get Studio up and running right away. This setup does not require administrator permissions—Studio is installed per user and is limited to the rights that the user has.
    
    Select this option and click Install to proceed to step 8, with no additional configuration required. This is the recommended option for Community users.
- Custom - Select which components to install, and configure advanced installation settings.
  
  Select this option and click Configure to proceed to step 4. This is the recommended option for advanced and Enterprise users.
If you opted for a custom installation, select the install mode, and then select Choose Packages to continue.
- Install for me only - Install in the user profile folder, no administrator privileges required.
- Install for all users on this computer - Install for all users, get access to more integrations and unattended automation, requires administrator privileges.
Select an installation package:
- Automation Developer - Installs UiPath Studio, Assistant, and Robot for creating and running automations. The following components and options are selected by default:
  - Studio, StudioX and Assistant
  - User-mode Robot
  - StudioX Excel Add-in (if Microsoft Excel is installed on your machine)
  - Chrome extension (if Google Chrome is installed on your machine)
  - Edge Chromium extension (if Microsoft Edge Chromium is installed on your machine)
  - JavaScript Robot Add-on
- Attended Robot - Installs UiPath Assistant and Robot for running attended automations. The following components and options are selected by default:
  - Assistant
  - User-mode Robot
  - Automatically Start Assistant with Windows
  - Chrome extension (if Google Chrome is installed on your machine)
  - Edge Chromium extension (if Microsoft Edge Chromium is installed on your machine)
  - JavaScript Robot Add-on
- Unattended Robot - Installs UiPath Robot for running unattended automations (via Orchestrator) and UiPath Assistant for troubleshooting. This option is available only if you selected to install for all the users on the machine.
  
  The following components and options are selected by default:
  - Assistant
  - Service-mode Robot
  - Chrome extension (if Google Chrome is installed on your machine)
  - Edge Chromium extension (if Microsoft Edge Chromium is installed on your machine)
- To install the selected option using the default configuration, select Install and proceed to step 8. To customize the installation, select Advanced Settings next to the option you selected and proceed to step 7.
If you opted to customize the installation, configure the following advanced settings, and then click Install:
- Installation Package tab:
  - Installation Path - Select the folder where to install UiPath. The default location is %LocalAppData%\Programs when installing for the current user and %ProgramFiles% when installing for all users on the machine.
    
    Note: For information about security considerations when selecting a custom installation path, see Deployment guidelines.
  - License Code - Optionally, enter your stand-alone trial or enterprise license key, if available. If you are installing as part of a trial of the on-premises UiPath Platform and do not enter a license code, you are prompted to provide it . This option is available only when installing for all users on the machine.
  - Robot Installation Type - Select the Robot installation type: Service Mode (the recommended option for running unattended automations) or User Mode (the recommended option for creating and testing automations, and running attended automations). For more details, see Robot types in the Robot guide. This option is available for the Automation Developer and Attended Robot packages when installing for all users on the machine.
    
    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.
  - Orchestrator Service URL - Allows you to define the URL of the Orchestrator instance to connect to using Interactive Sign-In. The provided URL is saved in the uipath.config file. This option is available only if you selected the User Mode installation type.
  - Automatically Start Assistant with Windows - Launch the Assistant at Windows startup. This option is available for the Automation Developer and Attended Robot packages when installing for all users on the machine.
- Extensions tab:
  - Select which extensions and add-ons you want to install.
    
    If Chrome or Edge Chromium is installed on your machine, the corresponding extension is selected by default.
    
    The JavaScript Robot Add-on is available when installing for all users on the machine and selected by default for the Automation Developer and Attended Robot packages .
    
    The SAP Solution Manager is available only when installing for all users on the machine if the SAP Connector for Microsoft is installed on your machine. If you select this option, enter the hostname or IP address for your SAP Solution Manager instance in the Host box.
    
    The Excel Add-in is available only for the Automation Developer package and selected by default if Excel is installed on your machine.
    
    The extensions for Java, Citrix, and VMWare are available only when installing for all users on the machine.
  - Default download location - Enter a custom download location for activities packages. By default, these are saved to %userprofile%\.nuget\packages. This option is available only when installing for all users on the machine.
  - Disable Online Feeds - Select whether to disable the Official and Marketplace online feeds for activities packages. This option is not selected by default and it is recommended if you are working in an offline environment..
- Security tab:
  - Enforce Signed Execution - Requires Robots to execute only signed packages. This option is not selected by default.
  - Disable Secure XAMLs - Disables security of XAML files for Robots installed as a Windows service. Unsecured XAML files allow users to read and modify the process files and logic. This option is not selected by default.
  - Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot. This option is not selected by default.
- After clicking Install, wait for the installation to complete, and then click Launch UiPath Assistant.