[InfoSet] - LegacyToWindows Migration # NuGet Package Check for offered Compatibilities

Help Something Else
, , ,
1

This post is currently in a preview version and will be further updated in the near future.

In the context of preparing for a legacy-to-Windows migration, it may be necessary to check which compatibilities are offered by a package (NuGet Package). This part of the [InfoSet] -LegacyToWindows Migration series presents various options for such an evaluation.

Introduction

Artifacts referenced in the source code projects / UiPath Studio projects are provided by NuGet packages. A package can offer the provided functionalities for one or also different target platforms. For the Legacy-To-Windows migration it is therefore important whether the package is compatible with the target platform targeted in the migration (Windows) or not.

Hints for the compatibility

The Microsoft Code Platform defines products (target frameworks) that are available in different versions. This information can be used to check the availability of a NuGet package for the compatibility of a UiPath Studio project.

Product Version Hint Comment
.Net Framework net45 Legacy
.Net Framework net461 Legacy
.Net Framework net4## Legacy # - Digit ~ marking other Framework Versions
.NET net.5.0-windows7.0 Windows
.NET net.6.0-windows7.0 Windows
.NET net5.0 Cross-Plattform

Some of the options listed below refer to the overview above when it comes to analyzing information about a NuGet package more deeply

Official documentation / reference resources

Many NuGet packages provide a link to the associated project website in their metadata. The available compatibility can be found in the documentation/developer references.

UiPath documentation pages for activities or packages often mention the compatibility offered.

Provisioning channel

Packages are generally offered via feeds. Further information on this can also be found there and clarify the question of available compatibility.

Example nuget.org

grafik
grafik877×383 16.2 KB

A note on the UiPath Marketplace
It may happen that not all supported compatibilities are displayed. For example, a custom library may be compatible with Legacy and Windows. However, only one compatibility is mentioned on the overview page.

Visuals

grafik
But the custom library is compatible with Legacy and Windows, which was also explicitly noted by the author.

grafik
grafik824×267 29.8 KB

UiPath Studio - Manage Packages

Once a UiPath Studio project is open and the project has set the corresponding target platform in its compatibility, the availability of a package can be checked via the Package Manager (Ribbon menu item: Manage Packages). Only packages that are available for the compatibility set in the project are offered.

Remark:

  • In case of restricted internet access (e.g. firewall rules), the providing nuget feed may be blocked. Such a situation should not be misinterpreted and falsify the evaluation of the compatibility.

  • When testing with this method, make sure that all other packages required in the project are also referenced with the appropriate version.

File System - NuGet Repository folder

The configured global-packages folder is used for unpacking NuGet packages. By default this can be found under

  • Windows: %userprofile%\.nuget\packages

Whenever a nuget package is already available in the nuget repository the expanded package content can be checked.
grafik

perform the following steps

  • use the File Explorer and navigate to: %userprofile%.nuget\packages
  • locate the folder of the corresponding package name (in most cases the same name as the package ID)
  • open the folder with the relevant package version info
  • open the lib folder
  • take the hint from the subfolders name

File System - local downloaded nuget package

Create a copy of the package and perform the following steps

NuGet Metadata

The dependencies defined by the package can be read from the package metadata. The following options can be used to inspect the metadata.

NuGet Package Explorer

Project Website: GitHub - NuGetPackageExplorer/NuGetPackageExplorer: Create, update and deploy Nuget Packages with a GUI

Assuming that NuGet Package Explorer is installed, perform the following steps:

  • Open the package to be examined in the NuGet Package Explorer
  • The dependencies are noted at the bottom left of the page.
  • Check which dependencies to .Net are defined
  • If only .NETFramework4.X/.NETFramework4.X.Y is referenced, then the package is not Windows compatible.

It may be the case that no indications of compatibility can be taken from the metadata. In such a case, the package content can be inspected within the Nuget Package Explorer. Similar to the description under File System - nuget Repository folder, the LIB folder can be opened and the names of the subfolders can be further inspected.

Visuals

Example of a Package defining compatibility for Legacy and Windows

grafik

grafik

Other options

Formally, it is mentioned that there are other ways to check a NuGet package for UiPath Studio project compatibility besides the ones presented here. If it becomes known from the various migration projects that another option is also used particularly frequently, it will be added to the list.

Conclusion

A package can be quickly checked for compatibility if the subfolders of the LIB folder from the package content are evaluated. The availability of the package plays a role in the selection of the method for the evaluation. Already installed packages can be inspected in the global-packages folder. Locally available packages are extracted manually or opened with the NuGet Package Explorer.

Once a UiPath Studio project is currently open and package dependencies are configured similarly, then a test can be carried out via the Package Manager. However, it should be ensured that package feeds are also accessible.

If a local download of packages is not desired, the websites of the project or of feeds that offer the package are a good first starting point.

References

Questions

For questions on your specific case or migration topic open a new topic and get individual support.

2 Likes