Docs: Updates Salesforce Source Connector Docs (Removes inapp page, adds <HideInUI>, adds Limitations & Troubleshooting) #32371
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,6 +1,10 @@ | ||
| # Salesforce | ||
|
|
||
| <HideInUI> | ||
|
|
||
| This page contains the setup guide and reference information for the [Salesforce](https://www.salesforce.com/) source connector. | ||
|
|
||
| </HideInUI> | ||
|
|
||
| ## Prerequisites | ||
|
|
||
|
|
@@ -43,7 +47,7 @@ To create a dedicated read only Salesforce user: | |
|
|
||
| <!-- env:oss --> | ||
|
|
||
| ### For Airbyte Open Source: Obtain Salesforce OAuth credentials | ||
|
|
||
| If you are using Airbyte Open Source, you will need to obtain the following OAuth credentials to authenticate: | ||
|
|
||
|
|
@@ -61,22 +65,42 @@ To obtain these credentials, follow [this walkthrough](https://medium.com/@bpmme | |
|
|
||
| ### Step 2: Set up the Salesforce connector in Airbyte | ||
|
|
||
| <!-- env:cloud --> | ||
|
|
||
| **For Airbyte Cloud:** | ||
|
|
||
| 1. [Log in to your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account. | ||
| 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New source**. | ||
| 3. Find and select **Salesforce** from the list of available sources. | ||
| 4. Enter a **Source name** of your choosing to help you identify this source. | ||
| 5. To authenticate: | ||
| **For Airbyte Cloud**: Click **Authenticate your account** to authorize your Salesforce account. Airbyte will authenticate the Salesforce account you are already logged in to. Please make sure you are logged into the right account. | ||
| 6. Toggle whether your Salesforce account is a [Sandbox account](https://help.salesforce.com/s/articleView?id=sf.deploy_sandboxes_parent.htm&type=5) or a production account. | ||
| 7. (Optional) For **Start Date**, use the provided datepicker or enter the date programmatically in either `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ` format. The data added on and after this date will be replicated. If this field is left blank, Airbyte will replicate the data for the last two years by default. Please note that timestamps are in [UTC](https://www.utctime.net/). | ||
| 8. (Optional) In the **Filter Salesforce Object** section, you may choose to target specific data for replication. To do so, click **Add**, then select the relevant criteria from the **Search criteria** dropdown. For **Search value**, add the search terms relevant to you. You may add multiple filters. If no filters are specified, Airbyte will replicate all data. | ||
| 9. Click **Set up source** and wait for the tests to complete. | ||
|
|
||
| <!-- /env:cloud --> | ||
|
|
||
| <!-- env:oss --> | ||
|
|
||
| **For Airbyte Open Source:** | ||
|
|
||
| 1. Navigate to your Airbyte Open Source dashboard. | ||
| 2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New source**. | ||
| 3. Find and select **Salesforce** from the list of available sources. | ||
| 4. Enter a **Source name** of your choosing to help you identify this source. | ||
| 5. To authenticate: | ||
| **For Airbyte Open Source**: Enter your Client ID, Client Secret, and Refresh Token. | ||
| 6. Toggle whether your Salesforce account is a [Sandbox account](https://help.salesforce.com/s/articleView?id=sf.deploy_sandboxes_parent.htm&type=5) or a production account. | ||
| 7. (Optional) For **Start Date**, use the provided datepicker or enter the date programmatically in either `YYYY-MM-DD` or `YYYY-MM-DDTHH:MM:SSZ` format. The data added on and after this date will be replicated. If this field is left blank, Airbyte will replicate the data for the last two years by default. Please note that timestamps are in [UTC](https://www.utctime.net/). | ||
| 8. (Optional) In the **Filter Salesforce Object** section, you may choose to target specific data for replication. To do so, click **Add**, then select the relevant criteria from the **Search criteria** dropdown. For **Search value**, add the search terms relevant to you. You may add multiple filters. If no filters are specified, Airbyte will replicate all data. | ||
| 9. Click **Set up source** and wait for the tests to complete. | ||
|
|
||
| <!-- /env:oss --> | ||
|
|
||
| <HideInUI> | ||
|
|
||
| ## Supported sync modes | ||
|
|
||
| The Salesforce source connector supports the following sync modes: | ||
|
|
@@ -86,14 +110,6 @@ The Salesforce source connector supports the following sync modes: | |
| - [Incremental Sync - Append](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append) | ||
| - (Recommended)[ Incremental Sync - Append + Deduped](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append-deduped) | ||
|
|
||
| ## Supported Objects | ||
|
|
||
| The Salesforce connector supports reading both Standard Objects and Custom Objects from Salesforce. Each object is read as a separate stream. See a list of all Salesforce Standard Objects [here](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_list.htm). | ||
|
|
@@ -103,12 +119,30 @@ Airbyte allows exporting all available Salesforce objects dynamically based on: | |
| - If the authenticated Salesforce user has the Role and Permissions to read and fetch objects | ||
| - If the salesforce object has the queryable property set to true. Airbyte can only fetch objects which are queryable. If you don’t see an object available via Airbyte, and it is queryable, check if it is API-accessible to the Salesforce user you authenticated with. | ||
|
|
||
|
|
||
| ## Limitations & Troubleshooting | ||
|
|
||
| <details> | ||
| <summary> | ||
| Expand to see details about Salesforce connector limitations and troubleshooting. | ||
| </summary> | ||
|
|
||
| ### Connector limitations | ||
|
|
||
| #### Rate limiting | ||
|
|
||
| The Salesforce connector is restricted by Salesforce’s [Daily Rate Limits](https://developer.salesforce.com/docs/atlas.en-us.salesforce_app_limits_cheatsheet.meta/salesforce_app_limits_cheatsheet/salesforce_app_limits_platform_api.htm). The connector syncs data until it hits the daily rate limit, then ends the sync early with success status, and starts the next sync from where it left off. Note that picking up from where it ends will work only for incremental sync, which is why we recommend using the [Incremental Sync - Append + Deduped](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append-deduped) sync mode. | ||
|
|
||
| #### Incremental deletes sync | ||
|
|
||
| The Salesforce connector supports retrieving deleted records from the Salesforce recycle bin. For the streams which support it, a deleted record will be marked with `isDeleted=true`. To find out more about how Salesforce manages records in the recycle bin, please visit their [docs](https://help.salesforce.com/s/articleView?id=sf.home_delete.htm&type=5). | ||
|
|
||
| #### A note on the BULK API vs REST API and their limitations | ||
|
|
||
| Salesforce allows extracting data using either the [BULK API](https://developer.salesforce.com/docs/atlas.en-us.236.0.api_asynch.meta/api_asynch/asynch_api_intro.htm) or [REST API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_what_is_rest_api.htm). To achieve fast performance, Salesforce recommends using the BULK API for extracting larger amounts of data (more than 2,000 records). For this reason, the Salesforce connector uses the BULK API by default to extract any Salesforce objects, unless any of the following conditions are met: | ||
|
|
||
| - The Salesforce object has columns which are unsupported by the BULK API, like columns with a `base64` or `complexvalue` type | ||
| - The Salesforce object is not supported by BULK API. In this case we sync the objects via the REST API which will occasionalyl cost more of your API quota. This list of objects was obtained experimentally, and includes the following objects: | ||
| - AcceptedEventRelation | ||
| - Attachment | ||
| - CaseStatus | ||
|
|
@@ -132,20 +166,28 @@ Salesforce allows extracting data using either the [BULK API](https://developer. | |
|
|
||
| More information on the differences between various Salesforce APIs can be found [here](https://help.salesforce.com/s/articleView?id=sf.integrate_what_is_api.htm&type=5). | ||
|
|
||
| :::note Force Using Bulk API | ||
|
There was a problem hiding this comment. this is rendering weirdly There was a problem hiding this comment.
@katmarkham Is this happening via Docusaurus or in the markdown preview in GitHub? These are Docusaurus admonitions so I don't think they'll render in GitHub markdown. This is what I see when running Docusaurus locally: 
|
||
|
|
||
| If you set the `Force Use Bulk API` option to `true`, the connector will ignore unsupported properties and sync Stream using BULK API. | ||
|
|
||
| ::: | ||
|
|
||
|
|
||
| ### Troubleshooting | ||
|
|
||
| #### Tutorials | ||
|
|
||
| Now that you have set up the Salesforce source connector, check out the following Salesforce tutorials: | ||
|
|
||
| - [Replicate Salesforce data to BigQuery](https://airbyte.com/tutorials/replicate-salesforce-data-to-bigquery) | ||
| - [Replicate Salesforce and Zendesk data to Keen for unified analytics](https://airbyte.com/tutorials/salesforce-zendesk-analytics) | ||
|
|
||
| <!-- Review common issues here: https://www.notion.so/512cf64f0ca54a1e9ea0034aaded84e8?v=77f3aa662f3641acaab5607c85966bb8 --> | ||
|
|
||
| * Check out common troubleshooting issues for the Salesforce source connector on our [Airbyte Forum](https://github.com/airbytehq/airbyte/discussions). | ||
|
|
||
| </details> | ||
|
|
||
| ## Changelog | ||
|
|
||
| | Version | Date | Pull Request | Subject | | ||
|
|
@@ -225,4 +267,6 @@ Now that you have set up the Salesforce source connector, check out the followin | |
| | 0.1.3 | 2021-11-06 | [7592](https://github.com/airbytehq/airbyte/pull/7592) | Fix getting `anyType` fields using BULK API | | ||
| | 0.1.2 | 2021-09-30 | [6438](https://github.com/airbytehq/airbyte/pull/6438) | Annotate Oauth2 flow initialization parameters in connector specification | | ||
| | 0.1.1 | 2021-09-21 | [6209](https://github.com/airbytehq/airbyte/pull/6209) | Fix bug with pagination for BULK API | | ||
| | 0.1.0 | 2021-09-08 | [5619](https://github.com/airbytehq/airbyte/pull/5619) | Salesforce Aitbyte-Native Connector | | ||
|
|
||
| </HideInUI> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
*occasionally
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the catch. Updated.