Robot admin guide

Command Line Arguments Descriptions​

• /q - Installs the specified UiPath features silently, without displaying the user interface.
• /l*vx <LogFile> - Generates an installer log file at the specified path. You can send the file further to our support team if, for any reason, you encounter difficulties during the installation process.
• ADDLOCAL - Allows selecting the features to install. Without this parameter, the following features are installed by default: Robot in Service Mode, Default activity packages, and JavaScript Add-on. It supports the following options:
  • DesktopFeature— Indicates that you want to install the Robot feature.
  • Studio (exclusively for UiPathStudio.msi) — Installs Studio. Must be used together with the DesktopFeature parameter.
  • ExcelAddin (exclusively for UiPathStudio.msi) — Installs the StudioX Excel Add-in. Must be used together with the Studio parameter.
  • Robot — Installs the Robot in User Mode or Service Mode, as well as the Assistant. Must be used together with the DesktopFeatureparameter.
  • RegisterService — Required for Service Mode installations. Do not add it for User Mode installations.
  • StartupLauncher — Runs the Robot at Windows startup. Must be used together with the DesktopFeature parameter.
  • Packages (exclusively for UiPathStudio.msi) — Installs the default activity packages. Must be used together with the Robot parameter.
  • JavaBridge — Installs the UiPath Java Bridge for better integration and automation with Java applications. Adding this may increase installation time. Must be used together with the Robot parameter.
  • ChromeExtension — Installs the Google Chrome Extension. Must be used together with the Robot parameter.
  • FirefoxExtension — Installs the Firefox extension. Must be used together with the Robot parameter.
  • EdgeExtension — Installs the Microsoft Edge Chromium-based Extension. Must be used together with the Robot parameter.
  • CitrixClient — Installs the UiPath Citrix Client Extension. Must be used together with the Robot parameter. Not available for per-user installations.
  • JavaScriptAddOn — Installs the Browser Embedding add-on. Must be used together with the Robot parameter. Cannot be used with elevated rights.
  • SapPlugin (exclusively for UiPathStudio.msi) — Installs the SAP Solution Manager plugin. Requires the SAP Connector for Microsoft to be installed on your machine. On clean installs, you must also provide an address for the instance using the SAP_SOL_MAN_HOST parameter. Must be used together with the Studio parameter. Not available for per-user installations.
  • VMwareExtension — Installs the UiPath extension for VMware Horizon. Must be used together with the Robot parameter. Not available for per-user installations.
  • WindowsRdpExtension — Installs the UiPath extension for Windows Remote Desktop. Must be used together with the Robot parameter.
• MSIINSTALLPERUSER - Enables you to install only for the current user.
  • To install per user, add MSIINSTALLPERUSER=1. The following options are not available in per-user installations: RegisterService, CitrixExtension, VMwareExtension, PACKAGES_FOLDER, CODE.
  • To install per machine, do not include this parameter.
• SAP_SOL_MAN_HOST (exclusively for UiPathStudio.msi) - The hostname or IP address of your SAP Solution Manager instance. Required for clean installations where the SapPlugin parameter was added in the ADDLOCAL option.
• APPLICATIONFOLDER - Enables you to install the Robot in a custom location.
• NUGET_OPTIONS - For offline environments. If set to DisableOnlineFeeds, this parameter disables the online UiPath official and Community feeds for the Robot, and uses Orchestrator and local feeds exclusively.
  Note:

  The URL feeds remain in the configuration files, but are ignored.

• PACKAGES_FOLDER
  • Enables you to change the download location for your workflows and their dependencies. The chosen folder can be user-specific or accessible by all users on a machine.
  • Without this parameter, the default download location is %userProfile%\.nuget\packages.
  • Not available for per-user installations.
    Note:

    Make sure that all users that need to execute processes have read access to the new folder.

  • For installations on Windows Server machines that enable concurrent execution, you must provide paths that are specific to each user. Read more about .
  • Find out how to change the download folder for packages after installation.
• CUSTOM_NUGET_FEEDS - Enables you to add custom NuGet activities feeds for Studio and/or Robot. This command only adds or updates the existing list of feeds. It must be populated with key-value pairs of type string:
  • Valid locations include online feeds, folder paths, and shared network drives.
  • Make sure that the provided feeds are accessible by all users on a given machine.
  • Separate feeds with semicolons (;). For example:
    assignment

    CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\"
    CUSTOM_NUGET_FEEDS="FeedName1,https://my.custom.nuget.feed; FeedName2,D:\Custom\Activities\Packages\"
    

• ENFORCE_SIGNED_EXECUTION - Optional. Enables you to enforce your Robots to execute only signed packages. Without this parameter, package signing is not enabled. It has the following options:
  • 1 - The Robot only handles packages signed by UiPath-verified authors or repositories. To add your own certificate as a trusted source, modify the nuget.config file.
  • 0 - No package signing rule is enforced on your Robot deployment.For more details, see Signing Packages.
