add-ins
latest
false
UiPath logo, featuring letters U and I in white

Add-ins User Guide

Last updated Jul 17, 2024

Connection

The Connection dialog uses the UiPath Orchestrator API to create a connection to a specific orchestrator tenant.

Once a Connection has been established it can be used by Actions in recipes.

How It Works

  1. Go to Workato App Connections tab and click Create Connection.

  2. Search for UiPath add-in and click on it.

  3. Fill in your Orchestrator connection details.
  4. Depending on the options you choose, you have to provide different connectivity parameters.

Here is an example of a successful connection to a Cloud Orchestrator.

You need an API access token in order to connect successfully to your Orchestrator. You can find details on how to get this in the Automation Cloud documentation.



You can use this connection now with UiPath actions in all your receipes. The add-in handles session tokens and other required details, such as folder and organization IDs, in subsequent API calls to your Orchestrator API.

Properties

PropertyDescription
Connection NameThe name of your connection. You can reuse it in other recipes. This field supports only String variables.
Connection TypeIndicate if the connection is in an on-premise Orchestrator or Automation Cloud.

On Premise Connection Properties

PropertyDescription
UiPath Orchestrator URLThe URL of your Orchestrator tenant. This field supports only String variables.
Orchestrator Tenant NameThe name of your Orchestrator tenant. This field supports only String variables.
Email or UsernameYour email or username. This field supports only String variables.
PasswordThe password for the email or username specified above. This field supports only String variables.
FolderThe folder to use. This can be a classic or a modern folder name. This field supports only String variables. If a folder is not specified, the connection presumes the default Classic folder for this Orchestrator tenant.

Cloud Connection Properties

PropertyDescription
Account Logical NameThe account logical name. This field supports only String variables.
Tenant Logical NameThe tenant logical name. This field supports only String variables.
Client IDThe client ID for this connection. This field supports only String variables.
User KeyThe user key for this connection. This field supports only String variables.
FolderThe folder to use. This can be a classic or a modern folder name. This field supports only String variables. If a folder is not specified, the connection will presume the default Classic folder for this Orchestrator tenant.
  • How It Works
  • Properties
  • On Premise Connection Properties
  • Cloud Connection Properties

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.