- Hardware and Software Requirements
- Deployment Guidelines
- Services Studio Connects To
- Modify or Uninstall Studio
- Update Studio
- Command Line Parameters
- Supported Applications and Technologies
- Enabling Gmail for Email Activities
- Opting Out of Telemetry
- Studio Executables
- About Publishing Automation Projects
- Designing Automations
- Managing Activities Packages
- Configuring Activity Project Settings
- Signing Packages
- Importing Entities
- Modern Design Experience
- Linking a Project to an Idea in Automation Hub
- Using the Data Manager
- 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
- 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
- About extensions
- About the SetupExtensions tool
- Extension for VMware Horizon
- SAP Solution Manager plugin
- Excel Add-in
- About troubleshooting
- Microsoft App-V support and limitations
- Internet Explorer X64 troubleshooting
- Microsoft Office issues
- Repairing Active Accessibility support
- Automating Applications Running Under a Different Windows User
- Validation of large Windows-legacy projects takes longer than expected
The first time you run Studio after installation, a wizard helps you activate and get started with your product. The activation method you are prompted with is determined by the type of installation you performed, but you can switch to another type of activation by clicking More Options in the wizard:
- If your organization purchased UiPath Automation Cloud or you are installing Studio as part of a trial of UiPath Automation Cloud, you are prompted to activate by signing in to your UiPath account.
- If your organization purchased the on-premises UiPath Platform, you are prompted to activate by connecting to Orchestrator with your client credentials or machine key.
- If you are installing Studio as part of a trial of the on-premises UiPath Platform, you are prompted to activate by adding a license key.
- If you are using the Community Edition of Studio, you are prompted to activate by signing in to your UiPath account.
Activating by Signing in to UiPath
The first time you run Studio after installing Studio with an installer downloaded from UiPath Automation Cloud, you are prompted to sign in to your UiPath account.
Click Sign in to sign in to your UiPath account. To find out more information about signing in, click Learn more.
- If you use a custom URL, enter the URL in the Service URL field. If you installed Studio using the Community Edition installer, you can only sign in to https://cloud.uipath.com.
- If you don't want to sign in, select More Options, and then Connect to Orchestrator to activate by connecting to Orchestrator with your client credentials or machine key. You can also sign in later from Studio or from the Assistant.
A new browser window opens. If you are not already logged in, log in with your email or using one of the available providers.
After logging in, your web browser prompts you to open UiPath. Click Open UiPath to return to Studio and continue.
If your user has access to multiple tenants, select which tenant to connect to, and then click Continue. If you have access to a single tenant, you are connected to it with no further input required.
You are signed in to your UiPath account and connected to Orchestrator in both Studio and Assistant, your product is activated, and a quick step-by-step tutorial is displayed to help you start creating automations.Note: If you are having trouble signing in, see Common Sign-in Errors in the Studio Guide for troubleshooting information.
Activating by Connecting to Orchestrator
The first time you run Studio after installing Studio with an installer obtained when purchasing the on-premises UiPath Platform, you are prompted to connect to Orchestrator with your client credentials or machine key.
- Select a connection type - Client ID or Machine Key.
Enter the Orchestrator URL and either the Client ID and Client Secret or the Machine Key generated in Orchestrator, and then click Continue.
- If you don't want to connect to Orchestrator, select More Options, and then Standalone Options to activate by adding a license key.
You are connected to Orchestrator in both Studio and the Assistant, a license key is acquired from Orchestrator, and a quick step-by-step tutorial is displayed to help you start creating automations.Note: If you connect to Orchestrator with your machine key, you can only use Studio with a Non-Production or Unattended license to troubleshoot workflows if the option Enforce user authentication, disable robot key authentication is disabled in Orchestrator. Alternatively, if user authentication is enforced and a development license is also allocated to your user, sign in to your account after connecting with your machine key.
When Studio is licensed via Orchestrator (either by signing in or connecting to Orchestrator), the Help tab mentions License Provider: Orchestrator. Otherwise, the same text states Internal.
Please bear in mind that any license change is performed only after Studio is restarted.
Activating With a License Key
The first time you run Studio after installing Studio with an installer obtained as part of a trial of the on-premises UiPath Platform, you can activate locally using a license key. A local license can also be activated with the LicenseTool Command Line Utility.
To activate a license key:
- Select the Automatic option to license online.
- Fill in the Add License Key field with the license key you received.
Click the Continue button. Your UiPath license is now activated and you can start creating automation workflows.Note:
An Activation Error might be displayed during the licensing process if an antivirus is installed on the machine. To avoid the error message, Studio has to be whitelisted in both the antivirus and the Firewall.
If Studio is licensed locally, but you still want to connect it to Orchestrator, make sure you select the Stand-alone check box when creating its Robot in Orchestrator. This ensures that Orchestrator does not allocate a license from its pool, as Studio defaults to the local one.
Activating Your License While Installing
You can activate a license key during installation by running the
UiPathStudio.msi installer from the command line with the
CODE argument followed by the license key. For example:
Also, for an unattended installation, there are some silent parameters that you can use:
/quiet- Quiet mode, no user interaction
/passive- Unattended mode - progress bar only
/q[n|b|r]- Sets user interface level
n- No UI
b- Basic UI
r- Reduced UI
C:\UiPathStudio.msi CODE=1234567890 /passive - installs all the default features and activates your license, showing a progress bar.
- Make sure the CNG Key Isolation service is running. This is required by UiPath to validate your license offline.
- If you are renewing your license, before following the steps described below, delete the LicenseInternal folder located either in
%AppData%/UiPath(for per-user licenses) or
%ProgramData%/UiPath(for per-machine licenses).
When UiPath Studio is installed on a machine that is not connected to the internet or when your network security software/firewall prevents access to our license validation server, you can manually activate it with the LicenseTool Command Line Utility.
Alternatively, you can use the activation wizard by following the steps below:
- Select More Options > Standalone Options if you're not already in the Add License Key screen.
- Fill in the Add License Key field with the license key you received.
- Click the Manual activation option.
Click the Continue button. The first step of manual activation is displayed and an Activation Request code is generated and copied to clipboard.
Copy the Activation Request code to an email message or text file, and press the Continue button.Note: Keep the Activation wizard open until the process is complete.
- Send the activation request code to a computer with Internet access.
On the computer with Internet access navigate to https://activate.uipath.com/.
Make sure the Activate Your License tab is selected on the webpage, and paste the Activation Request code in the Activation Request Certificate field and click the Generate License File. The license code is generated.
- Choose between Download License File to save the license code to a
.txtfile on your machine, or copy the license code to clipboard.
Attach the downloaded
.txtfile or paste the license in an email and send it to the computer with no Internet access or firewall restrictions.
On the machine you want to activate your license on, press the Continue button in the second step of the Manual Activation wizard. The third and last step of the Manual Activation wizard is displayed.
- In the Activation field paste the license code obtained during step 10.
Press the Continue button. Your license is now activated.Note: If the Windows user name contains non-ASCII characters, an Incompatible license model data Exception error occurs when you click Continue and offline activation is not completed successfully.
Selecting the Studio Profile
When you perform a fresh installation as part of a trial of the on-premises UiPath Platform or when using the Community Edition of Studio, after activating you are prompted to select which profile to use (Studio or StudioX).
If you have an Enterprise license, the Studio profile is automatically selected after activation based on the license allocation in Orchestrator.
You can switch to another user profile at any time from Studio by going to Home (Backstage view) > Settings > License and Profile > Change Profile.
Switching between profiles can also be done using the following command-line parameters:
-p Development: to switch to Studio profile;
-p Business: to switch to StudioX profile;
To do so, open
cmd in the directory where Studio is installed, and type in the following command:
UiPath\Studio\UiPath.Studio.exe -p Business, then press Enter. Studio opens in the StudioX profile.
The commands are case-sensitive. If an incorrect argument is inputted, the default profile Studio is opened. The list of Recent projects is persisted per profile.
Updating the License Key
You can change a local license key from Studio by going to Home (Backstage view) > Settings > License and Profile.
Click Change Local License, enter the new license key, and click Continue.