/
meltano.yml
135 lines (125 loc) · 5.26 KB
/
meltano.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
capabilities:
- discover
- properties
- state
description: Customer-relationship management & customer success platform
domain_url:
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_what_is_rest_api.htm
hidden: true
keywords:
- api
label: Salesforce
logo_url: /assets/logos/extractors/salesforce.png
maintenance_status: inactive
name: tap-salesforce
namespace: tap_salesforce
pip_url: git+https://gitlab.com/meltano/tap-salesforce.git@v1.5.0
quality: silver
repo: https://gitlab.com/meltano/tap-salesforce
select:
- Lead.*
- Contact.*
- User.*
- OpportunityHistory.*
- Account.*
- Opportunity.*
settings:
- description: Used to switch the behavior of the tap between using Salesforce’s “REST”
and “BULK” APIs.
kind: options
label: API Type
name: api_type
options:
- label: REST
value: REST
- label: BULK
value: BULK
value: REST
- description: Salesforce client ID. See
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.html.
label: Client ID
name: client_id
- description: Salesforce client secret. See
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.html.
kind: password
label: Client Secret
name: client_secret
sensitive: true
- description: Use Salesforce Sandbox
kind: boolean
label: Is Sandbox
name: is_sandbox
value: false
- description: Maximum number of threads to use.
kind: integer
label: Maximum number of threads to use
name: max_workers
value: 8
- description: The password used to sign in to your Salesforce account.
kind: password
label: Password
name: password
placeholder: Ex. *****************
sensitive: true
- description: Salesforce refresh token. See
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.html.
kind: password
label: Refresh Token
name: refresh_token
sensitive: true
- description: |
#### How to get
If you don't already have a Salesforce Security Token for your account, you can generate one through the following steps:
1. Sign in to your [Salesforce Account](https://login.salesforce.com/).
1. Go to your Account Settings (top right on the header bar)
1. Click `Reset My Security Token` (Under the `My Personal Information` section)
1. Click `Reset Security Token`
An email with the Security Token will be sent to your email.
> **Tip: Why is my "Reset Security Token" option missing?**
>
> If a user’s profile is configured such that there is a restriction on the IP ranges that can access Salesforce, then that user will not have the ability to access/reset their security token.
>
> In order to give access to the security token, either remove the user from the profile that contains the IP range restriction, or update the user’s profile by removing the IP range restriction.
>
> In rare cases where the user’s profile doesn’t contain IP range restriction and they still can’t access the security token reset option, edit the user’s profile and save (without making any actual changes to the profile).
> **Tip:** When you reset your Salesforce password, your security token resets as well. If that security token is used to integrate Meltano with Salesforce, that integration will break as well. Each time you reset an account password used to connect Meltano or other applications to Salesforce, you will need to re-enter your new security token into that application.
> **Warning:** If you have other third-party applications integrated with Salesforce and you reset your security token, that integration will break. Try to use your existing Security Token instead of resetting your existing one. Otherwise, you will need to re-enter your new security token into all the connected applications.
documentation: https://hub.meltano.com/extractors/salesforce.html#salesforce-setup
kind: password
label: Security Token
name: security_token
placeholder: Ex. *****************
sensitive: true
- description: Select by default any new fields discovered in Salesforce objects
kind: boolean
label: Select Fields By Default
name: select_fields_by_default
value: true
- description: Determines how much historical data will be extracted. Please be aware
that the larger the time period and amount of data, the longer the initial extraction
can be expected to take.
kind: date_iso8601
label: Start Date
name: start_date
- description: |
Used to throttle how often STATE messages are generated when the tap is using the “REST” API.
This is a balance between not slowing down execution due to too many STATE messages produced and how many records must be fetched again if a tap fails unexpectedly. Defaults to 1000 (generate a STATE message every 1000 records).
kind: integer
label: State Message Threshold
name: state_message_threshold
value: 1000
- description: The username (or email address) used to sign in to your Salesforce
account.
label: Username
name: username
placeholder: Ex. me@my-organization.com
settings_group_validation:
- - password
- security_token
- start_date
- username
- - client_id
- client_secret
- refresh_token
- start_date
variant: meltano