Salesforce
Guide to integrate your Salesforce with Sprinkle
Datasource Concepts
Before setting up the datasource, learn about datasource concepts here
Step by Step Guide
STEP-1: Configure Connection
To learn about Connection, refer here
Log into Sprinkle application
Navigate to Datasources -> Connections Tab -> New Connection ->
Select Salesforce
Provide all the mandatory details
Name: Name to identify this connection
Server Location: After login to salesforce account, from url you can copy server location. ex- https://ap16.lightning.force.com/lightning/page/home for this url ap16 is domain.
Username: This is same username/email which is used to login to salesforce.
Password: This is same password which is used to login salesforce.
Advance Settings : Refer here
Test Connection
Create
STEP-2: Configure Datasource
To learn about datasource, refer here
Navigate to Datasources -> Datasources Tab -> Add ->
Select Salesforce
Provide the name -> Create
Connection Tab:
From the drop-down, select the name of connection created in STEP-2
Update
STEP-3: Create Dataset
Datasets Tab: To learn about Dataset, refer here. Add Dataset for each report/dataset that you want to integrate, providing following details
Table Type (Required) :
Standard Objects
Standard Object: Select the name from the drop-down
Query
Query: Provide the Query string
Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type.
Destination Schema (Required) : Data warehouse schema where the table will be ingested into
Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<datasourcename>_<tablename>
Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. Learn more on how to use this field.
Create
STEP-4: Run and schedule Ingestion
In the Ingestion Jobs tab:
Trigger the Job, using Run button
To schedule, enable Auto-Run. Change the frequency if required
Advanced Connection Settings
API Read Timeout (In seconds) : Maximum time of inactivity between two data packets when waiting for the server's response. The default value is 30 seconds
API Connection Timeout (In seconds) : Time period within which a connection between a client and a server must be established.
Version : It gives information about the version of Salesforce API being used.