Studio user guide

• application level - feeds are configured from the Settings > Manage Sources tab;
• project level - feeds are configured from the Manage Packages button in the ribbon.

• 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.

  All Marketplace activities are verified by UiPath and must pass the Marketplace Security Certification.

  

  Note:

  Feed configuration is persisted upon upgrading to a later Studio version.

• Official US (including Automation Cloud for Public Sector) - A replica of the official online UiPath feed. This feed prevents downloading packages from locations outside of the United States and has the following source: https://pkgs.dev.azure.com/uipath-us/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json.

Adding Custom Feeds​

1. In the Manage Packages window, click on the Settings. The package sources are displayed.

   

2. Click on the button to add a feed to the User defined package sources category.

3. Fill in the name of the package source or the name of the NuGet feed.

4. In the Source field, type the local drive folder pathway, the shared network folder pathway or the URL of the NuGet feed.

5. Click on Add. The new feed is automatically added among the User defined package sources and in the All Packages category of the Manage Packages window. The feed is enabled by default.

6. Click Save to apply all changes.

Adding Secure Feeds​

<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>

Removing Custom Feeds​

1. In the Settings category, click on any of the feeds under the User defined package sources section.
2. Press the Remove button. The feed is removed from the All Packages category and the User defined package sources section.
3. Click on Save to apply the changes.

Connecting to Feeds Through a Proxy Server​

1. Download nuget.exe from https://www.nuget.org/downloads.
2. Open a command prompt window in the folder where nuget.exe was downloaded and run the following commands to configure the address, username, and password for the proxy server:

   nuget.exe config -set http_proxy=<http://proxy.server.address:port>

   nuget.exe config -set http_proxy.user=<mydomain\myUserName>

   nuget.exe config -set http_proxy.password=<myPassword>

3. Check that the NuGet.config file located in %AppData%\NuGet has been updated with the new configuration:
   assignment

   <config>
       <add key="http_proxy" value="http://proxy.server.address:port" />
       <add key="http_proxy.user" value="mydomain\myUserName" />
       <add key="http_proxy.password" value="myEncryptedPassword" />
   </config>
   <config>
       <add key="http_proxy" value="http://proxy.server.address:port" />
       <add key="http_proxy.user" value="mydomain\myUserName" />
       <add key="http_proxy.password" value="myEncryptedPassword" />
   </config>
   

4. Restart Studio.

Managing Packages​

Installing Packages​

1. In the Manage Packages window select the All Packages category. This opens a list of all packages gathered from your feeds.

   

2. Locate the package you want to install. Please note that the activities packages and versions that are available depends on the compatibility selected for the project.

• Scroll down the list to find the package.
• Search for the package by typing part of its name or description in the search bar.
• Filter the list by clicking the Filter icon next to the search bar, and then selecting only the options you want to see:
  • Include Prerelease - Include beta versions of packages, where available.
  • UiPath Only - List only packages published by UiPath.
  • Activities Only - List only activities packages.
  • Libraries Only - List only libraries.
  • UI Libraries Only - List only UI Libraries published from the Object Repository.
  • Compatible Only - List only packages whose latest version is compatible with the project's compatibility. Do not select this option if you want to see packages with older versions that are compatible with the project's compatibility.

3. Select an activity package to view its description, version, dependencies, the project URL and the date when it was published.
4. Click on the drop-down list next to Version to pick a version of the package, and then set a Runtime Rule. To read more about runtime rules for project dependencies check the Managing Dependencies page.
5. Click on the Install button. Alternatively, click on the icon next to the package name to mark it with the icon, making it ready for installation.
   Note:

   Terms and conditions for third-party packages and their dependencies are implicitly accepted when installing the package. Terms and conditions for UiPath packages and their dependencies are implicitly accepted when installing Studio. Read the UiPath Terms of Use and Privacy Policy.

6. Click Save to install the packages or update the versions.
   Note:

   If during the installation of an activity package the path gets corrupted, the installation doesn’t complete. It is recommended to backup and then clear the content of the following local folders %userprofile%\.nuget\packages and %userprofile%\AppData\Local\UiPath\.cache.

Uninstalling packages​

Downgrading packages​

Changing the Download Folder for Packages​

• During installation, by installing from the command line with the option PACKAGES_FOLDER.
• After installation, by manually editing the uipath.config file:
  1. Open the uipath.config file in a text editor. By default, the file is located in C:\Program Files\UiPath\Studio.
  2. In the packageSettings node, add the packagesInstallationFolder key with the path to the new folder as its value.
  3. Save the changes and, if the Robot is installed as a service, restart the service.

 ```
 <packageSettings>
   <add key="packagesInstallationFolder" value="C:\Nuget" />
 </packageSettings>
 ```
 ```
 <packageSettings>
   <add key="packagesInstallationFolder" value="C:\Nuget" />
 </packageSettings>
 ```

Managing Packages In Offline Environments​

1. On a computer with internet access, download and install NuGet Package Explorer.
2. Open NuGet Package Explorer and select Open a package from an online feed.
3. 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.
4. Locate the package in the feed and download it.
5. 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.

Using the Archive with Optional Packages​

• UiPath.MobileAutomation.Activities
• UiPath.Terminal.Activities
• UiPath.Persistence.Activities
• UiPath.PDF.Activities

1. Download the ZIP archive from the UiPath Customer Portal.
2. Place the archive in a location accessible from the Studio or Robot machine.
3. 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.

Managing Connectors​

• A detailed description of the connector.

• The categories to which the connector belongs.

• The connector's owner(s).

• A link to the connector's documentation page.

• The activities provided with the connector.

• The triggers provided with the connector.

  

1. Select the Add to project or Remove from project button next to each connector in the list of available connectors. An icon tells you that a connector is pending installation.
2. Select the Save button at the bottom of the Manage Packages window. The connector is added to the project and is visible under the Installed category in the Activities panel.

1. Grouped by:
   • UiPath - List only connectors created by UiPath.
   • My organization - List only connectors created by your organization.
   • Me - List only connectors created by you.
2. Version:
   • Preview - List only connectors that are in preview.