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.

Templates

Overview

A Template associates a Salesforce object with a UiPath Orchestrator Process or Queue. This association provides the connector with the details necessary to send Orchestrator Notifications to the Orchestrator API, resulting in the creation of an Orchestrator Job or Queue item when a Salesforce event occurs (e.g., record change).

Before you can build your template, you must create a connection. There is a 1:1 relationship between a template and a connection and a template must be associated with a connection before you can use it in a Salesforce business process automation. You can change a template's associated connection at any time. For more information about creating a connection, see Connection Settings.

Note

Before changing a template's associated connection, verify the template inputs (Environment, Process, Robots) are available in the tenant that the connection represents.

Template types

There are two template types:

  • Job Template
    Enables the creation of a new Job that executes a Process using one or more Robots.
  • Queue Template
    Enables the creation of a new Queue item that includes the data from the associated Salesforce object.

Job Template

A Job is the execution of a Process using one or more Robots. The Job Template enables the creation of a new Job in response to Salesforce events or processes.

Fore more information, see About Jobs in the Orchestrator Guide.

Field Descriptions

This section describes the Job Template data fields.

  • Connection - The connection that you want to send Orchestrator Notifications.
    • This field defaults to the connection that you selected to create the template. You can't change the default associated connection when creating the template, but you can after the template is created.
  • Template Name - The name of your template.
    • Your name must start with a letter and may only include alphanumeric characters (a-z, 0-9) and underscores. This field does not accept spaces or special characters.
    • The template name does not need to match the name of the Process you are associating.
  • Template Description - The description of your template.
  • Environment - The name of the UiPath Orchestrator Environment that you want to use to deploy your Process.
    • The name must match the Environment name in your tenant.
    • For more information, see About Environments in the Orchestrator Guide.
  • Process - The Process that you want to associate with a Salesforce Object.
    • The name must match the name of the Process in the associated tenant.
    • The search results are automatically returned as you enter the name.
  • Strategy - How you want the job to run (e.g., specific Robots). There are three options:
    • Jobs Count - The number of pending Jobs that you want to create in the environment. Use this option if you want the Job to run this process multiple times with the next available Robot. The value must be greater than 0 and the default value is 1.
    • Specific - Use this option to select the specific Robot(s) that you want to run your job.
      • When you select this option, a list of available Robots in the Environment is shown. If you don't see the Robot that you want to use, go to your UiPath Orchestrator to verify that it's included in the Environment.
    • All - Use this option if you want to run the Job a single time, using the next available Robot.
  • Select Salesforce Object - Enter a Salesforce object that you want associate with your Job (e.g,. Case, Opportunity, Account).
  • Object Fields - The data fields that you want to include as Input Values for the Job.
    • For example, if you enter Case as your object, you can select Case ID, Case Number, and Email Address fields. The data from these fields is included in the Job details when it's sent to your UiPath Orchestrator.
    • For more information, see About Input and Output Parameters in the Orchestrator Guide.

Note

When selecting your Object Fields, take note of the Field API Name. Any Job input parameter that requires a Salesforce object field value must have the same name as the Field API Name of the object field.

For example, if you have a process that requires a Salesforce Case Id as an input parameter, the name of the parameter must be Id to populate correctly.

Queue Template

A Queue is a container that stores multiple types of data you can use in complex automation projects. For example, you can create an automation Process that collects invoice information and creates a Queue item for each piece of data. A subsequent automation Process can use the Queue items to perform tasks, such as paying the invoice in a different application.

A Queue Template gives you the ability to send a collection of Salesforce data to UiPath Orchestrator in response to Salesforce events or processes.

For more information, see About Queues and Transactions in the Orchestrator Guide.

Note

UiPath Orchestrator version 19.4 or higher is required to process Queue Templates.

Field Descriptions

This section describes the Queue Template properties.

  • Connection - The connection that you want to send Orchestrator Notifications.
    • This field defaults to the connection that you selected to create the template. You can't change the default associated connection when creating the template, but you can after the template is created.
  • Template Name - The name of your template.
    • Your name must start with a letter and may only include alphanumeric characters (a-z, 0-9) and underscores. This field does not accept spaces or special characters.
    • The template name does not need to match the name of the Process you are associating.
  • Template Description - The description of your template.
  • Queue Details - The name and priority of your new Queue item.
    • Queue Name - A list of the available Queues in your associated connection.
      • If you don't see the Queue that you want to use, go to your UiPath Orchestrator to verify that it's included in the tenant.
    • Priority - Sets the processing importance for the Queue item (Low, Normal, or High).
  • Salesforce Object Field Mapping - The Salesforce object and fields that you want to use for your Queue.
    • Select Salesforce Object - Enter a Salesforce object that you want associate with your Job (e.g,. Case, Opportunity, Account).
    • Object Fields - The data fields that you want to include as Input Values for the Job. For example, if you enter Case as your object, you can select Case ID, Case Number, and Email Address fields. The data from these fields is included in the Queue details when it's sent to your UiPath Orchestrator.

Note

When selecting your Object Fields, take note of the Field API Name. The Field API Name is what gets passed to the Queue Item's Specific Data (e.g., Id is passed for the Case ID field).

Disconnected Templates

When deleting a connection that has associated templates, the templates are removed and added to the Disconnected Templates list. From this list, you can re-associate the templates with a new or existing connection, or delete them.

Note

To delete a template, you must first delete the associated connection. Currently, you can't delete a template without first deleting the connection.

Updated about a month ago


Templates


Suggested Edits are limited on API Reference Pages

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