UiPath Studio Guide

Managing Dependencies

Project dependencies in Studio refer to packages linked into a specific project, containing activities, either default or custom. Dependencies are contextual and take into consideration each project's definition, including the activities that it uses, variables, input/output arguments. Therefore, a dependency is set only if it has at least one reference in the project's definition.

All project templates available in Studio, including Process, Library, Transactional Process and Robotic Enterprise Framework, come with the following default packages: UiPath.UIAutomation.Activities, UiPath.System.Activities, UiPath.Excel.Activities and UiPath.Mail.Activities.

If more need to be added, click on the Package Manager and install them. Installed dependencies are available only for the current project, and the list of dependencies per project is visible in the project.json file.

Adding and Updating Dependencies

Whenever new versions are available for the current project dependencies, the Manage Packages button from the ribbon gets an update icon image alt text.

  1. To manage dependencies in a project, simply right-click on the Dependencies category in the Project panel, and then click on Manage. This opens the Manage Packages window, with the Project Dependencies category. The image alt text icon shows which packages are currently installed.
  1. Default dependencies are displayed, together with the versions that are currently linked to the project. To update a package, simply click on the update icon image alt text, next to the available version number. The image alt text icon is shown next to the package, meaning that dependencies are ready to be installed.
  2. Dependencies are installed in the project only after you click Save. Simultaneously, the versions of dependencies are updated in the project.json file belonging to the project.

To add dependencies to a project, simply search and install them as you would any activity package. For more information, check the Package Manager.

Removing Dependencies

  1. To remove a project dependency, simply right-click on the dependency in the Project panel.
  2. Select Remove Dependency, the dependency is removed from the Project panel and project.json file.

Alternatively, this can be done by simply clicking on the Uninstall button available for each dependency in the Package Manager > Project Dependencies category.

Repairing Dependencies

If a workflow opened in Studio has references to packages with versions that aren’t available in current Studio feeds, said dependencies are marked as broken in the Project panel and details are made available in the Output panel.

Studio allows for all dependencies to be repaired in bulk or individually. To repair all broken dependencies, right-click on the Dependency node in the Project panel, and click on Repair Dependencies.

Right-click on a broken dependency and select Resolve Dependency to repair it individually. Alternatively, you can select Manage to open the Package Manager and update packages.

NuGet resolves broken dependencies by applying the Lowest Applicable Version image alt text runtime rule, meaning that it searches for the first applicable package version, higher than the one previously set.

Setting Dependency Rules

Activity packages are available in multiple versions, which is why upon installing or updating them using the Package Manager,you can set dependency runtime rules for each of them.

The Runtime Rule specifies which package version to install at runtime. It features two available options.

The Strict runtime rule is the default state dependencies added upon process creation. It means that only the specified version of the package is used at runtime to execute the parent process. The Strict rule is marked in the Project panel, under Dependencies by the image alt text sign next to the package version.

The Lowest Applicable Version runtime rule means that if the target package isn’t found, the next higher version is searched in order to resolve dependencies. The Lowest Applicable Version rule is marked in the Project panel, under Dependencies by the image alt text sign next to the package version.

Resolving Dependency Conflicts

The installation of activities packages takes into consideration dependency runtime rules previously set for said packages, but some conflicts between versions might occur when automating the projects. Both the automation project and the library it contains might have the same activities package, but with different versions and runtime rules. At design time, NuGet resolves such conflicts by choosing the top level dependency, which is the closest to the project in the hierarchy.

The resolution of conflicts that might occur is explained below:

If the project contains an activities package with the version 1.0. The library is referenced to the project and uses the same pack, but with a higher version. The top level dependency v1.0 is used at runtime. A warning is given, mentioning the affected activities package.

The resolution of this scenario is applicable regardless of the runtime rule (Strict image alt text or Lowest Applicable Version image alt text) previously set for the activities packages.

  • If you choose Yes, NuGet attempts to resolve the dependency conflict, but this could result in unpredictable behavior at design time and runtime.
  • If you choose No, the Package Manager is opened with the Project Dependencies window.

The project contains an activities package with the version 2.0. The library uses the same pack, but with a lower version and the Strict image alt text runtime rule. The top level dependency used in this case is v2.0 and a warning is given when the package is installed in the project.

The project contains an activities package with the version 2.0. The library uses the same pack, but with a lower version and the Lowest Applicable Version image alt text runtime rule. The top level dependency used in this case is v2.0 and a warning is given when the package is installed in the project.

The project references a library with an activities package version 1.0 and Strict image alt text runtime rule. The project references another library, but with an activities package version 2.0. The top level dependency in this case is the pack with v2.0, since it has the highest version. A warning is given when the activities package is installed.

In this conflict the project references two libraries, which in turn have Strict image alt text dependencies referenced among them. This scenario isn't supported. For detailed information, check the Dependency Resolution page.

Dependency cycles are types of conflicts that occur when a package references itself. If you name your project UiPath, Studio detects a dependency conflict. This happens because the UiPath package already exists and is a dependency to UiPath.UIAutomation.Activities. It is recommended to avoid naming your project with the name of an already existing package that you intend to add as a dependency.

The same dependency cycle occurs if you open a .xaml file from a folder named UiPath or any name of an existing package that you intend to add as a dependency, and there is no project.json in that folder. When you open a .xaml file that doesn’t have an associated project.json file, Studio creates one and the "name" tag is populated with the name of the parent folder.

Opening Projects Created with Previous Versions

When opening a project with or without dependencies, designed with a version prior to v2018.3, Studio asks you if an automatic migration shall be performed, so that it may attempt to retrieve missing dependencies or add default ones.

Upon confirmation, Studio attempts to retrieve missing dependencies and sets the Strict image alt text runtime rule for the packages that it finds. When using the Repair Dependency option in the Project panel, Studio attempts to install the next best package version. If the package version is not found, alerts are shown in the Output panel and you should check the configured feeds in the Package Manager.

Processes containing dependencies and that were built with Studio versions prior to v2018.3 continue to execute with Robot v2018.3. The runtime rule for such projects is set to Lowest Applicable Version image alt text.

When opening a project created before v2018.3 with no dependency, an alert in the Output panel notifies you of missing dependencies. UiPath packages delivered locally with Studio are added as dependencies with the Strict image alt text runtime rule. The latest version of such packages is automatically set.

Note:

Workflows containing invalid activities cannot be saved. Install the needed dependency and then save the project.

Activities packages UiPath.V7.Activities, UiPath.Platform.Activities, UiPath.Framework.Activities have been deprecated. Upon opening projects with these packages, Studio v2018.3 performs an automatic migration to replace the old versions of activities with new ones.

A workaround is available for some cases in which the migration isn't automatically performed.

  1. Open the project.json file with Notepad++.
  2. Remove the "schemaVersion": "3.2" parameter.
  3. Replace "studioVersion" with "toolVersion".
  4. Change the "toolVersion" value from "18.3.xxx" to a previous version. For example, change the value from "18.3.0.958" to "18.2.958". Save the file.
  5. Open the .xaml file with Studio v2018.3 for the migration to be performed. The deprecated activities packages are replaced with new ones, as illustrated in the Dependencies section of the Project panel.