- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- Types of Workflows
- Control Flow
- File Comparison
- Automation Best Practices
- Source Control Integration
- Debugging
- Logging
- The Diagnostic Tool
- Workflow Analyzer
- About Workflow Analyzer
- ST-NMG-001 - Variables Naming Convention
- ST-NMG-002 - Arguments Naming Convention
- ST-NMG-004 - Display Name Duplication
- ST-NMG-005 - Variable Overrides Variable
- ST-NMG-006 - Variable Overrides Argument
- ST-NMG-008 - Variable Length Exceeded
- ST-NMG-009 - Prefix Datatable Variables
- ST-NMG-011 - Prefix Datatable Arguments
- ST-NMG-012 - Argument Default Values
- ST-NMG-016 - Argument Length Exceeded
- ST-NMG-017 - Class name matches default namespace
- ST-DBP-002 - High Arguments Count
- ST-DBP-003 - Empty Catch Block
- ST-DBP-007 - Multiple Flowchart Layers
- ST-DPB-010 - Multiple instances of [Workflow] or [Test Case]
- ST-DBP-020 - Undefined Output Properties
- ST-DBP-021 - Hardcoded Timeout
- ST-DBP-023 - Empty Workflow
- ST-DBP-024 - Persistence Activity Check
- ST-DBP-025 - Variables Serialization Prerequisite
- ST-DBP-026 - Delay Activity Usage
- ST-DBP-027 - Persistence Best Practice
- ST-DBP-028 - Arguments Serialization Prerequisite
- ST-USG-005 - Hardcoded Activity Arguments
- ST-USG-009 - Unused Variables
- ST-USG-010 - Unused Dependencies
- ST-USG-014 - Package Restrictions
- ST-USG-020 - Minimum Log Messages
- ST-USG-024 - Unused Saved for Later
- ST-USG-025 - Saved Value Misuse
- ST-USG-026 - Activity Restrictions
- ST-USG-027 - Required Packages
- ST-USG-028 - Restrict Invoke File Templates
- ST-USG-032 - Required Tags
- ST-USG-034 - Automation Hub URL
- Variables
- Arguments
- Imported Namespaces
- Coded automations
- Introduction
- Registering custom services
- Before and After contexts
- Generating code
- Generating coded test case from manual test cases
- Trigger-based Attended Automation
- Recording
- UI Elements
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Citrix Technologies Automation
- RDP Automation
- VMware Horizon Automation
- Salesforce Automation
- SAP Automation
- macOS UI Automation
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- Extensions
- About extensions
- SetupExtensions tool
- UiPathRemoteRuntime.exe is not running in the remote session
- UiPath Remote Runtime blocks Citrix session from being closed
- UiPath Remote Runtime causes memory leak
- UiPath.UIAutomation.Activities package and UiPath Remote Runtime versions mismatch
- The required UiPath extension is not installed on the remote machine
- Screen resolution settings
- Group Policies
- Cannot communicate with the browser
- Chrome extension is removed automatically
- The extension may have been corrupted
- Check if the extension for Chrome is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and Incognito mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Chrome
- Chrome Extension on Mac
- Group Policies
- Cannot communicate with the browser
- Edge extension is removed automatically
- The extension may have been corrupted
- Check if the Extension for Microsoft Edge is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and InPrivate mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Edge
- Extension for Safari
- Extension for VMware Horizon
- Extension for Amazon WorkSpaces
- SAP Solution Manager plugin
- Excel Add-in
- Test Suite - Studio
- Troubleshooting
Install Studio
The 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 a 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.
UiPathStudio.msi). There is a single installer, but the file name differs depending on the type of deployment and license, with each file
offering a different activation experience.
-
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
UiPathStudioCommunity.msi.
For information on updating from an older version, see Update Studio.
For instructions on installing from the command line, see Command Line Parameters.
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 = 0to 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 | |
|---|---|---|
| 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.
-
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. 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 when you launch Studio for the first time. This option is available only when installing for all users on the machine.
-
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.configfile.Note: When choosing the user-mode installation, you can enforce Interactive Sign In as the only authentication method by enabling the enforceDefaultServiceUrl flag. This blocks the user from changing the authentication method and only allows the connection to Orchestrator to be done via Interactive Sign in. - Client ID and Client Secret - This option is only available when installing the robot as service mode. It allows you to connect the robot to Orchestrator using Client Id and Client Secret at install time.
- 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.
- Automatically Sign In - If you install the attended robot in user mode and your environment is configured to use SSO with Azure Active Directory, you can enable automatically signing in to Orchestrator.
-
-
Extensions tab:
-
Select which extensions and add-ons you want to install: Excel Add-in, extension for Java, extension for Chrome, extension for Edge Chromium, extension for Firefox, JavaScript Robot Add-on, extension for Citrix, extension for VMware, extension for Microsoft Remote Desktop, or SAP Solution Manager plugin.
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 Studio. For information on how to activate Studio, see Activating Studio.
| Installation context | Advanced configuration | Packages | Robot type | Installation type |
|---|---|---|---|---|
| Quick | N/A | N/A | User-mode robot | Per-user installation |
| Custom | Install for me only | Automation Developer | User-mode robot | Per-user installation |
| Attended Robot | User-mode robot | Per-user installation | ||
| Install for all users on this computer | Automation Developer | User-mode robot | Per-machine installation | |
| Attended Robot | User-mode robot | Per-machine installation | ||
| Unattended Robot | Service-mode robot | Per-machine installation |
You can deploy Studio, Robot, and Assistant to multiple virtual or physical machines using various mass deployment tools. The steps to follow differ depending on the infrastructure and deployment tools used in your organization. There are a few general principles to consider before deploying, such as making sure that the target computers:
- Meet the hardware and software requirements.
- Run on the same operating system.
- Are part of the same network group.
- Have access to the resource from which the installation will be pushed.
Options available for mass deployment include:
- Redistribute the installer through high-availability network storage.
-
Deploy through System Center Configuration Manager (SCCM).
When using SCCM, take into account that:
- The version that is installed must match the version that is advertised.
- The installation must be performed from the command line in silent mode.
- Deploy through Group Policy.
- Deploy through Remote Desktop Services.
- Deploy though third-party solutions such as PDQ Deploy.
- Deploy through Citrix DaaS.
