UiPath Integrations

Quickstart

Introduction

The purpose of this guide is to show you how to use the UiPath Connector for Salesforce in a simple Salesforce business process automation (via Process Builder). Using a Salesforce Opportunity object as an example, you'll complete the following:

  1. Add a Connection
  2. Create a Queue Template
  3. Create a Job Template
  4. Build an Automation Process (Process Builder)
  5. Test your Automation Process

After completing the steps in this guide, you'll have a connector that does the following:

  1. Establishes an authenticated connection between your Salesforce platform and a UiPath Orchestrator Tenant.
  2. Adds a Queue item to an existing Queue when a Salesforce Opportunity object stage changes to Closed Won.
  3. Creates a new Job to execute an existing Process when a Salesforce Opportunity object stage changes to Closed Won.

Information

For more information about the UiPath Connector for Salesforce and its features, see the following pages:

Prerequisites

Before you begin:

  1. Complete the Setup steps.
  2. Setup a new, or use an existing, UiPath Orchestrator instance that has a Tenant, Environment, Process, and Robot.

Note

For the purposes of this guide, ensure that you have an available Robot that does not have existing jobs in the pending state; this makes it easier to verify the success of your setup and process.

Steps

Add a Connection

  1. Go to the UiPath Setup page.
    • You can use the App Launcher to search for UiPath Setup.
  2. In the left-hand panel, click + Add a Connection (this opens the Connection Settings form).
  3. Complete the Connection Settings form.
    • Enter a unique Connection Name.
      • This name is only used in the UiPath Connector for Salesforce application and it does not need to match the name of the tenant you're connecting.
      • Your name can include alphanumeric characters (a-z, 0-9), special characters, and spaces.
      • This name is not editable after you save the form via the Connect button.
    • Enter the UiPath Orchestrator URL that you're connecting (e.g., https://myorchestrator.com).
    • Enter the Tenant Name that you're connecting.
      • This name must match the name of the UiPath Orchestrator tenant.
    • Enter the Email or Username that you want to use for your connection.
      • The user must have permissions to access the tenant. For more information, see About Users in the Orchestrator Guide.
    • Enter the Password associated with the email or username.
  4. Click the Connect button.
    • The system verifies the authentication information by establishing a connection.
    • If the connection is unsuccessful, a red notification stating "Unable to authenticate UiPath credentials. Please verify and try again." appears at the top of the screen. To resolve the issue, verify your form entries and click the Connect button again.

Create a Queue Template

  1. In the left-hand panel, select the connection you created and click Templates.
  2. In your Templates page, click the New button (this opens the Create New Template wizard).
  1. Complete the first page of the template form:
    • Enter a Template Name (required).
      • 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.
    • Enter a Template Description (optional).
    • Select the Queue radio button.
  2. Click the Next button.

Note

The Connection field defaults to the connection that you select to create the template. You can't change the default connection during template creation, but you can after the template is created.

  1. Complete the second page of the template form:
    • Select a Queue Name from the list of available Queues.
      • If you don't see the Queue that you want to use, go to your UiPath Orchestrator and verify the Queues are present in your tenant.
    • Select a Priority (e.g., High).
      • This sets the processing importance for the Queue item.
  2. Click the Next button.
  1. Complete the final page of the template form:
    • Select a Salesforce Object (e.g., Opportunity).
    • Select the Opportunity Fields that you want to use for your Queue item (e.g., Opportunity ID, Account ID).
  2. Click the Save button.
  1. Verify the new Queue Template appears in your list of templates.

You're done! Now, let's create a complementary Job Template.

Create a Job Template

  1. In your Templates page, click the New button (this opens the Create New Template wizard).
  2. Complete the first page of the template form:
    • Enter a Template Name (required).
      • 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.
    • Enter a Template Description (optional).
    • Select the Job radio button.
  3. Click the Next button.
  1. Complete the second page of the template form:
    • Enter the Environment that you want to use to deploy your process (the available Environments are returned when you start typing).
      • If you don't see the Environment name in the list, go to your UiPath Orchestrator and verify it's present in your tenant.
      • For more information, see About Environments in the Orchestrator Guide.
    • Enter the Process that you want to run (the available Processes are returned when you start typing).
      • The name must match the name of the Process in your tenant. If you can't find the process you're looking for, go to your UiPath Orchestrator and verify it's present in your tenant.
    • Select your run Strategy (e.g., All).
      • Selecting All indicates that you want to run this job a single time, using the next available robot. For more information, see Templates.
  2. Click the Next Button
  1. Complete the final page of the template form:
    • Select a Salesforce Object (e.g., Opportunity).
    • Select the Opportunity Fields that have the data you want as Input Values for your Job (e.g., Opportunity ID, Account ID).
  2. Click the Save button.
  1. Verify the Job Template was added to your list of templates.

