Skip to main content

Salesforce Source Connector

The Salesforce source connector lets DataSync retrieve data from Salesforce and load it into your data warehouse. Setting up the connector takes two steps that work together. First, you create a external client app in Salesforce that gives DataSync permission to access your data. Then, you create a source connection in DataSync using the credentials from that app. The two configurations need to reference each other, so it helps to keep both Salesforce and DataSync open side by side while you work.

Once your source connection is ready, configure your destination connection to finish the setup.

Step 1: Configure a external client app in Salesforce​

Create an external client app​

  1. Log in to Salesforce.
  2. Select the gear icon at the top right, then Setup.
  3. Under Platform Tools, expand Apps, then select App Manager.
  4. Select New External Client App in the upper-right corner.
  5. Fill in all mandatory fields under Basic Information.
  6. Under API (Enable OAuth Settings), check Enable OAuth.
  7. In Callback URL, paste the callback URL shown in the connection properties in DataSync.
  8. In Available OAuth Scopes, select the scopes your team needs for data access and move them to Selected OAuth Scopes using the arrow. The scopes vary depending on your Salesforce setup and what data you want to access.
  9. Deselect Require Proof Key for Code Exchange (PKCE).
  10. Select Create.

Retrieve your app credentials​

  1. Under Platform Tools, expand Apps.
  2. Expand External Client Apps and select OAuth Usage.
  3. Select your app.
  4. Open the Settings tab, then expand OAuth Settings.
  5. Select Consumer Key and Secret.
  6. Copy the Consumer Key (this is your Client ID in DataSync) and the Consumer Secret (this is your Client Secret). You'll need both in the next step.

Step 2: Create the source connection in DataSync​

  1. Log in to DataSync.
  2. From the welcome screen, select Connections.
  3. Next to Source Connections, select New.
  4. Select Salesforce.
  5. Enter all the required connection properties.
  6. (Optional) In the Additional Connection Properties panel, select Add property and enter the parameters you need.
  7. Configure the advanced settings that match your environment, including Tracking Type.
  8. Wait 2 to 10 minutes to before saving so Salesforce fully register the new app.
  9. Select Save.

important

Salesforce needs 2 to 10 minutes to fully register the new app. If you create the DataSync connection too soon, you'll see an invalid_client_id error. If so, edit the connection and select Authenticate and Save, then Allow to complete the setup.

Parameters​

Connection properties​

PropertyDescription
DescriptionUnique name for the connection. Example: Salesforce.
Callback URLRedirect URL automatically generated by DataSync. Paste it into your external client app in Salesforce.
Client IDThe Consumer Key from your external client app in Salesforce. Example: 3MVG9k02hQhyUgQDmCknDvKr8oP35RkPV6Uc4j7vP9KQH8bM2NwL1JpYz853vQrc2bN1aD6yR5tK9pE4mW0fG.
Client SecretThe Consumer Secret from your external client app in Salesforce. Example: 7B6F9C8F2E1A5BZC9D0E3F4A7B6C7D8E9F0G1B2C3D4E5FEA7B8C9D0E1F293B4C.
VerbosityControls how much detail the connector writes to the log. Each level includes everything from the level below, plus extra detail.

  • 1 logs queries, row counts, execution start and end times, and errors.
  • 2 adds cache queries and HTTP headers.
  • 3 adds request and response bodies.
  • 4 adds transport-level communication.
  • 5 adds all interface commands.
Enable PoolingTurns on connection pooling for better performance.
Pool idle timeoutMaximum idle time, in seconds, before a connection returns to the pool.
Max Pool SizeMaximum number of connections allowed in the pool.
Pool wait timeMaximum wait time, in seconds, for a connection before an error is thrown.

Additional connection properties​

Use this panel to enter connection string properties that are not available in the Connection Properties panel. For each property, select Visible or Encrypted. Use Encrypted for sensitive values such as passwords. The value is hidden in the interface and stored encrypted in the back end.

PropertyDescription
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​

These settings control how the Salesforce connector tracks data changes, handles time and regional configuration, and processes records during extraction. Configure them to match your system environment to get accurate and consistent results.

SettingDescription
Tracking TypeMethod for tracking changes: None or Date.
RegionRegion setting for the connector, if required by your setup.
Time ZoneTime zone matching your Salesforce environment.
Time OffsetRefresh offset in seconds to compensate for timing issues in record selection. Minimum 0, maximum 3600.
Batch SizeNumber of records processed in each batch during extraction. Larger batches use more memory but can improve performance. The default is 2000 and the maximum is 10000. Adjust based on your network speed and disk performance. In most cases, the default works best.

Example setup​

Salesforce source connection in DataSync
A completed Salesforce source connection in DataSync, with all properties and settings filled in.

Update the callback URL on an existing app​

If your app is already set up and you just need to change the callback URL:

  1. Log in to Salesforce.
  2. Select the gear icon at the top right, then Setup.
  3. Under Platform Tools, expand Apps, then External Client Apps.
  4. Select OAuth Usage.
  5. Choose your app, then open the Settings tab.
  6. Select Edit in the top-right corner.
  7. Update the Callback URL.
  8. Select Save.