Salesforce Connector for SSIS

Salesforce 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 SSIS without coding. We will use high-performance Salesforce Connector to easily connect to Salesforce and then access the data inside SSIS.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Salesforce Connector for SSIS is based on ZappySys Native SSIS Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them).

Video Tutorial - Integrate Salesforce data in SSIS

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

How to download and install the required PowerPack for Salesforce integration in SSIS
How to configure the connection for Salesforce
Features of the ZappySys Salesforce Source (Authentication / Query Language / Examples / Driver UI)
How to use the Salesforce in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from Salesforce in SSIS (Export data)

In this section we will learn how to configure and use Salesforce Connector in the SalesForce source to extract data from the Salesforce.

Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
From the SSIS toolbox drag and drop ZS SalesForce Source on the data flow designer surface, and double click on it to edit it:
Select New Connection to create a new connection:
Now in Connection Manager UI, Enter your SalesForce Credentials (User Name, Password and Security Token), and leave all other properties as it is.

In the Error Retry Settings, you can use more settings.

Click on Test Connection to check configure correct or not. Upon Test Connection Successful, Click on OK button to save Salesforce Connection Manager configure setting UI.
Read data from SalesForce table using SalesForce Source(Query Mode & Table Mode).
- How to read data from SalesForce table using SalesForce Source(Query Mode).
  
  Here, we are getting data using Query Mode with Dynamic expression value.
  
  Lets, create a Variable with correct DataType and Value, use following image.
  
  Double click on SalesForce Source component to configure it.
  
  Select connection we have created before, set AccessMode to Query, Enter Following Query and Replace Variables if differ name. Click here for more SOQL Query Examples
  
  SELECT Id, Name, BillingCountry, NumberOfEmployees FROM Account WHERE Name LIKE '{{User::Name}}' and BillingCountry = '{{User::BillingCountry}}' and NumberOfEmployees >= {{User::NumberOfEmployees}}
  
  Click on Preview button to see Data Preview
  
  Click on OK button to save configure setting UI
- How to read data from SalesForce table using SalesForce Source(Table Mode).
  
  Select connection we have created before, set AccessMode to Table and Select Tables from table dropdown list.
  
  Click on OK button to save configure setting UI
That's it; we are done. In a few clicks we configured the call to SalesForce using ZappySys Salesforce Connector

Write to Salesforce in SSIS (Import data)

In upper section we learned how to read data, now in this section we will learn how to configure Salesforce in the Salesforce Destination to Post data to the Salesforce.

Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
From the SSIS Toolbox drag and drop ZS Salesforce Destination on the Data Flow Designer surface and connect source component with it, and double click to edit it.
Select New Connection to create a new connection:
Now, In the Component Properties, Set Operation to UpdateOrInsert, select TableName and UpsertKeyField.
In the Columns Mappings Tab, Map Primary Column and other you want to update or insert records.
Now, Click on OK button to save SalesForce Destination configure setting UI.

That's it; We successfully configured the SalesForce Call. In a few clicks we configured the Salesforce call using ZappySys Salesforce Connector.

Load Salesforce data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Salesforce data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
Connect your SSIS source component to Upsert Destination.
Double-click on Upsert Destination component to open configuration window.
Start by selecting the Action from the list.
Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
Then select a table from the Target Table list or click New button to create a new table based on the source columns.
Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).
Finally, click Map All button to map all columns and then select the Key columns to match the columns on:
Click OK to save the configuration.
Run the package and Salesforce data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

How to design, debug, deploy, schedule SSIS Package (In SQL Agent and Catalog)

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Preparing ADF instance to use SSIS PowerPack

Centralized data access via Data Gateway

In some situations, you may need to provide Salesforce data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

Centralized data access
The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
Centralized access control
Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

	Data Gateway	Local ODBC data source
Simple configuration
Installation	Single machine	Per machine
Connectivity	Local and remote	Local only
Connections limit	Limited by License	Unlimited
Central data access
Central access control
More flexible cost

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Salesforce, and to create an ODBC data source to connect to Data Gateway in SSIS.

Let's not wait and get going!

Creating Salesforce data source in Gateway

In this section we will create a data source for Salesforce in Data Gateway. Let's follow these steps to accomplish that:

Download and install ODBC PowerPack.
Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:
Go to Users tab and follow these steps to add a Data Gateway user:
- Click Add button
- In Login field enter username, e.g., john
- Then enter a Password
- Check Is Administrator checkbox
- Click OK to save
Now we are ready to add a data source:
- Click Add button
- Give Datasource a name (have it handy for later)
- Then select Native - ZappySys Salesforce Driver
- Finally, click OK
SalesforceDSN

ZappySys Salesforce Driver
When the ZappySys Salesforce Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.
Very important step. Now, after creating or modifying the data source make sure you:
- Click the Save button to persist your changes.
- Hit Yes, once asked if you want to restart the Data Gateway service.
This will ensure all changes are properly applied:

Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from SSIS. To achieve that, let's perform these steps:

Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

ODBC Driver 17 for SQL Server

If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.
Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

GatewayDSN

localhost,5000

Make sure you separate the hostname and port with a comma, e.g. localhost,5000.
Proceed with authentication part:
- Select SQL Server authentication
- In Login ID field enter the user name you used in Data Gateway, e.g., john
- Set Password to the one you configured in Data Gateway
Then set the default database property to SalesforceDSN (the one we used in Data Gateway):

SalesforceDSN
Continue by checking Trust server certificate option:
Once you do that, test the connection:
If connection is successful, everything is good:
Done!

We are ready to move to the final step. Let's do it!

Accessing data in SSIS via Data Gateway

Finally, we are ready to read data from Salesforce in SSIS via Data Gateway. Follow these final steps:

Go back to SSIS.
From the SSIS toolbox drag and drop ODBC Source on the dataflow designer surface:
Double-click on ODBC Source component to configure it.
Click on New... button, it will open Configure ODBC Connection Manager window. Once it opens, click on New... button to create a new ODBC connection to Salesforce ODBC data source:
Then choose the data source from the list and click Test Connection button. If the connection test is successful, close the window, and then click OK button to finish the configuration:

GatewayDSN
Read the data the same way we discussed at the beginning of this article.
That's it!

Now you can connect to Salesforce data in SSIS via the Data Gateway.

If you are asked for authentication details, use Database authentication or SQL Authentication option and enter credentials you used when configuring Data Gateway, e.g. john and your password.