- 入门指南
- 了解 UiPath Robot
- UiPath Assistant
- 安装要求
- Installing robots for unattended automations
- Configuring robots for unattended automations
- Installing robots for attended automations
- Configuring robots for attended automations
- 集成
- 故障排除
安装模式
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.
您可以通过在安装向导中选择“快速”选项(不需要管理员权限),以默认配置为当前用户执行安装,也可以通过选择“自定义”选项来配置安装(每台计算机安装需要管理员权限)。
如果您使用的是 Microsoft Windows Server,则每用户安装可能无法成功完成。如果发生错误,提示已设置策略来阻止安装,若您是计算机的管理员,则可以执行以下任一操作:
- 打开注册表编辑器,然后在注册表键
HKLM\Software\Policies\Microsoft\Windows\Installer
中配置策略DisableMSI = 0
,为所有应用程序启用 Windows 安装程序。 - 通过使用“自定义”选项进行安装,以按照计算机执行安装。
快速入门 |
自定义 | |
---|---|---|
安装上下文 | 按用户 | 按用户或计算机 |
支持的机器人安装类型 |
用户模式 |
|
安装所需的管理员权限 |
否 |
仅对于每台计算机安装是必需的。 |
安装目录 |
%LocalAppData%\Programs |
可以选择自定义位置。默认位置为:
|
使用社区版许可激活 |
支持 |
支持 |
使用企业版许可激活 |
支持 |
支持 |
需要管理员权限 用于连接到 Orchestrator |
否 |
Required only for the Service-Mode robot |
使用交互式登录连接到 Orchestrator。 |
支持 |
支持
1 |
使用计算机密钥连接到 Orchestrator |
支持 |
支持 |
无人值守执行,无需用户登录 |
不支持 |
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 和 Assistant
-
用户模式机器人
-
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 附加项
-
Microsoft 远程桌面扩展程序
-
-
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 和 Assistant
-
用户模式机器人
-
-
Attended Robot - Installs the following configuration, for running attended automations, and automatically starts Assistant with Windows.
-
Assistant
-
用户模式机器人
-
When you select an option, the Advanced Settings configuration becomes available, with the following options:
Advanced setting |
描述 |
---|---|
Installation Package |
|
Extensions > Tools |
|
Extensions > Packages configuration |
|
安全性 |
|
Install for all users on this computer - available installation packages
-
Automation Developer - Installs the following configuration, for running attended automations:
-
Studio、StudioX 和 Assistant
-
用户模式机器人
-
-
Attended Robot - Installs the following configuration, for running attended automations, and automatically starts Assistant with Windows.
-
Assistant
-
用户模式机器人
When you select an option, the Advanced Settings configuration becomes available.Advanced setting
描述
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 Java 扩展程序
-
UiPath JavaScript 机器人插件
-
UiPath Citrix 扩展程序
-
UiPath Chrome 扩展程序
-
UiPath extension for Edge Chromium
-
Firefox 版 UiPath 扩展程序
-
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.
安全性
-
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
描述
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 Java 扩展程序
-
UiPath JavaScript 机器人插件
-
UiPath Citrix 扩展程序
-
UiPath extension for Chrome (*)
-
UiPath extension for Edge Chromium (*)
-
Firefox 版 UiPath 扩展程序
-
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.
安全性
-
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 和 Assistant
-
用户模式机器人
-
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 附加项
-
Microsoft 远程桌面扩展程序
-
-
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
描述
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 (*)
-
Firefox 版 UiPath 扩展程序
-
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.
安全性
-
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
描述
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 Java 扩展程序
-
UiPath JavaScript Robot Add-on (*)
-
UiPath Citrix 扩展程序
-
UiPath extension for Chrome (*)
-
UiPath extension for Edge Chromium (*)
-
Firefox 版 UiPath 扩展程序
-
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.
安全性
-
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
描述
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 Java 扩展程序
-
UiPath JavaScript 机器人插件
-
UiPath Citrix 扩展程序
-
UiPath extension for Chrome (*)
-
UiPath extension for Edge Chromium (*)
-
Firefox 版 UiPath 扩展程序
-
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.
安全性
-
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.
最佳实践
-
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^%备注: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.
命令 |
描述 |
---|---|
|
|
|
|
|
|
|
以下选项在按用户安装中不可用:RegisterService、CitrixExtension、VMwareExtension、PACKAGES_FOLDER、CODE。 |
SAP_SOL_MAN_HOST (exclusively for UiPath.Studio.msi )
|
|
|
|
|
备注:
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 和 CLIENT_SECRET |
|
|
注意:旧的安装方法名称(
STORE 和 GLOBAL )会保留下来,以保持向后兼容性。
|
|
注意:旧的安装方法名称(
STORE 和 GLOBAL )会保留下来,以保持向后兼容性。
|
|
|
|
|
|
|
|
|
|
|
|
|
ASSISTANT_OPTIONS |
|
ORCHESTRATOR_AUTO_SIGNIN |
|
ENFORCE_DEFAULT_SERVICE_URL |
|
Update or modifying existing installations - command line parameters
UiPath.Studio.msi
from the command line.
命令 |
描述 |
---|---|
Not supported for changing an existing installation. |
|
|
|
|
|
Not supported for changing an existing installation. |
备注:
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.
参数 |
描述 |
示例 |
---|---|---|
|
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.
重要提示:
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.
- 在 Windows 操作系统上安装
- About 32-bit and 64-bit versions
- About quick and custom installations
- 使用 UiPath.Studio.msi
- 使用 UiPath.Robot.msi
- 使用命令提示符
- The live streaming feature
- 在 Mac 上安装
- MacOS automations - particularities and limitations
- 在 Linux 上安装
- The Docker image tag
- Linux automations - particularities
- Parameters for the
docker run
command - Orchestrator connection failure
- Configuring package feeds
- 远程调试