You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sources/salesforce/README.md
+60-5Lines changed: 60 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,21 +37,76 @@ Here, we chose BigQuery as the destination. Alternatively, you can also choose r
37
37
38
38
## Setup verified source and pipeline example
39
39
40
-
To grab credentials and initialize the verified source, please refer to the [full documentation here.](https://dlthub.com/docs/dlt-ecosystem/verified-sources/salesforce)
40
+
To initialize the verified source, please refer to the [full documentation here.](https://dlthub.com/docs/dlt-ecosystem/verified-sources/salesforce)
41
41
42
-
## Add credentials
42
+
## Add credentials and configs
43
43
44
44
1. Open `.dlt/secrets.toml`.
45
-
2. Enter the user name, password and security token:
45
+
2. Enter the username, password and security token:
46
46
```toml
47
47
# put your secret values and credentials here. do not share this file and do not push it to github
48
-
[sources.salesforce]
48
+
[sources.salesforce.credentials]
49
49
user_name = "please set me up!"# Salesforce user name
50
50
password = "please set me up!"# Salesforce password
51
51
security_token = "please set me up!"# Salesforce security token generated
52
52
```
53
+
54
+
Alternatively, you may authenticate using any method supported by the underlying `simple_salesforce` library. For instructions on obtaining these credentials, please consult Salesforce’s documentation.
55
+
56
+
- IP-whitelist + organization ID:
57
+
```toml
58
+
[sources.salesforce.credentials]
59
+
user_name = "please set me up!"
60
+
password = "please set me up!"
61
+
organization_id = "please set me up!"
62
+
```
63
+
64
+
- Session ID + instance:
65
+
```toml
66
+
[sources.salesforce.credentials]
67
+
session_id = "please set me up!"
68
+
instance = "please set me up!"# OR
69
+
instance_url = "please set me up!"
70
+
```
71
+
72
+
- JWT method:
73
+
```toml
74
+
[sources.salesforce.credentials]
75
+
user_name = "please set me up!"
76
+
consumer_key = "please set me up!"
77
+
privatekey_file = "please set me up!"# OR
78
+
privatekey = "please set me up!"
79
+
instance_url = "please set me up!"# Optional
80
+
```
81
+
82
+
- Connected app method:
83
+
```toml
84
+
[sources.salesforce.credentials]
85
+
user_name = "please set me up!"
86
+
password = "please set me up!"
87
+
consumer_key = "please set me up!"
88
+
consumer_secret = "please set me up!"
89
+
```
53
90
54
-
3. Enter credentials for your chosen destination as per the [docs.](https://dlthub.com/docs/dlt-ecosystem/destinations/)
91
+
- Client credentials method:
92
+
```toml
93
+
[sources.salesforce.credentials]
94
+
consumer_key = "please set me up!"
95
+
consumer_secret = "please set me up!"
96
+
domain = "please set me up!"
97
+
```
98
+
99
+
3. You can set up the following optional configs in your `.dlt/config.toml` file that will be used to connect to Salesforce:
100
+
101
+
```toml
102
+
[sources.salesforce]
103
+
domain = "please set me up!"# Set to "test" if sandbox
104
+
version = "please set me up!"# Version of the Salesforce API to use, defaults to 59.0
105
+
proxies = "please set me up!"# Mapping of protocols to proxy servers
106
+
client_id = "please set me up!"# App identifier for Salesforce API usage tracking
107
+
```
108
+
109
+
4. Enter credentials for your chosen destination as per the [docs.](https://dlthub.com/docs/dlt-ecosystem/destinations/)
0 commit comments