-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates extractors tap-salesforce (SDK based - meltanolabs)
- Loading branch information
1 parent
368839c
commit 531de94
Showing
1 changed file
with
76 additions
and
93 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,23 @@ | ||
| capabilities: | ||
| - properties | ||
| - about | ||
| - batch | ||
| - catalog | ||
| - discover | ||
| - schema-flattening | ||
| - state | ||
| - stream-maps | ||
| 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 | ||
| domain_url: | ||
| https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_what_is_rest_api.htm | ||
| keywords: | ||
| - api | ||
| - meltano_sdk | ||
| label: Salesforce | ||
| logo_url: /assets/logos/extractors/salesforce.png | ||
| maintenance_status: active | ||
| name: tap-salesforce | ||
| namespace: tap_salesforce | ||
| pip_url: git+https://github.com/meltanolabs/tap-salesforce.git@v1.5.1 | ||
| pip_url: git+https://github.com/meltanolabs/tap-salesforce.git@sdk | ||
| quality: silver | ||
| repo: https://github.com/meltanolabs/tap-salesforce | ||
| select: | ||
|
|
@@ -22,105 +28,82 @@ select: | |
| - Account.* | ||
| - Opportunity.* | ||
| settings: | ||
| - description: The username (or email address) used to sign in to your Salesforce | ||
| account. | ||
| label: Username | ||
| name: username | ||
| placeholder: Ex. [email protected] | ||
| - description: The password used to sign in to your Salesforce account. | ||
| kind: password | ||
| label: Password | ||
| name: password | ||
| placeholder: Ex. ***************** | ||
| - 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 | ||
| - description: Auth type for Salesforce API requires either access_token or username/password | ||
| kind: string | ||
| label: Auth | ||
| name: auth | ||
| - description: Compression format to use for batch files. | ||
| kind: options | ||
| label: Batch Config Encoding Compression | ||
| name: batch_config.encoding.compression | ||
| options: | ||
| - label: Gzip | ||
| value: gzip | ||
| - label: None | ||
| value: none | ||
| - description: Format to use for batch files. | ||
| kind: options | ||
| label: Batch Config Encoding Format | ||
| name: batch_config.encoding.format | ||
| options: | ||
| - label: Jsonl | ||
| value: jsonl | ||
| - description: Prefix to use when writing batch files. | ||
| kind: string | ||
| label: Batch Config Storage Prefix | ||
| name: batch_config.storage.prefix | ||
| - description: Root path to use when writing batch files. | ||
| kind: string | ||
| label: Batch Config Storage Root | ||
| name: batch_config.storage.root | ||
| - description: Toggle for using BULK API method | ||
| kind: boolean | ||
| label: Bulk Load | ||
| name: bulk_load | ||
| value: false | ||
| - description: Client id, used for getting access token if access token is not available | ||
| kind: password | ||
| label: Security Token | ||
| name: security_token | ||
| placeholder: Ex. ***************** | ||
| - 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. | ||
| - description: Client secret, used for getting access token if access token is not | ||
| available | ||
| kind: password | ||
| label: Client Secret | ||
| name: client_secret | ||
| - 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 | ||
| - 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. | ||
| - description: Website domain for site url, ie. , https://{domain}.salesforce.com/services/data/ | ||
| kind: string | ||
| label: Domain | ||
| name: domain | ||
| - description: Latest record date to sync | ||
| kind: date_iso8601 | ||
| label: Start Date | ||
| name: start_date | ||
| - description: Use Salesforce Sandbox | ||
| kind: boolean | ||
| label: Is Sandbox | ||
| name: is_sandbox | ||
| value: false | ||
| - 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: Select by default any new fields discovered in Salesforce objects | ||
| label: End Date | ||
| name: end_date | ||
| - description: "'True' to enable schema flattening and automatically expand nested | ||
| properties." | ||
| kind: boolean | ||
| label: Select Fields By Default | ||
| name: select_fields_by_default | ||
| value: true | ||
| - 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). | ||
| label: Flattening Enabled | ||
| name: flattening_enabled | ||
| - description: The max depth to flatten schemas. | ||
| kind: integer | ||
| label: State Message Threshold | ||
| name: state_message_threshold | ||
| value: 1000 | ||
| - description: Maximum number of threads to use. | ||
| kind: integer | ||
| label: Maximum number of threads to use | ||
| name: max_workers | ||
| value: 8 | ||
| label: Flattening Max Depth | ||
| name: flattening_max_depth | ||
| - description: Earliest record date to sync | ||
| kind: date_iso8601 | ||
| label: Start Date | ||
| name: start_date | ||
| - description: User-defined config values to be used within map expressions. | ||
| kind: object | ||
| label: Stream Map Config | ||
| name: stream_map_config | ||
| - description: Config object for stream maps capability. For more information check | ||
| out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). | ||
| kind: object | ||
| label: Stream Maps | ||
| name: stream_maps | ||
| settings_group_validation: | ||
| - - username | ||
| - password | ||
| - security_token | ||
| - start_date | ||
| - - client_id | ||
| - - auth | ||
| - bulk_load | ||
| - client_id | ||
| - client_secret | ||
| - refresh_token | ||
| - start_date | ||
| - domain | ||
| variant: meltanolabs | ||