- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- Types of Workflows
- File Comparison
- Automation Best Practices
- Source Control Integration
- Debugging
- 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-DBP-002 - High Arguments Count
- ST-DBP-003 - Empty Catch Block
- ST-DBP-007 - Multiple Flowchart Layers
- ST-DBP-020 - Undefined Output Properties
- 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
- Variables
- Arguments
- Imported Namespaces
- Recording
- UI Elements
- Control Flow
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Automating Citrix Technologies
- RDP Automation
- SAP Automation
- VMware Horizon Automation
- Logging
- The ScaleCoordinates Migration Tool
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- StudioPro
- Extensions
- Troubleshooting
Studio User Guide
Install Studio
You can install Studio using one of three available installers:
- UiPathStudio.msi - Installs the Enterprise Edition of Studio. Use the MSI installer if your organization purchased the UiPath Platform or if you are installing Studio as part of a trial of the UiPath Platform.
- UiPathPlatformInstaller.exe - Installs Studio, the Robot, and Orchestrator.
- UiPathStudioSetup.exe - Installs the Community Edition of Studio that includes Studio and a user-mode Robot.
For more information about the differences between the installers, see the following table.
Installer |
Use This to Install |
Installation Available For |
Command-line Support |
Customizable Installation |
Requires Admin Privileges |
---|---|---|---|---|---|
UiPathStudio.msi
1 |
Enterprise Edition of one of the following:
Recommended tor Enterprise users and can only be activated with an Enterprise or Enterprise Trial license. |
All users on the machine. |
|
|
|
UiPathPlatformInstaller.exe |
Similar to UiPath.Studio.msi, but also enables you to install UiPath Orchestrator. Comes with a service-mode Robot by default. Recommended tor Enterprise users who want to try the on-premises UiPath Platform. |
All users on the machine. |
|
|
|
UiPathStudioSetup.exe |
Community Edition of Studio and user-mode Robot, automatically updated to the latest Community release that offers early access to new features, including features that are still in development. Recommended tor users with a free Community license, but can also be activated with an Enterprise or Enterprise Trial license. |
User who performed the installation. |
|
|
|
1
File name differs depending on the type of deployment and license.
More infoThe installation artifacts can be downloaded from the Resource Center in UiPath Automation Cloud, provided to you when you purchase Studio, or provided by your customer success manager or the support team. To request a trial, go to https://cloud.uipath.com/portal_/register.
Using the MSI installer, you can install the Enterprise version of Studio, the UiPath Assistant, or the legacy Robot on your machine. It requires administrator permissions, but the installed products are available to all users on the machine. For instructions on installing Studio from the command line, see Command Line Parameters.
There is a single installer, but the file name varies depending on the type of deployment and license, with each file offering a different activation experience:
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.
C:\Program Files
(x86)\UiPath\Studio
. You can change the install location by making use
of the command line arguments.
- Double-click the installer.
-
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.
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.
-
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.
-
(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.
- 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:
-
Register as Windows Service - Specifies how to install the Robot.
If you selected Unattended Robot in step 2, this option is enabled by default and the Robot is installed in service mode.
If you selected Studio or Assistant in step 2, this option is disabled by default and the Robot is installed in user mode, the recommended option for attended and development Robots.
- 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 change the default installer settings, click the button next to each feature and select one of the following options:
-
- Will be installed on the local hard drive - helps you install the corresponding feature on the local hard drive.
- Entire feature will be installed on the local hard drive - installs the corresponding feature on the local hard drive, along with all its sub-features.
-
Entire feature will be unavailable - does not install the corresponding feature.
-
- Click Install, wait for the installation to complete, and then click Finish. For information on how to activate Studio, see Activating Studio.
UiPathPlatfromInstaller.exe
installer while another such
installer is running results in a corrupted installation.
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.
Proceed with your installation of UiPath Studio:
-
From the Products tab of the UiPath Platform Installer, click the Install button for UiPath Studio & Robot. The UiPath Studio & Robot Installer screen is displayed.
-
From the Regular tab, complete the following settings and options:
- Installation Path
- Enables you to select a custom installation directory. The default
directory (
C:\Program Files (x86)\UiPath\Studio
) is prefilled. - Products - Use the radio buttons to select if you want to install only UiPath Robot. The Install UiPath Studio + Robot option is selected by default.
- License Code - Optional. Enter 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.
- Installation Type - Use the radio buttons to select the Robot installation type. See here for details.
- Automatically Start Robot in Tray - Starts the Robot tray at Windows startup.
- StudioX Excel Addin - Select to also install the integration add-in for StudioX and Microsoft Excel. Learm more about StudioX here.
- Installation Path
- Enables you to select a custom installation directory. The default
directory (
- Click the Advanced tab to
further customize your installation with these settings:
- Tools - Use the checkboxes to also enable the installation of the Java, Chrome, or Citrix extensions. Read more about extensions for Studio here.
- Custom Packages
Path - Enables you to provide a custom download location for
your workflows and dependencies for UiPath Studio and Robot. By default
these are saved to
%ProgramFiles(x86)%\UiPath\Studio\Packages
. - Packages Configuration - Select whether to Install Local Activities (enabled by default) and whether you want to Disable Online Feeds of activities. Learn more About the Activities Feeds.
-
Custom NuGet Feeds - Use the Feed Name and Feed URL fields to add any custom Nuget feeds to the installation.
-
From the Other Settings options, select if you want to:
- 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.
- Click Install. Your installation in finalized and you can begin using UiPath Studio and Robot.
UiPathStudioSetup.exe
file enables you to install the Community
Edition of Studio with a user-mode Robot. The installation path -
%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.
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.