Skip to main content

Salesforce Source Connector

The Salesforce source connector in DataSync lets you retrieve data from Salesforce for loading or synchronizing in your data warehouse. After creating all required source connections, configure your destination source to complete the connection setup.

Configure a Connected App in Salesforce

Before configuring the Salesforce connector in DataSync, you must create a Connected App in Salesforce to obtain the authentication credentials.

Create a Connected App

  1. Log in to Salesforce.
  2. Select the Home tab.
  3. Under Platform Tools, expand Apps, then select App Manager.
  4. Click New Connected App in the upper-right corner.
  5. Enter a descriptive name for the app.
  6. In Contact Email, enter a valid email address.
  7. Select Enable OAuth Settings.
  8. In Callback URL, paste the Callback URL shown in the Connection Properties of the Salesforce connector setup in DataSync.
  9. In the Available OAuth Scopes list, select the required scopes for data access and move them to Selected OAuth Scopes using the arrow.
  10. Deselect Require Proof Key for Code Exchange (PKCE).
  11. Click Save, then Continue. Wait 2 to 10 minutes before using this Connected App.

Retrieve your app credentials

  1. Under Platform Tools, expand Apps, Connected Apps, then select Manage Connected Apps.
  2. Under API (Enable OAuth Settings), copy the Consumer Key (this is the Client ID) and Consumer Secret — you will need both in DataSync.

Update an existing Connected App's Callback URL

If you already have a Connected App and need to update the Callback URL:

  1. Log in to Salesforce.
  2. Select the Home tab.
  3. Under Platform Tools, expand Apps, then select App Manager.
  4. Locate your Connected App, click the dropdown icon to the right, and select Edit.
  5. Change the Callback URL.
  6. Click Save.

Create source connections in DataSync

  1. Log in to DataSync.
  2. From the welcome screen, select Connections.
  3. Next to Source Connections, click New.
  4. Select Salesforce.
  5. In the Connection Properties panel, enter the connection properties.
  6. (Optional) In the Additional Connection Properties panel, select Add property and enter the parameters for each property.
  7. In the Advanced Settings panel, configure the settings, including the Tracking Type and other values according to your requirements.
  8. Click Save only after you have waited at least 2 to 10 minutes since creating the Connected App to avoid errors.

note

If you see error=invalid_client_id&error_description=client%20identifier%20invalid, wait a few minutes, then edit the Salesforce source connection in DataSync. Click Authenticate and Save, then Allow.

Parameters

Connection properties

ParameterDescription
DescriptionUnique name for the connection. Example: Salesforce
Callback URLRedirect URL automatically generated by DataSync. Must be added to the Connected App in Salesforce.
Client IDConsumer Key from the Salesforce Connected App OAuth settings.
Client SecretConsumer Secret from the Salesforce Connected App OAuth settings.
Verbosity
  • 1 – Log queries, row counts, execution start/end, errors.
  • 2 – Includes level 1 plus cache queries, HTTP headers.
  • 3 – Includes level 2 plus request/response bodies.
  • 4 – Includes level 3 plus transport-level communication.
  • 5 – Includes level 4 plus all interface commands.
Enable PoolingConnection pooling option for performance.
Pool idle timeoutMaximum idle time for connections before returning them to the pool, in seconds.
Max Pool SizeMaximum number of connections allowed in the pool.
Pool wait timeMaximum wait time for connection allocation before error is thrown, in seconds.

Additional connection properties

Additional connection string properties not specified in the Connection Properties panel. For each property added, you can choose Visible or Encrypted. Selecting Encrypted hides the value from the interface and stores it encrypted in the back end, such as when defining passwords.

ParameterDescription
PropertyConnection string property that defines the action or behavior. Example: ReadOnly
ValueValue for the property. Example: True
TypeVisibility of the property: Visible or Encrypted.

Advanced settings

Advanced settings control how the Salesforce connector tracks changes, handles regional and time configuration, and processes data batches during extraction. These options allow fine‑tuning for performance and accuracy, and should be configured according to your system environment and operational requirements.

SettingDescription
Tracking TypeMethod for tracking changes: None or Date.
RegionRegion setting for the connector, if required by your setup.
Time ZoneTime zone matching the Salesforce application server.
Time OffsetRefresh offset in seconds to compensate for timing issues in record selection. Minimum value is 0; maximum is 3600 seconds.
Batch SizeQuantity of records processed in each batch during extraction. Larger batch sizes increase memory usage but can improve performance up to a point. The default value is 2000 and the maximum should not exceed 10000 records. Adjust according to your network speed and disk performance; in most cases the default (2000) works best.

Example