- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- About Dependencies
- Managing Dependencies
- Mass Update Command Line Parameters
- Missing or Invalid Activities
- 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-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
- Variables
- Arguments
- Imported Namespaces
- Coded automations
- Introduction
- Registering custom services
- Before and After contexts
- Generating code
- Generating coded test case from manual test cases
- Trigger-based Attended Automation
- Recording
- UI Elements
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Automating Citrix Technologies
- RDP Automation
- VMware Horizon Automation
- Salesforce Automation
- SAP Automation
- macOS UI Automation
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- 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 packages and UiPath Remote Runtime versions mismatch
- The required UiPath extension is not installed on the remote machine
- Screen resolution settings
- Chrome 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
- Edge 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 VMware Horizon
- Extension for Amazon WorkSpaces
- SAP Solution Manager plugin
- Excel Add-in
- Test Suite - Studio
- Troubleshooting
Mass Update Command Line Parameters
project.json
files belonging to multiple automation projects. It allows for adding or removing dependencies, changing package versions
and runtime rules, and signing processes or libraries before publishing them.
Please note that when using the Project Dependencies Mass Update Tool, you implicitly accept the license terms of each package version that you update.
UiPath.Studio.CommandLine.exe
is available in the installation folder:
- For per-machine installations, the default path is
C:\Program Files\UiPath\Studio\
. -
For per-user installations, the default path is
%localappdata%\Programs\UiPath\Studio
.
--help
. Use --version
to check the version of
UiPath.Studio.CommandLine.exe
.
r, --repository
when used with svn login
and svn checkout
.
It is recommended to save and close projects from Studio, before making changes to them using the Project Dependencies Mass Update Tool.
-
list
- Find and display the paths toproject.json
files stored in a certain directory. Projects from a local network drive can also be listed. The following arguments should be used with thelist
command:Argument
Description
-d, --directory
The directory that stores the files that you want to list. Use-u, --user
and-p, --pass
arguments for password-protected remote directories.Note: If the--directory
argument is not used with thelist
command, the paths to allproject.json
files from the current working directory are displayed. -
manage
- Manage the specified project. Please note that multiple dependencies and rules can be added or removed provided that they are separated by blank spaces. The following arguments should be used with themanage
command:Argument
Description
-a, --add-ref
Adds or updates the dependency and runtime rule to theproject.json
file.”dependencyname|version|runtimerule”
= adds or updates the dependency version and runtime rule.”dependencyname|prereleaseversion|runtimerule”
= adds the dependency’s prereleased version and the specified runtime rule.
r, --rem-ref
Removes the specified dependencies from theproject.json
file."dependencyname"
- the dependency to be removed from the project, regardless of its version."dependencyname|version"
- removes the dependency with this specific version, regardless if it’s a prerelease version.
-p, --project-path
The path to theproject.json
file.Note: The syntax for runtime rules islowest
for Lowest Applicable Version, andstrict
for Strict version. If none of these two parameters are mentioned, the Lowest Applicable Version is applied by default.
manage --project-path "C:\Users\username\Documents\UiPath\BlankProcess\project.json" --add-ref "UiPath.Excel.Activities|2.6.2|lowest"
changes the package version to 2.6.2 and the runtime rule to Lowest Applicable Version.
-
publish
- Publish the project along with the changes to dependencies. The following arguments should be used with thepublish
command:Argument
Description
-p, --project-path
The path to theproject.json
to publish. The argument is mandatory.-g, --target
Where to publish the project:
Custom
- Custom URL or local folder. Define the location using the-f, --feed
argument.Robot
- Default publish location for the Robot, if not connected to Orchestrator. Not available for publishing libraries or templates.OrchestratorTenant
- Orchestrator Tenant Processes Feed (for processes and test cases) or Orchestrator Libraries Feed (for libraries and templates).OrchestratorPersonalFolder
- Orchestrator Personal Workspace Feed. Not available for publishing libraries, templates, or test cases.OrchestratorFolderHierarchy
- If a first-level folder with a separate package feed or one if its subfolders is selected from the folders menu in the Studio status bar, the feed for that folder hierarchy. Not available for publishing libraries or templates.
-f, --feed
The custom URL for publishing the project. This can also be a custom local directory, similar to the path in the Publish options tab in Studio.
-a, --api-key
The API key for publishing the project. This argument can be used for a custom target.
-i, --icon
Path to the custom icon to use for the package.
-n, --notes
Release notes that contain changes brought to the project.
-v, --new-version
The new version for the project.
-t, --timeout
Specifies the timeout value for publishing projects. The default timeout is 30 seconds. This setting only applies for the package transfer to Orchestrator duration.
--cer-path
The local path to the certificate for package signing.
--cer-password
The password for the certificate.
--timestamper-url
The URL to the timestamper.
--incl-all-feeds
Not required.
Note: Currently.pfx
and.p12
certificate extensions are accepted for signing projects. For more details, check out the Signing Packages page.
UiPath.Excel.Activities
pack to version 2.6.2, changes the runtime rule to Lowest Applicable Version, adds release notes and a new version, and publishes
the project to a custom location:
manage --project-path "C:\Users\username\Documents\UiPath\BlankProcess\project.json"
--add-ref "UiPath.Excel.Activities|2.6.2|lowest" publish --project-path
"C:\Users\username\Documents\UiPath\BlankProcess\project.json" --target Custom --feed
"C:\Users\username\Desktop\myfeed" --notes "Changes were made to the Excel package"
--new-version "1.0.2"
.
Command-line parameters can be used for analyzing files or projects against a set of rules.
analyze
- Analyzes the whole project. Requires the path to theproject.json
file.-
analyze-file
- Analyzes a single file. Requires the path to the.xaml
file.Argument
Description
-p, --project-path
For analyzing one file, provide the path to the.xaml
. For analyzing the entire project, specify the path to theproject.json
file.-c, --config-path
Path to theRuleConfig.json
file. Specify this path only if the rule configuration file is not placed in the default location (%LocalAppData%\UiPath\Rules
).
Read the About Workflow Analyzer page to find out more about how to analyze files/projects and configure rules using command-line parameters.
-
git clone
= Clone a repository into a new directory.Note: Before you runUiPath.Studio.CommandLine.exe git clone
, make sure the credentials for the repository are already stored in the Windows Credential Manager. Otherwise, an authentication error occurs.
git clone
command:
Argument |
Description |
---|---|
|
The repository address/URL that stores the projects that you would like to modify. The argument is mandatory. |
|
The working directory. If not specified, the current environment directory is used. |
-
git commit
= Record changes to the repository. The following arguments should be used with thegit commit
command:Argument
Description
-m, --message
Write a commit message to detail the changes brought to the projects. The commit message is mandatory.
-p, --push
Upload changes to the remote repository.
-d, --directory
The working directory. If not specified, the current environment directory is used.
-f, --files
The paths to the files that you want to edit. The paths should be relative to the working directory and separated by semicolons.
-
svn login
= Use credentials to login to a certain SVN repository. The following arguments should be used with thesvn login
command:Argument
Description
r, --repository
The repository address/URL that stores the projects that you would like to modify. The argument is mandatory.
-p, --password
The password required for authentication to the SVN repository.
-s, --password-stdin
Reads the authentication password from STDIN (standard input). You are prompted to input the password to the desired repository.
u, --user
The username required for authentication.
-
svn checkout
= Check out projects from a SVN repository. The following arguments should be used with thesvn checkout
command:Argument
Description
-d, --directory
The destination checkout folder for the files. The argument is mandatory.
-r, --repository
The address of the repository that stores the files you want to checkout. The argument is mandatory.
-
svn edit
= Unlock one or multiple projects and make them available for edit. The following arguments should be used with thesvn edit
command:Argument
Description
-f, --files
The paths to the files that you want to edit. The paths should be relative to the working directory and separated by semicolons. The argument is mandatory.
-d, --directory
The working directory which contains the files that you want to edit. If a working directory isn’t specified, the current environment directory is used.
-
svn checkin
= Check in the changes made to automation projects. The following arguments should be used with thesvn checkin
command:Argument
Description
-m, --message
Write a commit message to detail the changes brought to the projects. The commit message is mandatory.
-d, --directory
The working directory where the projects are being checked in. If a working directory isn’t specified, the current environment directory is used.
-f, --files
The paths to the files that you edited. The paths should be relative to the working directory and separated by semicolons.
-
tfs login
= Use credentials to login to a certain TFS repository. The following arguments should be used with thetfs login
command:Argument
Description
-t, --type
The login method for the TFS repository:
ntlm
= authentication through NT LAN Manager on a local TFS repository.token
= authentication using a personal access tokens enabled on the TFS repository.basic
= basic authentication on a secure TFS repository.
-p, --password
The password required for authentication to the SVN repository.
-s, --password-stdin
Reads the authentication password from STDIN (standard input). You are prompted to input the password to the desired repository.
u, --user
The username required for authentication.
-c, --collection
Refers to the collection URI. The argument is mandatory.
-
tfs checkout
= Check out projects from a TFS repository. The following arguments should be used with thetfs checkout
command:Argument
Description
-c, --collection
Specify the collection URI.
-d, --directory
The destination checkout folder for the files. The argument is mandatory.
-r, --remotedir
The path to the project directory, relative to the collection root. It starts with$/
and is preceded by the collection URI. -
tfs edit
- Unlock one or multiple projects and makes them available for edit. The following arguments should be used with thetfs edit
command:Argument
Description
-f, --files
The paths to the files that you want to edit. The paths should be relative to the working directory and separated by semicolons.
-d, --directory
The working directory which contains the files that you want to edit. If a working directory isn’t specified, the current environment directory is used.
-
tfs checkin
- Check in the changes made to automation projects. The following arguments should be used with thetfs checkin
command:Argument
Description
-m, --message
Write a commit message to detail the changes brought to the projects. The commit message is mandatory.
-d, --directory
The working directory where the projects are being checked in. If a working directory isn’t specified, the current environment directory is used.
-f, --files
The paths to the files that you edited. The paths should be relative to the working directory and separated by semicolons.
When installing a dependency using the command-line user interface to an automation projects created in a Studio version prior to v2018.3, please take into account the following particularities:
- If the project was not published and consequently, it doesn’t have any installed dependencies, the migration process steps in and installs the default packages, detailed in the Managing Dependencies page.
- If the project was created and published with a Studio version prior to v2018.3, the
UiPath.Core.Activities
package is migrated toUiPath.System.Activities
andUiPath.UIAutomation.Activities
.