Skip to main content

Package metadata

Package metadata overview in UiPath Studio

Intro​

Looking at the activity package built in this tutorial, you'll see several placeholders where information such as the author, license, icon, etc. should go. Let's personalize the package by replacing those placeholders with real information.

The focus of this section will be on 4 files from the Design project:

  • Assembly Info
  • Package-level Assembly Info
  • Global Assembly Info
  • Nuspec

Each holds specific pieces of package-level metadata. For a detailed look at each file, see the Building Activity Packages section.

Design project files for package metadata

What you'll need​

Steps​

1. Add Package Decorators​

Open the MyCompany.MyProduct.Activities.Design project and navigate to the file ending in .nuspec. The nuspec file draws all your package metadata from the project and displays it in the Nuget package that gets built and imported into UiPath Studio.

In this file, change the icon and tags fields as follows.

<?xml version="1.0"?>
<package>
  <metadata>
    <id>$title$</id>
    <version>$version$</version>
    <title>$title$</title>
    <authors>$author$</authors>
    <owners>$author$</owners>
    <description>$description$</description>
    <copyright>$copyright$</copyright>
    <requireLicenseAcceptance>true</requireLicenseAcceptance>
    <licenseUrl>https://www.apache.org/licenses/LICENSE-2.0</licenseUrl>
    <projectUrl>https://integrations.uipath.com/docs/integrating-with-uipath</projectUrl>
    <iconUrl>https://www.dropbox.com/s/8nmnkmn73038m9z/boxIcon.png?dl=1</iconUrl>
    <tags>UiPath Activit MyCompany MyProduct Math Addition Arithmetic</tags>
    <dependencies>
    </dependencies>
  </metadata>
  <files>
    <file src="$OutputPath$**\)\)MyCompany.MyProduct*resources.dll" target="lib\)
et461"/>
  </files>
</package>

2. Add Company-Specific Info​

In the same project, navigate to Properties/GlobalAssemblyInfo.cs, and update the Company, Product, and Copyright:

...
[assembly: AssemblyCompany("My Company")]
[assembly: AssemblyProduct("My Product")]
[assembly: AssemblyCopyright("My Company © 2020")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]
[assembly: XmlnsPrefix("http://schemas.uipath.com/workflow/activities", "ui")]
[assembly: NeutralResourcesLanguage("en-US")]

3. Add Package-Specific Info​

Now move to Properties/AssemblyInfo.cs and update the package Name (Title) and Description:

...
[assembly: AssemblyTitle("MyCompany.MyProduct.Activities")]
[assembly: AssemblyDescription("A package for performing simple arithmetic operations in UiPath Studio.")]
[assembly: AssemblyConfiguration("")]
...

4. Add a Specific Version​

Lastly, open Properties/MyCompany.MyProductAssemblyInfo.cs, and update the package version by changing all occurrences of 0.1 to 0.2:

...
#i DEBUG
[assembly: AssemblyVersion("0.2.*")]
#els
[assembly: AssemblyVersion("0.2.0")]
#endi

5) Rebuild the Package​

Rebuild the package and import it into UiPath Studio as in the previous section. Open the Package Manager and notice how your package now has a new icon, description, and updated metadata.

Rebuilt package with updated icon and metadata in UiPath Studio Package Manager