Salesforce (2023-04-25) — Polytomic Docs

Connection

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
oauth_refresh_token	string		false	false
connect_mode	string	Default: 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, api	false	false
client_id	string	(required if `connect_mode` is “clientcredentials”)	false	false
client_secret	string	(required if `connect_mode` is “clientcredentials”)	false	false
domain	string	The Salesforce instance’s login domain, e.g. acmecorp.my.salesforce.com	true	false
username	string		false	true
enforce_api_limits	boolean	If true, Polytomic will restrict itself to a fixed daily cap of Salesforce API calls enforced by the number in daily_api_calls.	false	false
daily_api_calls	integer	The daily Salesforce API call cap that Polytomic should adhere to.	false	false
enable_tooling	boolean	If true, expose objects from the Salesforce Tooling API in the Polytomic bulk sync source object list.	false	false
enable_multicurrency_lookup	boolean	If incremenetal mode for bulk-syncing from Salesforce formula fields is enabled, setting this to true extends support to accurate currency conversions.	false	false

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

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
table	string	Object	false	false
query	string		false	false
include_deleted	boolean	Include deleted records	false	false

Example

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

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
ingestion_api	string	Ingestion API	true	false
bulk_batch_size	integer	Bulk batch size	false	false
concurrency_mode	string	Concurrency mode	false	false
sort_batches_by	string	Sort batches by	false	false
insert_null_values	boolean	Copy null values	false	false
ignore_invalid_references	boolean	Ignore invalid external ID references	false	false
only_sync_different	boolean	Only update if different from Salesforce	false	false

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 }

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	}

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

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	}