- Getting started
- Understanding UiPath Robot
- UiPath Assistant
- Installation requirements
- Installing robots for unattended automations
- Configuring robots for unattended automations
- Connecting robots for unattended automations to Orchestrator
- Setting up Windows Server for high-density robots
- Redirecting robots through a proxy server
- Implementing authentication
- Adjusting registry settings for execution in minimized RDP windows
- Using network locations
- Setting up Linux robots
- Configuring package signature verification
- Setting up package folders and network paths
- Configuring activity feeds
- Deploying unattended automations
- Installing robots for attended automations
- Configuring robots for attended automations
- Integrations
- Troubleshooting
Installation models
UiPath provides two installers for Windows. You can download them from the Resource Center in UiPath Automation Cloud or from the Product Downloads section in Customer Portal.
-
Before the 2021.4 release, Studio and Robot were 32-bit applications. However, from version 2021.4 onward, a 64-bit installer is the default.
-
Starting with version 2023.4, a 32-bit installer is no longer provided, and the
UiPathPlatformInstaller.exe
is discontinued beginning with version 2021.4. -
To update existing 32-bit or 64-bit
UiPathStudio.msi
andUiPathPlatformInstaller.exe
installations on 64-bit operating systems, useUiPathStudio.msi
. -
The default installation path for pre-2021.4, 32-bit installation on a 64-bit system was
C:\Program Files (x86)\UiPath\Studio
. Upgrading to 64-bit installers migrates the installation to theC:\Program Files\UiPath\Studio
folder. Installations that use custom paths do not change their directory after update.
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 for per-machine installations).
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 policyDisableMSI = 0
to enable the Windows installer for all applications. - Perform the installation per machine by installing using the Custom option.
Quick |
Custom | |
---|---|---|
Installation context | Per user | Per user or per machine |
Supported robot installation types |
User mode |
|
Administrator privileges required for the installation |
No |
Required only for per-machine installations. |
Installation directory |
%LocalAppData%\Programs |
A custom location can be selected. The default location is:
|
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
1 |
Connection to Orchestrator using the machine key |
Supported |
Supported |
Unattended execution without user login |
Not supported |
Supported only for the Service-Mode robot |
1
- For the Service-Mode robot, you must first connect to Orchestrator using client credentials, and then you can use interactive
sign-in to change the user who connects to Orchestrator.
UiPath.Studio.msi
is the Windows installer that targets mainly developers. When installed, the software package includes both the development
environment (UiPath Studio), UiPath Robot, and UiPath Assistant to execute the developed workflows.
If you are looking to build, debug, and test automation on the same machine, use this installer.
Available installation options
-
Quick installation - Installs a default configuration in the
%localappdata%\Programs\UiPath
directory. The default configuration includes:-
Studio, StudioX and Assistant
-
Robot in User Mode
-
StudioX Excel add-on (if you have Microsoft Excel already installed on your machine)
-
Chrome extension (if you have Google Chrome already installed on your machine)
-
Edge Chromium extension (if you have Microsoft Edge Chromium already installed on your machine)
-
JavaScript Robot Add-on
-
Extension for Microsoft Remote Desktop
-
-
Custom installation - Allows you to select the components you want to install, and configure advanced settings. The installation path is
%LocalAppData%\Programs
for current user installations, and%ProgramFiles%
for installations applicable to all users on the device.
Custom installation - available options
-
Install for me only - Install your custom configuration in the user profile folder. No administrator privileges needed.
-
Install for all users on this computer - Installs your custom configuration for all users on the machine. Needs administrator privileges.
Install for me only - available installation packages
-
Automation Developer - Installs the following configuration, for running attended automations:
-
Studio, StudioX and Assistant
-
Robot in User Mode
-
-
Attended Robot - Installs the following configuration, for running attended automations, and automatically starts Assistant with Windows.
-
Assistant
-
Robot in User Mode
-
When you select an option, the Advanced Settings configuration becomes available, with the following options:
Advanced setting |
Description |
---|---|
Installation Package |
|
Extensions > Tools |
|
Extensions > Packages configuration |
|
Security |
|
Install for all users on this computer - available installation packages
-
Automation Developer - Installs the following configuration, for running attended automations:
-
Studio, StudioX and Assistant
-
Robot in User Mode
-
-
Attended Robot - Installs the following configuration, for running attended automations, and automatically starts Assistant with Windows.
-
Assistant
-
Robot in User Mode
When you select an option, the Advanced Settings configuration becomes available.Advanced setting
Description
Installation Package
-
Installation Path - The destination folder for installation. Default path is
%ProgramFiles%
. -
License Code (optional) - The key for your standalone trial or enterprise license. Without a key during a the standalone trial setup, Studio prompts for it upon its first launch.
-
Orchestrator URL - The URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the
uipath.config
file. -
Automatically sign in - When your environment is configured to use SSO with Azure Active Directory, you can enable automatic authentication for your account.
-
Automatically Starts Assistant with Windows - Launches Assistant at Windows startup.
Extensions > Tools
-
StudioX Excel Addin
-
UiPath extension for Java
-
UiPath JavaScript Robot Add-on
-
UiPath extension for Citrix
-
UiPath extension for Chrome
-
UiPath extension for Edge Chromium
-
UiPath extension for Firefox
-
UiPath extension for Microsoft Remote Desktop
-
UiPath extension for VMware
-
SAP Solution Manager - Available if you have the SAP connector for Microsoft is already installed on your machine. If selected, you need to provide the hostname or IP address for your SAP Solution Manager instance in the Host box.
Extensions > Default download location
The download location for activity packages. Default location is%userprofile%.nuget\packages
.Extensions > Packages configuration
-
Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
Security
-
Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively.
-
Disable Secured 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.
-
Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.
-
-
Unattended Robot - Installs the following configuration, for running unattended automations:
-
Assistant
-
Robot in Service Mode
Advanced setting
Description
Installation Package
-
License Code (optional) - The key for your standalone trial or enterprise license. Without a key during a the standalone trial setup, Studio prompts for it upon its first launch.
-
Orchestrator URL - The URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the
uipath.config
file. -
Client Id and Client Secret - The client credentials from machine template objects. This pair produces a token, allowing unattended robots access to Orchestrator resources.
-
Install UiPath Studio - If selected, installs Studio for design purposes.
Extensions > Tools
-
StudioX Excel Addin
-
UiPath extension for Java
-
UiPath JavaScript Robot Add-on
-
UiPath extension for Citrix
-
UiPath extension for Chrome (*)
-
UiPath extension for Edge Chromium (*)
-
UiPath extension for Firefox
-
UiPath extension for Microsoft Remote Desktop
-
UiPath extension for VMware
-
SAP Solution Manager - Available if you have the SAP connector for Microsoft is already installed on your machine. If selected, you need to provide the hostname or IP address for your SAP Solution Manager instance in the Host box.
(*) These options are selected by default.
Extensions > Default download location
The download location for activity packages. Default location is%userprofile%.nuget\packages
.Extensions > Packages configuration
-
Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
Security
-
Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively.
-
Disable Secured 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.
-
Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.
-
UiPath.Robot.msi
is typically installed on Windows machines that mainly execute automations. No development environment is attached to this
installation, and thus, resource allocation is primarily for running robots. It includes UiPath Robot and UiPath Assistant.
Available installation options
-
Quick installation - Installs a default configuration in the
%localappdata%\Programs\UiPath
directory. The default configuration includes:-
Studio, StudioX and Assistant
-
Robot in User Mode
-
StudioX Excel add-on (if you have Microsoft Excel already installed on your machine)
-
Chrome extension (if you have Google Chrome already installed on your machine)
-
Edge Chromium extension (if you have Microsoft Edge Chromium already installed on your machine)
-
JavaScript Robot Add-on
-
Extension for Microsoft Remote Desktop
-
-
Custom installation - Allows you to select the components you want to install, and configure advanced settings. The installation path is
%LocalAppData%\Programs
for current user installations, and%ProgramFiles%
for installations applicable to all users on the device.
Custom installation: available installation packages
-
Install for me only: Attended - Installs Robot and Assistant to run attended automations. Your custom configuration applies to the current user profile. No administrator privileges needed.
-
Install for all users: Attended - Installs Robot and Assistant to run attended automations. Your custom configuration applies to all users on the machine. Needs administrator privileges.
-
Install for all users: Unattended - Installs Robot to run unattended automations via Orchestrator, and installs Assistant for troubleshooting. Your custom configuration applies to all users on the machine. Needs administrator privileges.
Custom - available installation packages
-
Install for me only: Attended - Installs Robot and Assistant to run attended automations.
-
Your custom configuration applies to the current user profile.
-
Robot is installed in User Mode.
-
No administrator privileges needed.
When you select this option, the Advanced Settings configuration becomes available.Advanced setting
Description
Installation Package
-
Orchestrator URL - the URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.config file.
-
Automatically sign in - When your environment is configured to use SSO with Azure Active Directory, you can enable automatic authentication for your account.
Extensions > Tools
-
UiPath JavaScript Robot Add-on (*)
-
UiPath extension for Chrome (*)
-
UiPath extension for Edge Chromium (*)
-
UiPath extension for Firefox
-
UiPath extension for Microsoft Remote Desktop
(*) These options are selected by default.
Extensions > Packages configuration
-
Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
Security
-
Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively.
-
Disable Secured 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.
-
Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.
-
-
Install for all users: Attended- Installs Robot and Assistant to run attended automations.
-
Your custom configuration applies to tall users on the machine.
-
Robot is installed in User Mode.
-
Needs administrator privileges.
-
Automatically starts Assistant with Windows.
When you select this option, the Advanced Settings configuration becomes available.Advanced setting
Description
Installation Package
-
Installation Path - The destination folder for installation. Default path is
%ProgramFiles%
. -
License Code (optional) - The key for your standalone trial or enterprise license. Without a key during a the standalone trial setup, Studio prompts for it upon its first launch.
-
Orchestrator URL - The URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the
uipath.config
file. -
Automatically sign in - When your environment is configured to use SSO with Azure Active Directory, you can enable automatic authentication for your account.
-
Automatically Starts Assistant with Windows - Launches Assistant at Windows startup.
Extensions > Tools
-
UiPath extension for Java
-
UiPath JavaScript Robot Add-on (*)
-
UiPath extension for Citrix
-
UiPath extension for Chrome (*)
-
UiPath extension for Edge Chromium (*)
-
UiPath extension for Firefox
-
UiPath extension for Microsoft Remote Desktop
-
UiPath extension for VMware
(*) These options are selected by default.
Extensions > Default download location The download location for activity packages. Default location is%userprofile%.nuget\packages
.Extensions > Packages configuration
-
Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
Security
-
Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively.
-
Disable Secured 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.
-
Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.
-
-
Install for all users: Unattended- Installs Robot to run unattended automations via Orchestrator, and installs Assistant to troubleshoot issues.
-
Your custom configuration applies to tall users on the machine.
-
Robot is installed in Service Mode.
-
Needs administrator privileges.
When you select this option, the Advanced Settings configuration becomes available.Advanced setting
Description
Installation Package
-
Installation Path - The destination folder for installation. Default path is
%ProgramFiles%
. -
License Code (optional) - The key for your standalone trial or enterprise license. Without a key during a the standalone trial setup, Studio prompts for it upon its first launch.
-
Orchestrator URL - The URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the
uipath.config
file. -
Client Id and Client Secret - The client credentials from machine template objects. This pair produces a token, allowing unattended robots access to Orchestrator resources.
Extensions > Tools
-
UiPath extension for Java
-
UiPath JavaScript Robot Add-on
-
UiPath extension for Citrix
-
UiPath extension for Chrome (*)
-
UiPath extension for Edge Chromium (*)
-
UiPath extension for Firefox
-
UiPath extension for Microsoft Remote Desktop
-
UiPath extension for VMware
(*) These options are selected by default.
Extensions > Default download location The download location for activity packages. Default location is%userprofile%.nuget\packages
.Extensions > Packages configuration
-
Disable Online Feeds - Optionally, disable the Official and Marketplace online feeds for activity packages. Recommended for offline environments.
Security
-
Enforce Signed Execution - Instructs the Robot to execute signed packages exclusively.
-
Disable Secured 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.
-
Disable Telemetry - Disables the collection of anonymous usage data for Studio and Robot.
-
Installing Robot or Studio using command line parameters is useful for installation on multiple machines, for silent installations, and for saving system resources that a graphical wizard might consume. It also allows customized installation settings and integration with scripts.
To install the Robot using the command prompt, you need administrator privileges.
Best practices
-
To escape the "%" character in system variable names, such as %username%, use the following command:
^ - UiPathRobot.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^%
^ - UiPathRobot.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^%Note:In PowerShell, no escaping is needed.
-
When using Active Directory domain accounts, specify the domain name in the folder structure:
C:\packages\^%UserDomain^%.^%Username^%
C:\packages\^%UserDomain^%.^%Username^% -
To use paths that contain spaces, use quotes:
-
In Command Prompt, use double quotes:
UiPathRobot.msi APPLICATIONFOLDER="C:\folder name"
UiPathRobot.msi APPLICATIONFOLDER="C:\folder name" -
In PowerShell, use single and double quotes:
./UiPathRobot.msi APPLICATIONFOLDER='"C:\folder name"'
./UiPathRobot.msi APPLICATIONFOLDER='"C:\folder name"'
-
Clean installations - command line parameters
UiPath.Studio.msi
or UiPath.Robot.msi
from the command line.
Command |
Description |
---|---|
|
|
|
|
|
|
|
The following options are not available in per-user installations: RegisterService, CitrixExtension, VMwareExtension, PACKAGES_FOLDER, CODE. |
SAP_SOL_MAN_HOST (exclusively for UiPath.Studio.msi )
|
|
|
|
|
Note:
The URL feeds remain in the configuration files, but are ignored. |
|
Note: Make sure that all users that need to execute processes have read access to the new folder.
|
|
|
|
|
|
|
CLIENT_ID and CLIENT_SECRET |
|
|
Note: The old installation methods names (
STORE , GLOBAL ) are kept for backwards compatibility.
|
|
Note: The old installation methods names (
STORE , GLOBAL ) are kept for backwards compatibility.
|
|
|
|
|
|
|
|
|
|
|
|
|
ASSISTANT_OPTIONS |
|
ORCHESTRATOR_AUTO_SIGNIN |
|
ENFORCE_DEFAULT_SERVICE_URL |
|
Update or modifying existing installations - command line parameters
UiPath.Studio.msi
from the command line.
Command |
Description |
---|---|
Not supported for changing an existing installation. |
|
|
|
|
|
Not supported for changing an existing installation. |
Note:
The URL feeds remain in the configuration files, but are ignored. |
Not supported for changing an existing installation. |
|
|
|
Not supported for changing an existing installation. |
|
ASSISTANT_OPTIONS |
|
Not supported for changing an existing installation. |
|
ADDLOCAL
parameter is used. If you choose to use the ADDLOCAL
parameter in a command prompt installation, you must add the LiveStreaming
flag.
UiPathRobot.msi
command performs a custom installation or upgrade which also installs RealVNC, the software that is required for live streaming:
UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,LiveStreaming
UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,LiveStreaming
Mac operating systems allow installing the Robot in User Mode and the Assistant. You cannot configure your own setup. The installation on MacOS is similar to the quick installation on Windows OS. The earliest compatible MacOS version is 10.15 (Catalina).
To install Assistant on Mac, you need to download the installation file (DMG) and run it, as you would do for any installation file on MacOS.
You can download the DMG file from two sources:
-
Customer portal > Downloads > UiPath Assistant <LTS version>
-
Automation Cloud™> Help icon > Downloads > Assistant for macOS
The available Apple processors that support installing Assistant are:
-
Intel x64 - runs both macOS and Windows, which expands the range of software that can be used
-
Apple Silicon ARM64 - based on ARM architecture
Although you cannot install Studio directly on Mac, you can execute attended, cross-platform automations through Assistant.
-
You cannot use local feeds. This means that only automations from the Orchestrator, specifically cross-platform ones, are available.
-
The previous rule applies to the Marketplace Widget, namely it only displays and allows the execution of cross-platform automations that are hosted on Orchestrator.
-
For browser-based automations on MacOS, install and manually enable the Google Chrome Extension after first Assistant launch. Restart the browser post-installation.
-
When designing an automation for MacOS in Studio, you can test it using remote debugging, which involves connecting to the specific MacOS machine.
-
You can access the Assistant logs in the
/Users/john.doe/Library/Application Support/UiPath/combined.logs
file. -
The following Assistant features are unavailable:
-
Robot session (Picture in Picture)
-
Sending automations to desktop
-
Task Capture launcher
-
RobotJS and Safari browser compatibility
-
Diagnostic Tool
-
Installing Robots on Linux requires a Docker environment, a network connection to Orchestrator, and the client credentials of the machine template.
24.10.95.24248-robot24.10.0
. To install the latest patch available, do not mention a tag. The command to download the docker image is:
docker pull registry.uipath.com/robot/uiautomation-runtime:<tag>
docker pull registry.uipath.com/robot/uiautomation-runtime:<tag>
-
To create automations for Linux, ensure you have Chrome extension version 2021.10.4 or later. This allows the robot to execute background and foreground automations.
-
To design a UI automation for Linux, you can select the following input methods for activities:
-
ChromiumAPI: The default input mode that lets robots interact directly with Chrome elements.
-
SimulateClick/SimulateType: Simulates user actions like clicking or typing on a webpage.
-
Web Recorder: Replicates a series of actions on a webpage that a robot can replay.
-
Table Extraction: A tool to facilitate data extraction from web tables.
-
docker run
command. Use this command to start the Docker image.
Parameter |
Description |
Example |
---|---|---|
|
Accepts the UiPath license agreement. |
|
|
Sets the URL of the Orchestrator instance where your robots should connect. | |
Use together with client secret. If you use the machine key, do not use this parameter. |
Sets the client ID of the machine template. | |
Use together with client ID. | Sets the client secret of the machine template. | |
If you use client ID and secret, do not use this parameter. |
Sets the key of the machine template. | |
VNC_ENABLED=true |
Optional. Enables the live streaming of the Robot execution on Linux through Virtual Networking Computing (VNC). Requires port
5000:5900 for accessing the VNC server.
Important:
After enabling the VNC server, use any VNC client to live stream the robot execution. |
|
docker run
command. For example:
docker run --dns="1.1.1.1" -e LICENSE_AGREEMENT=accept -e ORCHESTRATOR_URL="https://cloud.uipath.com/organization/tentant/orchestrator_" -e CLIENT_ID="$Client_ID" -e CLIENT_SECRET="$Client_secret" -tid registry.uipath.com/robot/uiautomation-runtime:<tag>
docker run --dns="1.1.1.1" -e LICENSE_AGREEMENT=accept -e ORCHESTRATOR_URL="https://cloud.uipath.com/organization/tentant/orchestrator_" -e CLIENT_ID="$Client_ID" -e CLIENT_SECRET="$Client_secret" -tid registry.uipath.com/robot/uiautomation-runtime:<tag>
--dns="1.1.1.1"
represents the public DNS resolver from Cloudflare. You can use any DNS resolver to redirect the SignalR Hub.
/home/robotuser/.nuget/Packages/
directory of a docker container. To configure this, you need to mount the directory containing the NuGet libraries. Add the
following flag to the docker run command: -v <path to packages on the host machine>:/home/robotuser/.nuget/Packages/
.
For example, using machine key:
docker run -e LICENSE_AGREEMENT=accept -e MACHINE_KEY="{machine_key}" -e ORCHESTRATOR_URL="https://cloud.uipath.com/organization/tentant/orchestrator_" -v <path to packages on the host machine>:/home/robotuser/.nuget/Packages -ti registry.uipath.com/robot/uiautomation-runtime
docker run -e LICENSE_AGREEMENT=accept -e MACHINE_KEY="{machine_key}" -e ORCHESTRATOR_URL="https://cloud.uipath.com/organization/tentant/orchestrator_" -v <path to packages on the host machine>:/home/robotuser/.nuget/Packages -ti registry.uipath.com/robot/uiautomation-runtime
To debug a running robot container, use the Remote Debugging feature.
- Installing on Windows OS
- About 32-bit and 64-bit versions
- About quick and custom installations
- Using UiPath.Studio.msi
- Using UiPath.Robot.msi
- Using the Command Prompt
- The live streaming feature
- Installing on Mac
- MacOS automations - particularities and limitations
- Installing on Linux
- The Docker image tag
- Linux automations - particularities
- Parameters for the
docker run
command - Orchestrator connection failure
- Configuring package feeds
- Remote debugging