UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Package Metadata

Make the package your own with your name, company, website, license, logo, etc.

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 the Design project, which holds all your package info.

What You'll Need


Steps

1) Open the Design Project

Open the MyCompany.MyProduct.Activities.Design project by double-clicking it and notice that there are three labeled sections:

  • Package Metadata
  • Package Versions
  • Package Icon

Package Metadata

Field
Description

PackageLicenseExpression

An SPDX identifier for the license you'd like to use. The default is Apache 2.0.

Description

A short description of your activities that will appear in the UiPath Studio Package Manager.

Authors and Company

The author and owner of the package respectively.

Copyright

The standard copyright notice.

PackageTags

A list of terms for which users can search to find your package.

PackageProjectUrl

A link to your activities' documentation or company homepage.

PackageIcon

An image file used as the package icon (takes precedence over PackageIconUrl).

PackageIconUrl

A link to an image file used as the package icon. If PackageIcon is present, this field will be ignored.

<!-- Package Metadata -->
<PropertyGroup>
    <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
    <Description>A package used to perform simple arithmetic operations in UiPath Studio.</Description>
    <Authors>My Company</Authors>
    <Company>My Company</Company>
    <Copyright>@ 2020 My Company</Copyright>
    <PackageTags>UiPath Activitš¯—’ MyCompany MyProduct Math Addition Arithmetic</PackageTags>
    <PackageProjectUrl>https://docs.uipath.com/integrations/docs/how-to-create-activities</PackageProjectUrl>
    <PackageIconUrl>https://raw.githubusercontent.com/NuGet/Samples/master/PackageIconNuspecExample/icon.png</PackageIconUrl>
    <PackageIcon>packageIcon.png</PackageIcon>
    ...
</PropertyGroup>

Package Version

Notice that there are two PackageVersion tags here, which correspond to the two modes in which a package can be built--Debug and Release.

  • Debug is useful during development. The version increments with each build so updates can be made and then immediately tested in UiPath Studio.
  • Release is used to create a final package ready for publication. Once development is through, you may set the desired version here.
<!-- Package Versions -->
<PropertyGroup Condition="'$(Configuration)' == 'Debug'">
    <PackageVersion>0.2.0.$([System.DateTime]::UtcNow.ToString(MMddHmmss)) Version</PackageVersion>
</PropertyGroup>
  
<PropertyGroup Condition="'$(Configuration)' == 'Release'">
    <PackageVersion>0.2.0</PackageVersion>
</PropertyGroup>

Package Icon

Within your Design project is an image file named packageIcon.png. Replace this file with your desired icon and it will be added to your package. In this example, a sample icon will be used.

<!-- Package Metadata -->
<PropertyGroup>
    ...
    <PackageIcon>packageIcon.png</PackageIcon>
    ...
</PropertyGroup>
  
<!-- Package Icon -->
<ItemGroup>
    <None Include="packageIcon.png" Pack="true" Visible="false" PackagePath="" />
</ItemGroup>

2) 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.

Updated 6 days ago


What's Next

This is the end of the Activity Creator tutorial. Take a look at the following documents for a deeper understanding of the code behind the activities.

Understanding the Activity Project Structure
Customizing Activities
Customizing Properties
Building Your Package

Package Metadata


Make the package your own with your name, company, website, license, logo, etc.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.