- 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-027 - Persistence Best Practice
- ST-DBP-028 - Arguments Serialization Prerequisite
- ST-USG-005 - Hardcoded Activity Properties
- ST-USG-009 - Unused Variables
- ST-USG-010 - Unused Dependencies
- ST-USG-014 - Package Restrictions
- ST-USG-017 - Invalid parameter modifier
- 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
- Troubleshooting
- Trigger-based Attended Automation
- Object Repository
- The ScreenScrapeJavaSupport Tool
- 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 Amazon WorkSpaces
- SAP Solution Manager plugin
- Excel Add-in
- Studio testing
- Troubleshooting
- About troubleshooting
- Assembly compilation errors
- Microsoft App-V support and limitations
- Internet Explorer X64 troubleshooting
- Microsoft Office issues
- Identifying UI elements in PDF with Accessibility options
- Repairing Active Accessibility support
- Validation of large Windows-legacy projects takes longer than expected
Command Line Parameters
Install Studio from the command line with the UiPath Platform Installer, using msiexec parameters and a configuration file that selects the desktop clients.
You can install Studio and the other UiPath desktop clients from the command line by running the UiPath Platform Installer with msiexec, either interactively or silently. Silent mode is intended for unattended deployments to multiple machines.
Syntax
msiexec /i UiPathPlatformLTS.26.10.msi [PARAMETER=value ...] [/qn]
msiexec /i UiPathPlatformLTS.26.10.msi [PARAMETER=value ...] [/qn]
Pass parameters as PARAMETER=value pairs after the package path, and enclose values that contain spaces in double quotes.
- Omit
/qnto run the installation wizard with its full user interface. - Add
/qnto run without a user interface. Partial-UI modes, such as/qband/qr, are not supported for unattended installations.
The installer runs per-machine when msiexec runs elevated, from an elevated command prompt or as SYSTEM from a deployment tool. A silent installation started from a non-elevated prompt installs per-user, without an error. To make a per-machine installation explicit, pass MSIINSTALLPERUSER=0. For details, refer to Installation scope.
Installer parameters
| Parameter | Description |
|---|---|
FORCE_PERUSER | Set to 1 to install per user, even when an administrator runs the installer. |
MSIINSTALLPERUSER | Set to 0 to make a per-machine installation explicit. The installation must still run elevated. |
PLATFORM_CONFIGURATION_FILE | The absolute path to a configuration file that selects the desktop clients to install and their options. For details, refer to The configuration file. |
UPDATER_CONFIGURATION_FILE | The absolute path to a configuration file for the updater, used for proxy settings. |
TELEMETRY_ENABLED | Set to 0 to turn off usage data collection, or to 1 to keep it on. Telemetry is on by default. |
INSTALLER_LANGUAGE | The language of the installation wizard, such as en, de, fr, ja, or pt-BR. It has no effect in silent mode. |
UiPathPlatformLTS.26.10.msi sets the Enterprise LTS (26.10 line) update channel itself, so you don't pass CHANNEL.
For the full list of values and for the proxy settings, refer to Install from the command line.
The configuration file
The file passed in PLATFORM_CONFIGURATION_FILE lists the desktop clients to install, each with its own parameters:
{
"Packages": [
{
"PackageName": "Studio",
"InstallRequested": true,
"Parameters": {
"INSTALL_STUDIO_LEGACY": "true",
"INSTALL_ACTIVITIES": "true"
}
},
{
"PackageName": "Robot",
"InstallRequested": true,
"Parameters": {
"SERVICE_URL": "https://orchestrator.example.com/organization/tenant/orchestrator_"
}
},
{
"PackageName": "Assistant",
"InstallRequested": true,
"Parameters": {}
},
{
"PackageName": "Runtimes",
"InstallRequested": true,
"Parameters": {}
},
{
"PackageName": "BrowserExtensions",
"InstallRequested": true,
"Parameters": {
"INSTALL_CHROME_EXTENSION": "true",
"INSTALL_EDGE_EXTENSION": "true"
}
}
]
}
{
"Packages": [
{
"PackageName": "Studio",
"InstallRequested": true,
"Parameters": {
"INSTALL_STUDIO_LEGACY": "true",
"INSTALL_ACTIVITIES": "true"
}
},
{
"PackageName": "Robot",
"InstallRequested": true,
"Parameters": {
"SERVICE_URL": "https://orchestrator.example.com/organization/tenant/orchestrator_"
}
},
{
"PackageName": "Assistant",
"InstallRequested": true,
"Parameters": {}
},
{
"PackageName": "Runtimes",
"InstallRequested": true,
"Parameters": {}
},
{
"PackageName": "BrowserExtensions",
"InstallRequested": true,
"Parameters": {
"INSTALL_CHROME_EXTENSION": "true",
"INSTALL_EDGE_EXTENSION": "true"
}
}
]
}
Keep the following in mind when you write the file:
PackageNamevalues are case sensitive:Studio,Robot,Assistant,Runtimes, andBrowserExtensions.- List every desktop client to install. A client that is missing from the file is not installed, including
Assistant, which the installation wizard selects together with Studio. - Studio requires
RobotandRuntimes, andAssistantrequiresRobot. A missing required package is not added, and the installation fails validation. - Write every parameter value as a string, including
"true"and"false". - If
Parametersis empty forBrowserExtensions, no browser extension is installed on a machine that doesn't have one.
Studio parameters
| Parameter | Description |
|---|---|
INSTALL_STUDIO_LEGACY | Installs Studio Legacy, which opens and edits Windows - Legacy projects. |
INSTALL_ACTIVITIES | Installs the activity packages that ship with Studio, in a local OfficialPackages feed. |
INSTALL_EXCEL_ADDIN | Installs the StudioX Excel Add-in. |
INSTALL_SAP_SOLMAN | Installs the SAP Solution Manager plugin. Requires SAP_SOLMAN_HOST. |
SAP_SOLMAN_HOST | The hostname or IP address of your SAP Solution Manager instance. |
Browser extension parameters
| Parameter | Description |
|---|---|
INSTALL_CHROME_EXTENSION | Installs the UiPath Extension for Chrome. |
INSTALL_EDGE_EXTENSION | Installs the UiPath Extension for Edge. |
INSTALL_FIREFOX_EXTENSION | Installs the UiPath Extension for Firefox. |
INSTALL_JAVA_EXTENSION | Installs the UiPath Extension for Java. |
INSTALL_SILVERLIGHT_EXTENSION | Installs the UiPath Extension for Silverlight. |
INSTALL_CITRIX_CLIENT_EXTENSION | Installs the client side of the UiPath Extension for Citrix. |
INSTALL_RDP_CLIENT_EXTENSION | Installs the client side of the UiPath Extension for Microsoft Remote Desktop. |
INSTALL_VMWARE_CLIENT_EXTENSION | Installs the client side of the UiPath Extension for VMware Horizon. |
INSTALL_AWS_WORKSPACES_CLIENT_EXTENSION | Installs the client side of the UiPath Extension for Amazon WorkSpaces. |
CHROME_INSTALL_TYPE | The installation method of the Chrome extension: PolicyOffline, PolicyOnline, ManualPerMachine, or NativeHostOnly. The older names STORE and GLOBAL are also accepted. If it's omitted, the most appropriate method is selected automatically. |
EDGE_INSTALL_TYPE | The installation method of the Edge extension, with the same values as CHROME_INSTALL_TYPE. |
Robot parameters
The Robot package takes the parameters that configure the Robot, including:
REGISTER_ROBOT_SERVICE, for service modeSERVICE_URLORCHESTRATOR_CLIENT_IDandORCHESTRATOR_CLIENT_SECRETLICENSE_KEYPACKAGES_FOLDER,CUSTOM_NUGET_FEEDS, andNUGET_OPTIONSENFORCE_SIGNED_EXECUTIONandDISABLE_SECURE_XAML
For their values, refer to Silent installation in the Robot guide.
Examples
Install the desktop clients selected in a configuration file, silently, per machine, from an elevated command prompt:
msiexec /i UiPathPlatformLTS.26.10.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" /qn
msiexec /i UiPathPlatformLTS.26.10.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" /qn
Install silently with telemetry turned off:
msiexec /i UiPathPlatformLTS.26.10.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" TELEMETRY_ENABLED=0 /qn
msiexec /i UiPathPlatformLTS.26.10.msi PLATFORM_CONFIGURATION_FILE="C:\Config\platformConfig.json" TELEMETRY_ENABLED=0 /qn
Install per user, for an administrator account:
msiexec /i UiPathPlatformLTS.26.10.msi FORCE_PERUSER=1
msiexec /i UiPathPlatformLTS.26.10.msi FORCE_PERUSER=1