Salesforce
How to configure a Salesforce connection
Last updated
How to configure a Salesforce connection
Last updated
This document describes the Dataworkz connector configuration required to access Salesforce. This document walks through the steps needed to setup Salesforce account and to configure a connector for the same in Dataworkz.
Before configuring Dataworkz for Salesforce, a "Connected App" needs to be configured in Salesforce. Following steps should be followed for the purpose.
Login to Salesforce account through Salesforce login page (Login | Salesforce ). If there is no account, register for the new account Developer Edition Signup | Salesforce Developers
On Home page after login, use classical mode and select setup option.
Once entered into setup page, select Build → Create-> Apps from left Menu.
Click on “New” to create Connected Apps.
Fill in all required details and select “Enable OAuth Settings”.
Enter the “Callback URL” . This value can obtained by following the steps listed under Private Connected App
Select the following “OAuth scopes”.
Manage user data via APIs (api)
Manage user data via web browsers (web)
Perform requests at any time (refresh_token, offline_access)
For certificate based authentication select “Use Digital Signature”
Click “Save”. You will see the message about app activation after 10 mins.
Click “Continue”
Click “Manage”
Click “Edit Policies”
For certificate based authentication, change OAuth policy to set permitted users to “Admin Approved Users are PreAuthorized.”
Set appropriate value for "Refresh Token Policy" (e.g. Expire refresh token if not used for 90 days).
Click on “Save” to create the connected app. When connected app is created, it will be displayed under “Connected Apps”.
Go to “Manage Users” -> "Users" section and select user that was used for connected app authentication. Click on “System Administrator” profile link.
On profile screen, click on Edit button.
On edit page, tick the connected app that needs to be used for the key based authentication. Click save. This step is needed only when certificate based authentication was selected.
Click on the defined connected app under the “Connected App” section. Following screen will display the consumer key and the consumer secret. Click on reveal to view secret.
Login to Dataworkz Application
Goto Configuration -> SaaS Applications -> Salesforce
Click the + icon to add a new configuration
Enter name for the connector
Select the OAuth option
If custom app isn't already created selecting "No" would give the "Redirect URL" that can be used for created connected app in Saleforce
Enter the Client ID and Secret that was configured during creation of the connected app
Select the Salesforce environment (Production/Sandbox)
Select the Workspace & Collection that would contain the resulting dataset
Select the Salesforce environment (Production/Sandbox)
Select the Workspace & Collection that would contain the resulting database
Upon saving you will be prompted to login. Upon successful login the configuration would be saved
Select the Salesforce environment (Production/Sandbox)
Select the Workspace & Collection that would contain the resulting database
Upon saving you will be prompted to login. Upon successful login the configuration would be saved
Goto Configuration -> SaaS Applications -> Salesforce
Click the Salesforce connector that was created in the previous section
It will open Configuration tab. Click the + icon to add a new configuration
Enter name of the dataset that would comprise the Salesforce object data
Select the type of object to be discovered
Select the Salesforce object to be queried
Select the fields that need to be retrieved for the selected object
Choose between pulling all the historic data or for a date range
Select the criteria for the incremental pull
Toggle between one time and recurring pull
Click add to create the configuration
For ability to write back to the Salesforce instance, click the "Write back permissions" tab
Select the Entities to which the write back is needed
Click Save
