Subscribe

UiPath Marketplace

The UiPath Marketplace Guide

Assistant Compatible Listings

UiPath Assistant is an interface between the human user and the attended robot.
Through UiPath Assistant, you interact and trigger your own Attended Robot. It lets you choose the different ways of running the processes. The assistant displays a list of available processes and allows you to command this attended robot to run any of these processes with a single click.

Creating and publishing an Assistant compatible listing on UiPath Marketplace

1. Identify the use case for your future listing

The ideal use case for an Assistant compatible listing are the attended automation processes that empower each employee of an organization or a department to benefit from that automation.

Before zeroing on a particular use case, the publisher should ask:

  • whether it would enable employees to delegate tasks they do each day to their robot-like taking action to schedule meetings, perform research and run reports, or analyze, manage, and maintain data.
  • whether it would give employees easy access to automation.

A typical example of such a process is a Work Productivity-related use case in which an employee can trigger an attended robot using Assistant that will quickly prompt him with a form regarding meeting attendees, description, and time constraints. The robot takes this information and automatically compares options across invitee and meeting room calendars. The meeting day, time, and room options are then presented for the final validation by the user, and when confirmed, the robot sends out meeting invitations.

2. Develop the automation using Studio

As a general rule, attended automation processes are fit to be run using Assistant. These processes should be designed so that they are smaller, fragmented, and can run with human supervision.

📘

Key considerations for developing an attended automation process for UiPath Assistant compatible listing

  • Some attended automation processes run in the same way for everybody i.e. when the user clicks Start in the Assistant, the pre-defined steps are carried out without any variations.
  • But in other cases, the way a process runs depends on parameters that are unique for the user or the context, such as email address, location of the folder, or a message string. In such cases, the process should be built by the developer in UiPath Studio with arguments or customizable input fields.

3. Once your automation is ready, publish the process as a NuGet package in UiPath Studio

All Assistant compatible processes should be published as a NuGet package in UiPath Studio. It is because UiPath Assistant can consume only a NuGet package.
The NuGet file for Assistant needs to follow the same standards as for Custom Activities described here.

4. Test-run the NuGet package with UiPath Assistant

To test whether a process developed using UiPath Studio is compatible with UiPath Assistant, the first step is to install the NuGet package of that process in the UiPath Assistant.

  • To install or update the NuGet package from the Orchestrator feed, the robot must be connected to the Orchestrator.
  • Once the NuGet package is installed successfully, the next step is to configure any customizable input fields.
  • If the process is developed in UiPath Studio with any arguments, parameters must be supplied in the customizable input fields in UiPath Assistant. These fields can be accessed in the Assistant by clicking on 'Show Process Details' in the three-dotted menu of the corresponding process.
  • The values supplied to these fields can be saved so that the next time the automation runs, these values are used.

5. Submit the NuGet package with the proper metadata to UiPath Marketplace

Start with checking this article that guides you on how to submit any listing on Marketplace. Here, we have outlined all the steps that the Publishers need to know, including the dos and don'ts.
:grey-exclamation: The above article also contains details to be provided in the “Create Listing” form. Please note that the NuGet package needs to be uploaded in the Listing Package section, and the source code of the attended automation should be provided in the Source Code section.

Updated about a month ago


Assistant Compatible Listings


Suggested Edits are limited on API Reference Pages

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