Salesforce Connector for UiPathSalesforce Connector can be used to extract/load large amount of data from/in Salesforce.com without any programming. You can use simple Table mode or Query mode with full SOQL query language support (SOQL=Salesforce.com Object Query Language). In this article you will learn how to quickly and efficiently integrate Salesforce data in UiPath without coding. We will use high-performance Salesforce Connector to easily connect to Salesforce and then access the data inside UiPath. Let's follow the steps below to see how we can accomplish that! Salesforce Connector for UiPath is based on ZappySys Salesforce Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Salesforce in other apps
|
Create ODBC Data Source (DSN) based on ZappySys Salesforce Driver
Step-by-step instructions
To get data from Salesforce using UiPath we first need to create a DSN (Data Source) which will access data from Salesforce. We will later be able to read data using UiPath. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User data source (User DSN) based on ZappySys Salesforce Driver
ZappySys Salesforce Driver-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
in design-time , when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit. -
Create and use System DSN
if the client application is launched under a System Account, e.g. as a Windows Service.
Usually, this is an ideal option to use
in a production environment . Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
Now, we need SalesForce Connection. Lets create it.
-
Now, When you see DSN Config Editor with zappysys logo first thing you need to do is change default DSN Name at the top and Click on Preview Tab, Select Table from Tables Dropdown or you can enter or modify a SOQL query and click on Preview Data.
This example shows how to write simple SOQL query (Salesforce Object Query Language). It uses WHERE clause. For more SOQL Queries click here.
SOQL is similar to database SQL query language but much simpler and many features you use in database query may not be supported in SOQL (Such as JOIN clause not supported). But you can use following Queries for Insert, Update, Delete and Upsert(Update or Insert record if not found).SELECT * FROM Account WHERE Name like '%Oil%' -
Click OK to finish creating the data source
Video Tutorial
Read Salesforce data in UiPath Studio (workstation)
Here we will be reading Salesforce data on your workstation. To accomplish that we will create and run UiPath process package locally. Later on, we'll explore how to publish the package to Orchestrator and run it remotely. For now, let's focus on working locally and get started!
- Open UiPath Studio.
- Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).
-
In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings:
Simply select UiPath Studio option:
-
Start by creating a new project based on UiPath Process template:
-
Add Run Query activity in Main Sequence box:
-
Click Configure Connection... button to create an ODBC connection:
-
Continue by clicking Connection Wizard:
-
When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:
SalesforceDSNSalesforceDSNYou can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration.
-
Once you do that, it's time to configure a SQL query:
Make sure, you enclose the query in double quotes!
-
Proceed by adding a Write CSV activity after Run Query:
In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel.
-
Once you do that, configure the added Write CSV, this will write Salesforce data to a CSV file:
-
It's time for fun! Which means it's time for debugging! Just run the package locally to debug:
-
Finally, ensure there are no execution errors!
Run UiPath package using Orchestrator (via robot)
UiPath also offers the ability to execute packages remotely using Orchestrator and a robot. This is achieved by publishing the package to UiPath Orchestrator, installing UiPath Assistant on the remote machine, connecting it to Orchestrator, enabling us to run the package remotely. It may sound complicated at first glance, but further steps will clear things out. Let's not waste our precious time and delve into the details!
Publish process package from UiPath Studio
- First of all, open the UiPath process package we created in the previous step
-
Set the option that our process package Starts in Background:
-
We are ready to Publish it:
-
Make sure, you publish it to the Shared folder in UiPath Orchestrator Tenant workspace:
-
Finally, success! We are ready for the next step - creating UiPath robot - so we can automate the job:
Create robot in UiPath Orchestrator
-
First of all, let's open UiPath Orchestrator from UiPath Automation Cloud console:
-
It's time to create a robot, which will run unattended packages:
-
But first we have to create a runtime. Choose to host our robot on-premise, not in UiPath infrastructure:
-
Let's move along and Create new machine template, this will create a machine in UiPath Orchestrator:
-
Configure the machine to run in Production environment:
-
We are ready to Create new robot account in the new machine:
-
Let's make our robot to work only on background automations:
-
Continue by selecting newly created robot:
-
Select Shared folder, so that everyone in the team can benefit from it:
This is the folder where we published our UiPath process package "MyProcess"
-
We are almost done!
We are given machine Client ID and Client secret which we will use to connect UiPath Assistant to our created machine in Orchestrator.
Let's leave this open for a while and see how we can do it in the next step.
Connect UiPath Assistant to Orchestrator
We are ready to connect UiPath Assistant to the machine we created in Orchestrator. UiPath Assistant will run our package in a remote machine. Let's connect it and give it some work!
- Connect to a remote machine (where your UiPath process package will be running).
- Install UiPath Studio there.
- Then configure ODBC data source:
If you chose Use user or system data source option in connection configuration, when creating UiPath process package, then create an identical ODBC data source on the same remote machine. Use the same configuration as the one created in your workstation in the first step.
Use Copy Settings and Load Settings buttons to make your life easier. They will help you to transfer settings between different ODBC data sources.If you chose Use connection string option, then you don't have to do anything. However, you still have to install ODBC PowerPack on the remote machine.
-
Continue by opening UiPath Assistant and going to Preferences:
-
Find Orchestrator Settings menu item and click it:
-
And here even bigger fun begins! But fear not, all you have to do is open your web browser window with Client ID & Client secret we obtained in the previous step and simply copy and paste those values into UiPath Assistant. Also, don't forget to configure Orchestrator URL:
-
Finally, we get rewarded for the hard work with the Connected as Unattended status:
Create and run UiPath process in Orchestrator
We are at the finish line! Let's create and run UiPath process. This will execute the package on your remote machine using the UiPath Assistant configured earlier.
- First of all, open UiPath Orchestrator from UiPath Automation Cloud console.
-
Then proceed by going to Process in Shared folder:
-
Continue by simply clicking on Add process button:
-
Select the process package we created in UiPath Studio:
-
Rest a while, and just hit Next, unless your package has requirements:
-
Then simply hit Create button:
-
But let's not stop here and Start the process by creating a job right away:
-
Use the same Production runtime we created before and hit Start:
-
We've reached the final step! In the CSV destination file or destination of your choice you should see Salesforce data:
Query Examples
This guide provides examples for using the ZappySys Salesforce ODBC Driver to perform bulk API operations and DML (Data Manipulation Language) actions on Salesforce. You’ll learn how to leverage the Bulk API to insert, update, upsert, and delete large datasets from external sources such as MSSQL, CSV, Oracle, and other ODBC-compatible systems. By using external IDs and lookup fields, you can easily map data from your source systems to Salesforce. These examples will help you execute high-performance operations efficiently using EnableBulkMode
, EXTERNAL
options, and more.
Bulk Mode - Insert Large Volume of Data from External Source (e.g., MSSQL) into Salesforce
This example demonstrates how to use the EnableBulkMode
option to insert a large volume of records into Salesforce using the Bulk API (Job-based mode). By default, the standard mode writes data in batches of 200 rows. However, when Bulk API mode is enabled, it can send up to 10,000 rows per batch, offering better performance for large datasets. Note that using Bulk API mode may not provide performance benefits for small datasets (e.g., a few hundred rows).
In this example, the driver type is set to MSSQL
. For other data sources such as CSV, REST API, or Oracle, update the driver type to ODBC
and modify the connection string and query accordingly.
Ensure that your source query returns column names that match the target Salesforce object fields. The EXTERNAL
option is used to map Salesforce target fields based on the output of the source query.
Important: If you’re using Windows authentication, the service account running the ZappySys Data Gateway must have the appropriate permissions on the source system.
INSERT INTO Account
SOURCE (
'MSSQL',
'Data Source=localhost;Initial Catalog=tempdb;Integrated Security=true',
'SELECT TOP 1000000
C_NAME AS Name,
C_CITY AS BillingCity,
C_LOC AS NumberofLocations__c
FROM very_large_staging_table'
)
WITH (
Output = 1,
EnableBulkMode = 1
)
-- Notes:
-- 'MSSQL': External driver type (MSSQL, ODBC, OLEDB)
-- Output: Enables capturing __RowStatus and __ErrorMessage
-- EnableBulkMode: Improves performance with bulk batches (uses 10000 rows per batch rather than 200)
Bulk Mode - Insert Records with Lookup Field (Read from External Source)
This example demonstrates how to use the EnableBulkMode
option to insert a large number of records into Salesforce using the Bulk API (Job-based mode). Additionally, it shows how to set a lookup field—specifically the Owner
field—by referencing an external ID from the User
object instead of using the internal Salesforce ID.
If you are performing an Update operation, you must include the Id
field in the source data. If your source field has a different name, alias it to Id
in the SQL query. For Upsert operations, you can specify a custom external ID field using the Key='ExternalId_Field_Name'
option. However, for standard Update operations, the Id
field is mandatory.
By default, data is written in batches of 200 rows. When Bulk API mode is enabled, up to 10,000 rows can be sent per batch. This improves performance for large datasets, but offers little advantage for smaller volumes.
In this example, the driver type is set to MSSQL
. For other sources such as CSV, REST API, or Oracle, change the driver type to ODBC
and adjust the connection string and query accordingly.
Make sure the query outputs column names that match the target fields in the Salesforce object. The EXTERNAL
option is used to map input columns to Salesforce fields dynamically.
Important: If you’re using Windows authentication, ensure that the service account running the ZappySys Data Gateway has the appropriate access permissions on the source system.
INSERT INTO Account
SOURCE (
'MSSQL',
'Data Source=localhost;Initial Catalog=tempdb;Integrated Security=true',
'SELECT TOP 1000000
Account_Name as Name,
AccountOwnerId as [Owner.ExternalId]
FROM very_large_staging_table'
)
WITH (
Output = 1,
EnableBulkMode = 1
)
-- Notes:
-- 'MSSQL': External driver type (MSSQL, ODBC, OLEDB)
-- Output: Enables capturing __RowStatus and __ErrorMessage
-- EnableBulkMode: Improves performance with bulk batches (uses 10000 rows per batch rather than 200)
Bulk Mode - Delete Large Volume of Data (Read IDs from External Source)
This example demonstrates how to use the EnableBulkMode
option to delete a large number of records from Salesforce using the Bulk API (Job-based mode). To perform a delete operation, the source query must return the Id
column. If your source column has a different name, make sure to alias it as Id
in the SQL query.
By default, data is processed in batches of 200 rows. When Bulk API mode is enabled, batches can include up to 10,000 rows, which significantly improves performance when working with large datasets. However, for small volumes (a few hundred records), Bulk API mode may not offer a noticeable performance benefit.
In this example, the driver type is set to MSSQL
. For other data sources such as CSV, REST API, or Oracle, set the driver type to ODBC
and update the connection string and query as needed.
Ensure that the query output includes column names that match the target Salesforce object fields. The EXTERNAL
option allows dynamic mapping of input columns to Salesforce fields based on the source query.
Important: If you’re using Windows authentication, make sure the service account running the ZappySys Data Gateway has the necessary permissions to access the data source.
DELETE FROM Account
SOURCE (
'MSSQL',
'Data Source=localhost;Initial Catalog=tempdb;Integrated Security=true',
'SELECT TOP 1000000
Account_ID as Id
FROM very_large_staging_table'
)
WITH (
Output = 1,
EnableBulkMode = 1
)
-- Notes:
-- 'MSSQL': External driver type (MSSQL, ODBC, OLEDB)
-- Output: Enables capturing __RowStatus and __ErrorMessage
-- EnableBulkMode: Improves performance with bulk batches (uses 10000 rows per batch rather than 200)
Bulk Mode - Update Large Volume of Data (Read from External Source)
This example illustrates how to use the EnableBulkMode
option to update a large number of records in Salesforce via the Bulk API (Job-based mode). When performing an Update operation, the source query must include the Id
column. If the source column is named differently, be sure to alias it as Id
in your SQL query.
By default, records are processed in batches of 200 rows. When Bulk API mode is enabled, batches can handle up to 10,000 rows, which greatly improves performance for large datasets. However, for smaller datasets (e.g., a few hundred records), Bulk API may not offer a significant performance boost.
In this example, the driver type is set to MSSQL
. For other sources such as CSV, REST API, or Oracle, change the driver type to ODBC
and modify the connection string and query accordingly.
Ensure that your query returns column names matching the fields in the Salesforce target object. The EXTERNAL
option is used to dynamically map input columns to Salesforce fields based on the query output.
Important: When using Windows authentication, the service account running the ZappySys Data Gateway must have the necessary permissions on the source system.
UPDATE Account
SOURCE (
'MSSQL',
'Data Source=localhost;Initial Catalog=tempdb;Integrated Security=true',
'SELECT TOP 1000000
Account_ID as Id,
Account_Name as Name,
City as BillingCity
FROM very_large_staging_table'
)
WITH (
Output = 1,
EnableBulkMode = 1
)
-- Notes:
-- 'MSSQL': External driver type (MSSQL, ODBC, OLEDB)
-- Output: Enables capturing __RowStatus and __ErrorMessage
-- EnableBulkMode: Improves performance with bulk batches (uses 10000 rows per batch rather than 200)
Bulk Mode - Update Lookup Field (Read from External Source)
This example shows how to use the EnableBulkMode
option to update a large number of Salesforce records using the Bulk API (Job-based mode). In this scenario, we update a lookup field—specifically the Owner
field—by referencing the external ID from the User
object instead of using the internal Salesforce ID.
When performing an Update, the Id
field must be included in the source data. If your source column has a different name, alias it as Id
in the SQL query. For Upsert operations, you can specify a custom external ID using the Key='ExternalId_Field_Name'
option. However, for standard Update operations, the Id
field is required.
By default, the system processes 200 rows per batch. When EnableBulkMode
is enabled, it can process up to 10,000 rows per batch, offering improved performance for large datasets. This mode is less effective for smaller data volumes.
In this example, the driver type is set to MSSQL
. For other data sources (e.g., CSV, REST API, Oracle), change the driver type to ODBC
and update the connection string and query as needed.
Ensure the query returns column names that match the fields in the target Salesforce object. The EXTERNAL
option dynamically maps input columns to Salesforce fields based on the query output.
Important: If using Windows authentication, ensure the service account running the ZappySys Data Gateway has appropriate permissions on the source system.
UPDATE Account
SOURCE (
'MSSQL',
'Data Source=localhost;Initial Catalog=tempdb;Integrated Security=true',
'SELECT TOP 1000000
Account_ID as Id,
Account_Name as Name,
AccountOwnerId as [Owner.ExternalId]
FROM very_large_staging_table'
)
WITH (
Output = 1,
EnableBulkMode = 1
)
-- Notes:
-- 'MSSQL': External driver type (MSSQL, ODBC, OLEDB)
-- Output: Enables capturing __RowStatus and __ErrorMessage
-- EnableBulkMode: Improves performance with bulk batches (uses 10000 rows per batch rather than 200)
External Input from ODBC - Insert Multiple Rows from ODBC Source (e.g., CSV) into Salesforce
This example demonstrates how to perform an INSERT operation in Salesforce using multiple input rows from an external data source such as MSSQL, ODBC, or OLEDB. The operation reads records via an external query and inserts them directly into Salesforce.
In this example, the driver type is set to MSSQL
. For other systems like CSV, REST API, or Oracle, set the driver type to ODBC
and update the connection string and query accordingly.
Ensure that the query returns column names that match the fields in the Salesforce target object. The EXTERNAL
option is used to map these input columns to the corresponding Salesforce fields based on the source query output.
INSERT INTO Account
SOURCE (
'ODBC', -- External driver type: MSSQL, ODBC, or OLEDB
'Driver={ZappySys CSV Driver};DataPath=c:\somefile.csv', -- ODBC connection string
'
SELECT
Acct_Name AS Name,
Billing_City AS BillingCity,
Locations AS NumberofLocations__c
FROM $
WITH (
-- Either use SRC to point to a file or use inline DATA. Comment out one as needed.
-- Examples:
-- SRC = ''c:\file_1.csv''
-- SRC = ''c:\some*.csv''
-- SRC = ''https://abc.com/api/somedata-in-csv''
DATA = ''Acct_Name,Billing_City,Locations
Account001,City001,1
Account002,City002,2
Account003,City003,3''
)'
)
-- Notes:
-- Column aliases in SELECT must match Salesforce target fields.
-- Preview the Account object to verify available fields.
WITH (
Output = 1, -- Capture __RowStatus and __ErrorMessage for each record
-- EnableBulkMode = 1, -- Use Bulk API (recommended for 5,000+ rows)
EnableParallelThreads = 1, -- Use multiple threads for real-time inserts
MaxParallelThreads = 6 -- Set maximum number of threads
)
DML - Upsert Lookup Field Value Using External ID Instead of Salesforce ID
This example demonstrates how to set a lookup field value in Salesforce using an external ID rather than the internal Salesforce ID during DML operations such as INSERT, UPDATE, or UPSERT.
Typically, updating a lookup field requires the Salesforce ID of the related record. However, Salesforce also allows referencing a related record using an external ID field. To do this, use the following field name syntax:
[relationship_name.external_id_field_name(child_object_name)]
relationship_name
: The API name of the relationship (e.g.,Owner
orYourObject__r
).external_id_field_name
: A custom field on the related object, marked as External ID.child_object_name
(optional): The API name of the related object. If omitted, Salesforce derives it from the relationship name (without the__r
suffix).
Example:
To assign a record owner using a custom external ID on the User object:
Owner.SomeExternalId__c(User)
Owner
: The relationship name for the user record.SomeExternalId__c
: A custom external ID field in the User object.User
: The related (child) object name.
If you’re using the SOURCE(...)
clause to read input data and enabling BulkApiMode=1
in the WITH(...)
clause, you can omit the child object name. In that case, use the format:
relationship_name.external_id_field_name
Setting a Field to NULL:
To set a lookup or standard field to null, use:
FieldName = null
For example:
AccountId = null
Avoid using:
relation_name.external_id_name(target_table) = null
More Information:
For full details and examples, visit the official guide: ZappySys Docs - External ID in Lookup Fields
-- Upsert record into Salesforce Account object
UPSERT INTO Account (
Name,
BillingCity,
[Owner.SomeExternalId__c(User)] -- Use external ID field on related Owner (User) object
)
VALUES (
'mycompany name',
'New York',
'K100' -- External ID value of the User (Owner)
)
WITH (
KEY = 'SupplierId__c', -- External ID field used for UPSERT on Account object
Output = 1 -- Return __RowStatus and __ErrorMessage for result diagnostics
)
Supported WITH Properties in BULK Mode
When using the ZappySys Salesforce ODBC Driver with BULK mode, you can pass additional options using the WITH clause to customize behavior.
Here are other supported properties commonly used BULK mode:
INSERT INTO Account/UPDATE Account/DELETE FROM Account
SOURCE(...)
WITH(
Output=1 /*Other values can be Output='*' , Output=1 , Output=0 , Output='Col1,Col2...ColN'. When Output option is supplied then error is not thrown but you can capture status and message in __RowStatus and __ErrorMessage output columns*/
,EnableBulkMode=1 --use Job Style Bulk API (uses 10000 rows per batch rather than 200)
--,MaxRowsPerJob=500000 --useful to control memory footprint in driver
--,ConcurrencyMode='Default' /* or 'Parallel' or 'Serial' - Must set BulkApiVersion=2 to use this, Bulk API V1 doesnt support this yet. If you get locking errors then change to Serial*/
--,BulkApiVersion=2 --default is V1
--,IgnoreFieldsIfInputNull=1 --Set this option to True if you wish to ignore fields if input value is NULL. By default target field is set to NULL if input value is NULL.
--,FieldsToSetNullIfInputNull='SomeColum1,SomeColumn5,SomeColumn7' --Comma separated CRM entity field names which you like to set as NULL when input value is NULL. This option is ignored if IgnoreFieldsIfInputNull is not set to True.
--,AssignmentRuleId='xxxxx' --rule id to invoke on value assignment
--,UseDefaultAssignmentRule=1 --sets whether you like to use default rule
--,AllOrNone=1 --If true, any failed records in a call cause all changes for the call to be rolled back. Record changes aren't committed unless all records are processed successfully. The default is false. Some records can be processed successfully while others are marked as failed in the call results.
--,OwnerChangeOptions='option1,option2...optionN' -- use one or more options from below. Use '-n' suffix to disable option execution e.g. TransferOpenActivities-n
-->>> Available owner change options: EnforceNewOwnerHasReadAccess,TransferOpenActivities,TransferNotesAndAttachments,TransferOthersOpenOpportunities,TransferOwnedOpenOpportunities,TransferOwnedClosedOpportunities,TransferOwnedOpenCases,TransferAllOwnedCases,TransferContracts,TransferOrders,TransferContacts,TransferArticleOwnedPublishedVersion,TransferArticleOwnedArchivedVersions,TransferArticleAllVersions,KeepAccountTeam,KeepSalesTeam,KeepSalesTeamGrantCurrentOwnerReadWriteAccess,SendEmail
-->>> For more information visit https://zappysys.com/link/?id=10141
--,AllowFieldTruncation=1 --If true, truncate field values that are too long, which is the behavior in API versions 14.0 and earlier.
--,AllowSaveOnDuplicates=1 --Set to true to save the duplicate record. Set to false to prevent the duplicate record from being saved.
--,EnableParallelThreads=1 --Enables sending Data in multiple threads to speedup. This option is ignored when bulk mode enabled (i.e. EnableBulkMode=1)
--,MaxParallelThreads=6 --Maximum threads to spin off to speedup write operation. This option is ignored when bulk mode enabled (i.e. EnableBulkMode=1)
--,TempStorageMode='Disk' --or 'Memory'. Use this option to overcome OutOfMemory Error if you processing many rows. This option enables how Temp Storage is used for query processing. Available options 'Disk' or 'Memory' (Default is Memory)
)
More Examples and Documentation
For additional examples and detailed guidance on using the ZappySys Salesforce ODBC Driver, visit the official documentation:
Conclusion
In this article we showed you how to connect to Salesforce in UiPath and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys Salesforce Driver allows you to connect not only to Salesforce, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Salesforce Connector for UiPath and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Salesforce Connector for UiPath Documentation
More integrations
Other connectors for UiPath
Other application integration scenarios for Salesforce
How to connect Salesforce in UiPath?
How to get Salesforce data in UiPath?
How to read Salesforce data in UiPath?
How to load Salesforce data in UiPath?
How to import Salesforce data in UiPath?
How to pull Salesforce data in UiPath?
How to push data to Salesforce in UiPath?
How to write data to Salesforce in UiPath?
How to POST data to Salesforce in UiPath?
Call Salesforce API in UiPath
Consume Salesforce API in UiPath
Salesforce UiPath Automate
Salesforce UiPath Integration
Integration Salesforce in UiPath
Consume real-time Salesforce data in UiPath
Consume real-time Salesforce API data in UiPath
Salesforce ODBC Driver | ODBC Driver for Salesforce | ODBC Salesforce Driver | SSIS Salesforce Source | SSIS Salesforce Destination
Connect Salesforce in UiPath
Load Salesforce in UiPath
Load Salesforce data in UiPath
Read Salesforce data in UiPath
Salesforce API Call in UiPath