Connection

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
oauth_refresh_tokenstringfalsefalse
connect_modestringDefault: browser (i.e. oauth through Polytomic). If ‘code’ is specified, the response will include an auth_code for the user to enter when completing authorization. NOTE: when supplying client_id and client_secret the connect mode must be ‘api’. Accepted Values: browser, clientcredentials, code, apifalsefalse
client_idstring(required if connect_mode is “clientcredentials”)falsefalse
client_secretstring(required if connect_mode is “clientcredentials”)falsefalse
domainstringThe Salesforce instance’s login domain, e.g. acmecorp.my.salesforce.comtruefalse
usernamestringfalsetrue
enforce_api_limitsbooleanIf true, Polytomic will restrict itself to a fixed daily cap of Salesforce API calls enforced by the number in daily_api_calls.falsefalse
daily_api_callsintegerThe daily Salesforce API call cap that Polytomic should adhere to.falsefalse
enable_toolingbooleanIf true, expose objects from the Salesforce Tooling API in the Polytomic bulk sync source object list.falsefalse
enable_multicurrency_lookupbooleanIf incremenetal mode for bulk-syncing from Salesforce formula fields is enabled, setting this to true extends support to accurate currency conversions.falsefalse

Example

1{
2 "name": "salesforce connection",
3 "type": "salesforce",
4 "configuration": {
5 "client_id": "a45gadsfdsaf47byor2ugfbhsgllpf12gf56gfds",
6 "client_secret": "ay8d5hdepz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq",
7 "connect_mode": "api",
8 "daily_api_calls": 0,
9 "domain": "http://instance.my.salesforce.com",
10 "enable_multicurrency_lookup": false,
11 "enable_tooling": false,
12 "enforce_api_limits": false,
13 "oauth_refresh_token": "dasfdasz62px8lqeoakuea2ccl4rxm13i6tbyorxhu1i20kc8ruvksmzxq"
14 }
15}

Model Sync

Source

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
tablestringObjectfalsefalse
querystringfalsefalse
include_deletedbooleanInclude deleted recordsfalsefalse

Example

1{
2 ...
3 "configuration": {
4 "include_deleted": false,
5 "query": "select Id from Contact",
6 "table": "Contact"
7 }
8}

Target

Configuration

NAMETYPEDESCRIPTIONREQUIREDREADONLY
ingestion_apistringIngestion APItruefalse
bulk_batch_sizeintegerBulk batch sizefalsefalse
concurrency_modestringConcurrency modefalsefalse
sort_batches_bystringSort batches byfalsefalse
insert_null_valuesbooleanCopy null valuesfalsefalse
ignore_invalid_referencesbooleanIgnore invalid external ID referencesfalsefalse
only_sync_differentbooleanOnly update if different from Salesforcefalsefalse

Example

1{
2 ...
3 "target": {
4 "configuration": {
5 "bulk_batch_size": 100,
6 "concurrency_mode": "Parallel",
7 "ignore_invalid_references": false,
8 "ingestion_api": "bulk",
9 "insert_null_values": false,
10 "only_sync_different": false,
11 "sort_batches_by": "AccountId"
12 }
13 }
14}