Salesforce

INFO

Salesforce is an enterprise cloud computing firm. It specializes in social and mobile cloud technologies, including sales and CRM applications helping companies connect with customers, partners, and employees.

Prerequisites

INFO

Make sure you have your Salesforce instance configured accordingly. Datameer will retrieve the data with an OAuth token - without revealing a username and a password to Datameer X.

To prepare your Salesforce instance:

Login as an Admin or ask an authorized person to execute the setup.
Create a new 'Connected App'. The steps differ depending on whether you us an old or a new Salesforce Interface:
- Old UI: "Built" → "Create" → "Apps" → "Connected Apps" → "New"
- New UI: "Platform Tools" → "Apps" → "Connected Apps" → "App Manager" → "New Connected App"
Switch to the "API (Enable OAuth Settings)" section and tick the "Enable OAuth Settings" checkbox.

Set the Callback URLs (Datameer Application Server URL):

http://<datameer application server hostname>:<port>/properties/external-callback-button
https://<datameer application server hostname>:<port>/properties/external-callback-button

Add the following OAuth scopes:
- Full Access
- Manage Use Data via Web Browsers
- Platform Requests at Any Time
Leave all the rest default parameters and save the settings.
Open this Connected App settings and pick up its client ID and client secret values.

To prepare your Datameer X instance:

Open the 'live.properties" file under '/<Datameer installation folder>/conf/live.properties' and add the following lines at the end:

#Salesforce Connectetd Apps details for get OAuth token
system.property.webservice.salesforce.oauth.client-id=<client-id of the Saleforce Connected App>
system.property.webservice.salesforce.oauth.client-secret=<client-secret of the Saleforce Connected App>

Restart Datameer X.

Configuring Salesforce as a Connection

Click the "+" button and select "Connection" or right-click in the File Browser and select "Create New" → "Connection". The "New Connection" tab appears in the menu bar.
Select "Salesforce" from the drop-down and confirm with "Next". The type is displayed in the drop-down.
Select the web service protocol to be used from the drop-down.
Enter the host address and the port, where the web service is running on.
Enter the root path.
To authenticate, click on “Authorize Datameer to retrieve data”. You are then taken to the http://salesforce.com portal to generate an OAuth access token for Datameer. The OAuth code is automatically transferred to the appropriate field.
Confirm with “Next”.
If needed, enter a description and confirm with "Next". The 'Save Connection' dialog opens.
Select the folder to save the connection, enter a name in "Save as" and confirm with "Save". The connection is saved. Configuring the Salesforce connection is finished.

Importing Data with the Salesforce Connector

Applicable Custom Properties

INFO

You can use custom properties to modify the importing process to your needs.

Custom Property	Example Value	Default Value	Description
datameer.plugin-webservice.read-timeout.ms	120000 (~2 minutes)	120000	sets a HTTP response data read timeout
datameer.salesforce.maxrecords-per-result-request	600000	determined by the Salesforce API endpoint	specifies the maximum number of records within a batch
datameer.salesforce.max-parallel-result-request	2	1	specifies the maximum number of batches, that are fetched in parallel

Importing Data with the Salesforce Connector

Click the + (plus) button and select Import Job or right-click in the browser and select Create new > Import Job.
Click Select Connector, choose the Salesforce connector, and click Next.
Enter a search Salesforce Query (SOQL) and click Next.
Review the defined fields and click Next.
Review the schedule and advanced properties for the job and click Next.
Create a description for the import job and click Save.