• CODE - Licenses your Robot instance. Not available for per-user installations.
• CLIENT_ID and CLIENT_SECRET - Automatically connects the Robot to Orchestrator using client credentials, while also installing it. For example:
  assignment

  UiPathRobot.msi ORCHESTRATOR_URL=https://demo.uipath.com/company/tenant/orchestrator_ CLIENT_ID=1234-abcd-1ab2-cd32-1111 CLIENT_SECRET=2143ndafj32k
  UiPathRobot.msi ORCHESTRATOR_URL=https://demo.uipath.com/company/tenant/orchestrator_ CLIENT_ID=1234-abcd-1ab2-cd32-1111 CLIENT_SECRET=2143ndafj32k
  

• CHROME_INSTALL_TYPE - Allows you to choose the installation method for the Chrome extension. Needs admin rights. Without this parameter, the most appropriate method is selected automatically. It has the following options:
  • POLICYOFFLINE - The Chrome Extension is automatically installed per system via the Group Policy Offline method, the equivalent of calling the /Chrome-Policy-Offline command using the SetupExtensions tool.
  • POLICYONLINE - The Edge Extension is automatically installed per system via the Group Policy Online method, the equivalent of calling the /Edge-Chromium-PolicyGlobal command using the SetupExtensions tool.
  • MANUALPERMACHINE - The Chrome Extension is installed for all users, the equivalent of calling the /ChromeGlobal command using the SetupExtensions tool.
  • NATIVEHOSTONLY - Only the Native Messaging Host component (ChromeNativeMessaging.exe) is installed, the equivalent of calling the /ChromeNativeHostGlobal command using the SetupExtensions tool.
  Note:

  The old installation methods names (STORE, GLOBAL) are kept for backwards compatibility.

• EDGE_INSTALL_TYPE - Allows you to choose the installation method for the Edge extension. Needs admin rights. Without this parameter, the most appropriate method is selected automatically. It has the following options:
  • POLICYOFFLINE - The Edge Extension is automatically installed per system via the Group Policy Offline method, the equivalent of calling the /Edge-Policy-Offline command using the SetupExtensions tool.
  • POLICYONLINE - The Edge Extension is automatically installed per system via the Group Policy Online method, the equivalent of calling the /Edge-Chromium-PolicyGlobal command using the SetupExtensions tool.
  • MANUALPERMACHINE - The Edge Extension is installed for all users, the equivalent of calling the /Edge-Chromium-Global command using the SetupExtensions tool.
  • NATIVEHOSTONLY - Only the Native Messaging Host component (ChromeNativeMessaging.exe) is installed, the equivalent of calling the /Edge-Chromium-NativeHostGlobal command using the SetupExtensions tool.
  Note:

  The old installation methods names (STORE, GLOBAL) are kept for backwards compatibility.

• DISABLE_SECURE_XAML - Allows you to disable 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. It has the following options:
  • 0 - The default option. Enables security for XAML files for Windows service Robots.
  • 1 - Disables security for XAML files for Windows service Robots.
• SERVICE_URL - Allows you to define the URL of the Orchestrator instance to connect to using Interactive Sign-In. This value is saved in the uipath.config file. Required by User Mode installations. Service Mode installations ignore this parameter.
• ORCHESTRATOR_URL - In clean installations, you can specify the main Orchestrator URL, used for retrieving auto-update information. For example: https://orchestrator.local/organizationName/tenantName.
• TELEMETRY_ENABLED - Allows you to disable the usage data collection. It has the following options:
  • 0 - Disables the telemetry for Studio and Robot.
  • 1 - Default option. Enables the telemetry for Studio and Robot.Find out how to opt out of telemetry.
• ENABLE_PIP - Allows you to enable the Robot session (Picture in Picture) functionality of the machine. It has the following options:
  • 0 - Default option. The Robot session capability is disabled.
  • 1 - Enables the Robot session capability.
• INSTALLER_LANGUAGE - Enables you to select the display language of the installer. Without this parameter, the installer uses the language settings in Windows. It has the following options:
  • 2052 - Chinese (Simplified)
  • 12 - French
  • 7 - German
  • 17 - Japanese
  • 1 - Korean
  • 22 - Portuguese (Portugal)
  • 1046 - Portuguese (Brazil)
  • 25 - Russian
  • 10 - Spanish (Spain)
  • 2058 - Spanish (Mexico)
  • 31 - Turkish
• ASSISTANT_OPTIONS - Enables or disables the Marketplace widget for Assistant. It has the following options:
  • Absent or EnableMarketplace - The default option. Enables the widget.
  • DisableMarketplace - Disables the widget.