You're done! Next, let's open the Salesforce Lightning Process Builder to build a simple automation process that uses your new templates.

Build an Automation Process

In this section, you'll use the Salesforce Lightning Process Builder to create a process that invokes your new templates when a Salesforce Opportunity stage is changed to Closed/Won.

For more information about the Salesforce Lightning Process Builder, see Lightning Process Builder in the Salesforce documentation.

Add Object

  1. Open the Lightning Process Builder (Settings > Setup > Process Builder )
  2. In the upper right-hand corner, click the New button (this opens the New Process window).
  1. Enter your New Process details.
    • For The process starts when field, select A record changes.
  2. Click the Save button (this opens your new process in the builder).
  1. In the the design panel, click + Object.
  2. Enter your object details:
    • Select Opportunity for your Object.
    • Under Start the process, select the when a record is created or edited radio button.
  3. Click the Save button.

Add Criteria

  1. In the the design panel, click Add Criteria.
  2. Enter the following criteria details:
    • Enter a Criteria Name (e.g., OpportunityWon)
    • Under Criteria for Executing Actions, select the Conditions are met radio button.
    • Under Set Conditions, enter/select the following:
      • Field: Select Stage (displays as [Opportunity].StageName when selected).
      • Operator: Select Equals
      • Type: Select Picklist
      • Value: Select Closed Won
    • Under Conditions, select the All of the conditions are met (AND) radio button
  3. Click the Save button.

Add Immediate Actions

  1. In the the design panel, click +Add Action.
  2. Enter the following action details:
    • Under Action Type, select APEX (this indicates that you want to use an AppExchange application)
    • Enter an Action Name (e.g., CreateQueue).
    • Under Apex Class, select UiPath - Create Queue Notification.
    • Under Set Apex Variables, enter the following (two rows):
      • Field: Record ID (default value)
      • Type: Select Field Reference
      • Value: Select [Opportunity].Id (this value must match the Object you selected when you created
      • Field: Connection Template Name (default value)
      • Type: Select String
      • Value: Enter your template name (e.g., OpportunityQueueItem).
  3. Click the Save button.
  1. In the the design panel, click Add Action.
  2. Enter the following action details:
    • Under Action Type, select APEX (this indicates that you want to use an AppExchange application)
    • Enter an Action Name (e.g., CreateJob).
    • Under Apex Class, select UiPath - Create Job Notification.
    • Under Set Apex Variables, enter the following (two rows):
      • Field: Connection Template Name (default value)
      • Type: Select String
      • Value: Enter your template name (e.g., OpportunityJob).
      • Field: Record ID (default value)
      • Type: Select Field Reference
      • Value: Select [Opportunity].Id (this value must match the Object you selected when you created the template).
  3. Click the Save button.
  1. In the upper right-hand corner, click the Activate button (this locks your process and enables it for use).

You're done! Now, let's test your automation process by updating a Salesforce Opportunity.

Test your Automation Process

In this section, you'll update an Opportunity for testing purposes only. The purpose of the test is to verify that your Queue Template and Job Template are sent to UiPath Orchestrator when the Opportunity Stage changes to Closed Won.

  1. Create a new or use an existing Opportunity.
    • You can use the App Launcher to search for Opportunities.
    • To create a new Opportunity, you can follow the Create an Opportunity Manually steps in the Salesforce documentation.
    • Be sure the Stage field is not yet set to Closed Won.
  2. Open your Opportunity and change the Stage field to Closed Won
  3. Click the Save button

Verify Orchestrator Notifications

Next, you'll verify that the Queue Template and Job Template were added to your Orchestrator Notifications list after the Opportunity was updated.

  1. Go to the Orchestrator Notifications page in the UiPath Connector App.
  2. Verify your Queue Template and Job Template were added to your list of notifications.

Verify UiPath Orchestrator Jobs and Queues

In this section, you'll verify that the Queue Template and Job Template were both sent to UiPath Orchestrator.

  1. Go to the UiPath Orchestrator URL you entered in your Connection Settings. (e.g., https://myorchestrator.com).
  2. In the left-hand navigation, click Jobs.
  3. Verify your Job Template was added to your list in the Pending state.
  1. Open the Job details and verify the Input Values include the data from the Object Fields you selected when creating the Job Template (e.g., Case ID).
  1. In the left-hand navigation, click Queues and go to View Transactions of the Queue you used to create your Queue Template.
  2. Verify there is a new transaction.
  1. Open the transaction details and verify the details include the data from the Object Fields you selected when creating the Queue Template (e.g., Opportunity ID).

You're done! You have created your first UiPath Connector for Salesforce integration and sent your first templates to UiPath Orchestrator.


Quickstart


Suggested Edits are limited on API Reference Pages

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