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.

Quickstart

This guide shows you how to install the UiPath Sample Application and build a simple project that validates the connection to your Appian platform.

To validate your connection, you'll build an automation sequence using the Appian activities to do the following:

Prerequisites

Before you begin building your project that includes the Appian activities, you need to download the UiPath Sample Application. This sample app includes (amongst other objects) sample process models and web APIs that enable the connection and interaction between Appian and UiPath.

  1. Download the Uipath Sample Application.
    • You'll import this .zip file into your Appian platform, so save it somewhere that you can easily access.
  2. Open the Appian platform in your browser and go to the Appian Designer (e.g., https://YourInstance.appiantrial.com/suite/design).
  1. Go to Applications and click the Import button (this opens the Import Package window).
  1. In the Import Package window, click the Upload button and select the .zip file that you saved in step 1.
  2. Click the Inspect button to verify the package doesn't have errors.
  1. After successful inspection, click the Import Package button.

You're done! The UiPath Sample Application is now ready to use. Now, let's create a new automation project using the Appian Activities Package.

Steps

Create a new project

  1. Open UiPath Studio.
  2. Under New Project, click Process to create a new project (this opens a New Blank Process window).
  1. Enter a project Name, Location, and Description.
  2. Click Create.

You're done! Next, follow the steps below to add the Appian Activities Package to your project via Manage Packages.

Add the Appian Activities Package

  1. In your new project, click Design at the top of the page.
  2. Click Manage Packages (this opens the Manage Packages window).
  1. Under All Packages, click Go!.
  2. Search for "Appian" (the search results automatically return as you type).
  3. Click UiPath.Appian.Activities in the results panel (this opens the package details panel in the right-hand side of the window).
  4. Click Install.
  5. Click Save (this opens a License Acceptance window).
  1. Click I Accept in the License Acceptance window.

You're done! The Appian Activities package is now in your Activities > Available > Integrations > Appian.

Now, let's build your first Appian automation project.

Build your Appian automation project

Appian Scope

  1. In the Activities panel, go to Available > Integrations > Appian.
  2. Click, drag, and drop the Appian Scope into the main Designer panel.
  3. In the Designer panel, click the Appian Scope activity to open its Properties panel.
  1. Enter the Server URL, Username, and Password for your Appian platform.

With the Appian Scope activity added, you're ready to add the Start Human Activity.

Start Human Activity

This activity starts a predefined process (template), that is included in the UiPath Sample Application, to assign a task to a group or individual.

  1. In the Activities panel, go to Available > Integrations > Appian.
  2. Click, drag, and drop the Start Human Activity into the main Designer panel.
  3. In the Designer panel, click the Start Human Activity activity to open its Properties panel.
  1. Enter the GroupId or Username that you want to assign to the process.
    • If you want to assign the process to a specific group of users, follow the steps below to locate the GroupId, otherwise enter a Username to assign it to an individual user.
      1. In the Designer panel, click the search icon next to the property (this opens the Select Group wizard).
      2. In the Select Group wizard, enter the ServerURL, Username, and Password that you used in the Appian Scope activity.
      3. Click the Connect button.
      4. Select the process from the list and click the Select button.
  1. Create a String output variable and enter it in the ProcessId property.
  1. To help verify the success of the process, add a Message Box activity after the Start Human Activity and enter your ProcessId output variable in the Text property (e.g., "Process ID: " + processId).

You're done! Your automation process is now ready to run.

Next, let's test your Start Human Activity project by running the process and validating the results in your Appian platform.

Test the Start Human Activity

  1. Open the Appian platform in your browser and go to the Appian Designer (e.g., https://YourInstance.appiantrial.com/suite/design).
  2. Go to Applications and click the UiPath Sample Application link from the list of applications (this opens to the application objects).
  1. From the UiPath Sample Application, click the Monitoring tab (this opens a list of your processes).
  2. Select the Show process details check box (this shows the Process ID within the list of your processes).
  1. Go to UiPath Studio and open the Appian automation project that you just created.
  2. Click Run.
  1. After the Start Human Activity runs, take note of the Process ID that is shown in the Message Box.
  1. Verify the Start Human Activity process appears in the Appian monitoring list and the Process ID matches the Process ID from the Message Box.

You're done! You've successfully built and tested your Appian automation project, validating your connection is ready to do more.

Updated 4 months ago


Quickstart


Suggested Edits are limited on API Reference Pages

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