• ORCHESTRATOR_AUTO_SIGNIN - Enables automatic sign-in to your account. For User Mode installations and environments configured to use the SSO with Azure Active Directory. Must be used together with the ORCHESTRATOR_URL parameter. It has the following options:
  • 0 - Disables the automatic sign-in.
  • 1 - Enables the automatic sign-in.

Using paths in command line​

• If you need to use environment variables such as %USERNAME% or %USERPROFILE%, the % special character needs to be escaped as follows:
  • When the setup is invoked from Command Prompt, use ^ - UiPathRobot.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^%.
  • In batch scripts, use ^ - UiPathRobot.msi PACKAGES_FOLDER=C:\Some\Path\^%USERNAME^%.
  • In PowerShell console or scripts - no escaping is needed.
  • When using Active Directory domain accounts, it is recommended to specify the domain name in the folder structure too, such as C:\packages\^%UserDomain^%.^%Username^%.
• If you need to use paths with spaces, they must be wrapped as follows:
  • In Command Prompt, surround with double quotes (" "). For example, UiPathRobot.msi APPLICATIONFOLDER="C:\folder name".
  • In PowerShell, surround with single and double quotes ('" "'). For example,./UiPathRobot.msi APPLICATIONFOLDER='"C:\folder name"'.

Performing a Synchronous Installation​

:: Runnning the MSI synchronously
start /wait /b UiPathRobot.msi /Q
:: Assert the exit code and continue accordingly
set "_isSuccess="
if %ERRORLEVEL% EQU 0 Set "_isSuccess=1"
if %ERRORLEVEL% EQU 1641 Set "_isSuccess=1"
if %ERRORLEVEL% EQU 3010 Set "_isSuccess=1"
:: test for success and run follow-up commands
if (%_isSuccess% EQU 1) (
    echo "success"
) ELSE (
    echo "fail"
)
:: Runnning the MSI synchronously
start /wait /b UiPathRobot.msi /Q
:: Assert the exit code and continue accordingly
set "_isSuccess="
if %ERRORLEVEL% EQU 0 Set "_isSuccess=1"
if %ERRORLEVEL% EQU 1641 Set "_isSuccess=1"
if %ERRORLEVEL% EQU 3010 Set "_isSuccess=1"
:: test for success and run follow-up commands
if (%_isSuccess% EQU 1) (
    echo "success"
) ELSE (
    echo "fail"
)

Examples​

• Install the Robot in user mode only for the current user
  assignment

  UiPathRobot.msi MSIINSTALLPERUSER=1 ADDLOCAL=DesktopFeature,Robot
  UiPathRobot.msi MSIINSTALLPERUSER=1 ADDLOCAL=DesktopFeature,Robot
  

• Silently install the Robot
  assignment

  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,StartupLauncher,JavaBridge /Q
  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,StartupLauncher,JavaBridge /Q
  

• Silently install the Robot and the Chrome Extension via policy
  assignment

  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,ChromeExtension CHROME_INSTALL_TYPE=POLICYONLINE /Q
  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,ChromeExtension CHROME_INSTALL_TYPE=POLICYONLINE /Q
  

• Silently install the Robot as a Windows service and connect it to Orchestrator
  assignment

  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CONNECTIONSTRING=https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1 /Q
  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CONNECTIONSTRING=https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1 /Q
  

• Silently install the Robot as a Windows service, and add two custom activity feeds
  assignment

  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CUSTOM_NUGET_FEEDS="Feed Name1,https://my.custom.nuget.feed; FeedName2,D:\RPA\Activities\Packages\" /Q
  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService CUSTOM_NUGET_FEEDS="Feed Name1,https://my.custom.nuget.feed; FeedName2,D:\RPA\Activities\Packages\" /Q
  

• Silently install and license a Robot registered as a Windows service and the local activity feed
  assignment

  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,CODE=1234567890 /Q
  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService,CODE=1234567890 /Q
  

• Install Robot as a Windows service, and disable the official online feeds
  assignment

  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds
  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService NUGET_OPTIONS=DisableOnlineFeeds
  

• Uninstall the Chrome Extension
  assignment

  UiPathRobot.msi REMOVE=ChromeExtension /Q
  UiPathRobot.msi REMOVE=ChromeExtension /Q
  

• Set up the auto-update connection during attended robot installation
  assignment

  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService SERVICE_URL="https://demo.uipath.com/myorg/mytenant"
  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService SERVICE_URL="https://demo.uipath.com/myorg/mytenant"
  

• Set up the auto-update connection during unattended robot installation
  assignment

  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService ORCHESTRATOR_URL="https://demo.uipath.com/myorg/mytenant/orchestrator_"
  UiPathRobot.msi ADDLOCAL=DesktopFeature,Robot,RegisterService ORCHESTRATOR_URL="https://demo.uipath.com/myorg/mytenant/orchestrator_"