- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- Types of Workflows
- File Comparison
- Automation Best Practices
- Source Control Integration
- Debugging
- 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-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
- Variables
- Arguments
- Imported Namespaces
- Trigger-based Attended Automation
- Recording
- UI Elements
- Control Flow
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Citrix Technologies Automation
- RDP Automation
- Salesforce Automation
- SAP Automation
- VMware Horizon Automation
- Logging
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- Test Suite - Studio
- Extensions
- Troubleshooting
- About troubleshooting
- 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
- Automating Applications Running Under a Different Windows User
- Validation of large Windows-legacy projects takes longer than expected
Managing activity packages
Studio uses NuGet feeds to install activity packages. These feeds can be handled in two ways in Studio:
- application level - feeds are configured from the Settings > Manage Sources tab;
- project level - feeds are configured from the Manage Packages button in the ribbon.
To disable an activities feed, you must clear its corresponding checkbox. Enabling or disabling a feed is applicable both at project and application level.
The following feeds are configured by default in Studio:
- Orchestrator Tenant and
Orchestrator Host - These activities feeds are added by default if your
Robot is connected to Orchestrator and they cannot be disabled. The Orchestrator
Tenant option is available only if the tenant libraries feed is enabled in
Orchestrator. The feeds have the following source:
https://[Orchestrator_host]/nuget/activities
. -
Local - The feed for the packages installed locally with Studio. The feed has the source:
%ProgramFiles%\UiPath\Studio\Packages
for per-machine installations or%localappdata%\Programs\UiPath\Studio\Packages
for per-user installations.Note: The publish date displayed in the Manage Packages window for packages from the local feed is the date when the Studio installer was built, not the date when the packages were published. - Official - The official online
UiPath® feed, where you can find the activity packages that are officially
supported by us. This feed has the following source:
https://pkgs.dev.azure.com/uipath/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json
. -
Marketplace - This public feed contains all the activities published on the UiPath Marketplace. Please note that whether or not packages are built and officially supported by UiPath is specifically stated in the Manage Packages window, Package Information tab. This feed has the following source:
https://gallery.uipath.com/api/v3/index.json
.Please be aware that UiPath has no control over the unlisting of packages created by partners or the Marketplace community. However, UiPath keeps unlisted packages active to ensure backward compatibility for runtime purposes.
Note: Feed configuration is persisted upon upgrading to a later Studio version.
Other feeds can be added separately, such as:
- Public Sector - This feed is specific for Automation Cloud for Public
Sector and it is hosted in the United States. This feed has the following
source:
https://govcloud.uipath.us/nuget/v3/_shared/libraries/index.json
.
Feed management and configuration is available in the Manage Packages window if a governance policy was not enforced. If such a policy is enforced and contains restricted rights regarding feed management, then a message is displayed in the window. Read more about Governance.
UiPath.settings
file under
the ActivitiesFeed property instead of using the method
below.
User defined and default package sources can be enabled or disabled from the Manage Packages window.
Please note that feeds are added on the spot. Clicking the Close or Cancel button after adding a feed does not revert changes.
If you want to add a custom NuGet feed that requires authentication, you can follow the steps explained here.
NuGet.config
file, located at the following path: %AppData%\NuGet
. When it’s done, the feed should be visible in the Manage Packages window.
<packageSources>
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
<add key="FeedName" value="https://FeedSource" />
</packageSources>
<packageSourceCredentials>
<FeedName>
<add key="Username" value="YourUsername" />
<add key="Password" value="YourPassword" />
</FeedName>
</packageSourceCredentials>
<packageSources>
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
<add key="FeedName" value="https://FeedSource" />
</packageSources>
<packageSourceCredentials>
<FeedName>
<add key="Username" value="YourUsername" />
<add key="Password" value="YourPassword" />
</FeedName>
</packageSourceCredentials>
key="ClearTextPassword"
should replace key="Password"
when unencrypted passwords are used.
- In the Settings category, click on any of the feeds under the User defined package sources section.
- Press the Remove button. The feed is removed from the All Packages category and the User defined package sources section.
- Click on Save to apply the changes.
Please note that feeds are removed on the spot. Clicking the Close or Cancel button after removing default or custom feeds does not revert changes.
If your computer is behind a proxy server, you must configure NuGet proxy settings to have access to feeds located outside of your network:
The package manager functionality enables you to download activity packages, libraries, frameworks, wrappers and others, view the ones already installed for your project and update them, as well as add and remove your own. It shows the list of available packages per feed and the list of dependencies per current project. The Manage Packages window always opens with the Project Dependencies list.
UiPath.Excel.Activities, UiPath.Word.Activities
) or a category of apps (UiPath.Mail.Activities, UiPath.Terminal.Activities
), or use certain technologies in your automations (UiPath.OCR.Activities, UiPath.FTP.Activities
).
Details about packages and libraries are displayed in the right panel of the Manage Packages window, as you can see in the screenshot above.
The Include Prerelease checkbox next to the Search bar, displays the beta versions of library packages, if available, when selected.
Check the Include Prerelease box if descriptions for the project's dependencies are not visible in the Manage Packages window.
UiPath.UIAutomation.Activities
and UiPath.System.Activities
packages are compatible with Studio v2018.3 and above.
Uninstalling packages
To uninstall packages, go to the Project Dependencies category, and click the Uninstall button next to the package that you no longer want to use. The package is removed only after you click on Save.
When running an automation project, the Manage Packages button is disabled, meaning that activity packages cannot be installed or removed until the execution has stopped.
Downgrading packages
Downgrading activity packages is not recommended. The main reason is the negative effects it can have on dependencies. Dependencies between different activity packages are carefully managed in each version. Therefore, downgrading might cause inconsistencies, or even dysfunctional workflows. Moreover, newer activity packages offer improved features and functionalities that might not be available in older versions. Thus, to ensure optimal performance and avoid potential errors, it is advisable to keep activity packages at their current versions or upgrade to the latest versions.
%userprofile%\.nuget\packages
folder. You can set a different folder in one of the following ways:
- During installation, by installing from the command line with the option
PACKAGES_FOLDER
. -
After installation, by manually editing the
uipath.config
file:- Open the
uipath.config
file in a text editor. By default, the file is located inC:\Program Files\UiPath\Studio
. - In the
packageSettings
node, add thepackagesInstallationFolder
key with the path to the new folder as its value. -
Save the changes and, if the Robot is installed as a service, restart the service.
For example, add the following touipath.config
to change the download location toC:\nuget
.<packageSettings> <add key="packagesInstallationFolder" value="C:\Nuget" /> </packageSettings>
<packageSettings> <add key="packagesInstallationFolder" value="C:\Nuget" /> </packageSettings>
- Open the
.nuget
folder causes
dependency conflicts when opening a project in
Studio.
To install a package on an offline Studio machine:
- On a computer with internet access, download and install NuGet Package Explorer.
- Open NuGet Package Explorer and select Open a package from an online feed.
-
In the Package source field, enter the URL of the feed from which to download
the package. The official UiPath packages feed is
https://pkgs.dev.azure.com/uipath/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json
. - Locate the package in the feed and download it.
-
Transfer the NUPKG file to the Studio computer in a folder defined as a package source
in Studio. To add the package to the default local feed, copy the file to
%ProgramFiles%\UiPath\Studio\Packages
for per-machine installations or%localappdata%\Programs\UiPath\Studio\Packages
for per-user installations.
To reduce the size of the Studio installer, a number of activity packages are no longer included in the UiPathStudio.msi file starting with the 2022.10 release. To make it easier for users who are working in air-gapped environments or always keep the packages they need in local storage, a ZIP archive with the packages no longer included in the installer and their dependencies is available for download from the Customer Portal, enabling you to place the packages on Studio or Robot machines.
The archive contains the latest versions of the following packages:
- UiPath.MobileAutomation.Activities
- UiPath.Terminal.Activities
- UiPath.Persistence.Activities
- UiPath.PDF.Activities
To add the packages to the local feed folder:
- Download the ZIP archive from the UiPath Customer Portal.
- Place the archive in a location accessible from the Studio or Robot machine.
-
Add the packages in one of the following ways:
- During installation - Before starting the installation, place the archive in the same root folder as the Studio MSI installer. The packages are added to the local feed folder by the installer.
- After installation - Extract the contents of the archive to the local
packages folder, by default:
%localappdata%\Programs\UiPath\Studio\Packages
for per-user installations.%ProgramFiles%\UiPath\Studio\Packages
for per-machine installations.