Skip to content

Latest commit

 

History

History
236 lines (189 loc) · 27.4 KB

salesforce.md

File metadata and controls

236 lines (189 loc) · 27.4 KB
Raw

Salesforce

This page contains the setup guide and reference information for the Salesforce source connector.

Prerequisites

  • Salesforce Account with Enterprise access or API quota purchased
  • (Optional, Recommended) Dedicated Salesforce user
  • (For Airbyte Open Source) Salesforce OAuth credentials

:::tip

To use this connector, you'll need at least the Enterprise edition of Salesforce or the Professional Edition with API access purchased as an add-on. Reference the Salesforce docs about API access for more information.

:::

Setup guide

Step 1: (Optional, Recommended) Create a read-only Salesforce user

While you can set up the Salesforce connector using any Salesforce user with read permission, we recommend creating a dedicated read-only user for Airbyte. This allows you to granularly control the data Airbyte can read.

To create a dedicated read only Salesforce user:

  1. Log in to Salesforce with an admin account.
  2. On the top right of the screen, click the gear icon and then click Setup.
  3. In the left navigation bar, under Administration, click Users > Profiles. The Profiles page is displayed. Click New profile.
  4. For Existing Profile, select Read only. For Profile Name, enter Airbyte Read Only User.
  5. Click Save. The Profiles page is displayed. Click Edit.
  6. Scroll down to the Standard Object Permissions and Custom Object Permissions and enable the Read checkbox for objects that you want to replicate via Airbyte.
  7. Scroll to the top and click Save.
  8. On the left side, under Administration, click Users > Users. The All Users page is displayed. Click New User.
  9. Fill out the required fields:
    1. For License, select Salesforce.
    2. For Profile, select Airbyte Read Only User.
    3. For Email, make sure to use an email address that you can access.
  10. Click Save.
  11. Copy the Username and keep it accessible.
  12. Log into the email you used above and verify your new Salesforce account user. You'll need to set a password as part of this process. Keep this password accessible.

For Airbyte Open Source only: Obtain Salesforce OAuth credentials

If you are using Airbyte Open Source, you will need to obtain the following OAuth credentials to authenticate:

  • Client ID
  • Client Secret
  • Refresh Token

To obtain these credentials, follow this walkthrough with the following modifications:

  1. If your Salesforce URL is not in the X.salesforce.com format, use your Salesforce domain name. For example, if your Salesforce URL is awesomecompany.force.com then use that instead of awesomecompany.salesforce.com.
  2. When running a curl command, run it with the -L option to follow any redirects.
  3. If you created a read-only user, use the user credentials when logging in to generate OAuth tokens.

Step 2: Set up the Salesforce connector in Airbyte

  1. Log in to your Airbyte Cloud account, or 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 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. For Airbyte Open Source: Enter your Client ID, Client Secret, and Refresh Token.
  6. Toggle whether your Salesforce account is a Sandbox account 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.
  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.

Supported sync modes

The Salesforce source connector supports the following sync modes:

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.

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.

Syncing Formula Fields

The Salesforce connector syncs formula field outputs from Salesforce. If the formula of a field changes in Salesforce and no other field on the record is updated, you will need to reset the stream and sync a historical backfill to pull in all the updated values of the field.

Syncing Deletes

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.

Performance considerations

The Salesforce connector is restricted by Salesforce’s Daily Rate Limits. 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 sync mode.

Usage of the BULK API vs REST API

Salesforce allows extracting data using either the BULK API or REST API. 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 occasionally cost more of your API quota. This includes the following objects:
    • AcceptedEventRelation
    • Attachment
    • CaseStatus
    • ContractStatus
    • DeclinedEventRelation
    • FieldSecurityClassification
    • KnowledgeArticle
    • KnowledgeArticleVersion
    • KnowledgeArticleVersionHistory
    • KnowledgeArticleViewStat
    • KnowledgeArticleVoteStat
    • OrderStatus
    • PartnerRole
    • RecentlyViewed
    • ServiceAppointmentStatus
    • ShiftStatus
    • SolutionStatus
    • TaskPriority
    • TaskStatus
    • UndecidedEventRelation

More information on the differences between various Salesforce APIs can be found here.

:::info Force Using Bulk API If you set the Force Use Bulk API option to true, the connector will ignore unsupported properties and sync Stream using BULK API. :::

Tutorials

Now that you have set up the Salesforce source connector, check out the following Salesforce tutorials:

Changelog

Version Date Pull Request Subject
2.3.0 2023-12-15 33522 Sync streams concurrently in all sync modes
2.2.1 2023-12-12 33342 Added new ContentDocumentLink stream
2.2.0 2023-12-12 33350 Sync streams concurrently on full refresh
2.1.6 2023-11-28 32535 Run full refresh syncs concurrently
2.1.5 2023-10-18 31543 Base image migration: remove Dockerfile and use the python-connector-base image
2.1.4 2023-08-17 29538 Fix encoding guess
2.1.3 2023-08-17 29500 handle expired refresh token error
2.1.2 2023-08-10 28781 Fix pagination for BULK API jobs; Add option to force use BULK API
2.1.1 2023-07-06 28021 Several Vulnerabilities Fixes; switched to use alpine instead of slim, CVE-2022-40897, CVE-2023-29383, CVE-2023-31484, CVE-2016-2781
2.1.0 2023-06-26 27726 License Update: Elv2
2.0.14 2023-05-04 25794 Avoid pandas inferring wrong data types by forcing all data type as object
2.0.13 2023-04-30 25700 Remove pagination and query limits
2.0.12 2023-04-25 25507 Update API version to 57
2.0.11 2023-04-20 25352 Update API version to 53
2.0.10 2023-04-05 24888 Add more frequent checkpointing
2.0.9 2023-03-29 24660 Set default start_date. Sync for last two years if start date is not present in config
2.0.8 2023-03-30 24690 Handle rate limit for bulk operations
2.0.7 2023-03-14 24071 Remove regex pattern for start_date, use format validation instead
2.0.6 2023-03-03 22891 Specified date formatting in specification
2.0.5 2023-03-01 23610 Handle different Salesforce page size for different queries
2.0.4 2023-02-24 22636 Turn on default HttpAvailabilityStrategy for all streams that are not of class BulkSalesforceStream
2.0.3 2023-02-17 23190 In case properties are chunked, fetch primary key in every chunk
2.0.2 2023-02-13 22896 Count the URL length based on encoded params
2.0.1 2023-02-08 22597 Make multiple requests if a REST stream has too many properties
2.0.0 2023-02-02 22322 Remove ActivityMetricRollup stream
1.0.30 2023-01-27 22016 Set AvailabilityStrategy for streams explicitly to None
1.0.29 2023-01-05 20886 Remove ActivityMetric stream
1.0.28 2022-12-29 20927 Fix tests; add expected records
1.0.27 2022-11-29 19869 Remove AccountHistory from unsupported BULK streams
1.0.26 2022-11-15 19286 Bugfix: fallback to REST API if entity is not supported by BULK API
1.0.25 2022-11-13 19294 Use the correct encoding for non UTF-8 objects and data
1.0.24 2022-11-01 18799 Update list of unsupported Bulk API objects
1.0.23 2022-11-01 18753 Add error_display_message for ConnectionError
1.0.22 2022-10-12 17615 Make paging work, if cursor_field is not changed inside one page
1.0.21 2022-10-10 17778 Add EventWhoRelation to the list of unsupported Bulk API objects.
1.0.20 2022-09-30 17453 Check objects that are not supported by the Bulk API (v52.0)
1.0.19 2022-09-29 17314 Fixed bug with decoding response
1.0.18 2022-09-28 17304 Migrate to per-stream states.
1.0.17 2022-09-23 17094 Tune connection check: fetch a list of available streams
1.0.16 2022-09-21 17001 Improve writing file of decode
1.0.15 2022-08-30 16086 Improve API type detection
1.0.14 2022-08-29 16119 Exclude KnowledgeArticleVersion from using bulk API
1.0.13 2022-08-23 15901 Exclude KnowledgeArticle from using bulk API
1.0.12 2022-08-09 15444 Fixed bug when Bulk Job was timeout by the connector, but remained running on the server
1.0.11 2022-07-07 13729 Improve configuration field descriptions
1.0.10 2022-06-09 13658 Correct logic to sync stream larger than page size
1.0.9 2022-05-06 12685 Update CDK to v0.1.56 to emit an AirbyeTraceMessage on uncaught exceptions
1.0.8 2022-05-04 12576 Decode responses as utf-8 and fallback to ISO-8859-1 if needed
1.0.7 2022-05-03 12552 Decode responses as ISO-8859-1 instead of utf-8
1.0.6 2022-04-27 12335 Adding fixtures to mock time.sleep for connectors that explicitly sleep
1.0.5 2022-04-25 12304 Add Describe stream
1.0.4 2022-04-20 12230 Update connector to use a spec.yaml
1.0.3 2022-04-04 11692 Optimised memory usage for BULK API calls
1.0.2 2022-03-01 10751 Fix broken link anchor in connector configuration
1.0.1 2022-02-27 10679 Reorganize input parameter order on the UI
1.0.0 2022-02-27 10516 Speed up schema discovery by using parallelism
0.1.23 2022-02-10 10141 Processing of failed jobs
0.1.22 2022-02-02 10012 Increase CSV field_size_limit
0.1.21 2022-01-28 9499 If a sync reaches daily rate limit it ends the sync early with success status. Read more in Performance considerations section
0.1.20 2022-01-26 9757 Parse CSV with "unix" dialect
0.1.19 2022-01-25 8617 Update connector fields title/description
0.1.18 2022-01-20 9478 Add available stream filtering by queryable flag
0.1.17 2022-01-19 9302 Deprecate API Type parameter
0.1.16 2022-01-18 9151 Fix pagination in REST API streams
0.1.15 2022-01-11 9409 Correcting the presence of an extra else handler in the error handling
0.1.14 2022-01-11 9386 Handling 400 error, while sobject doesn't support query or queryAll requests
0.1.13 2022-01-11 8797 Switched from authSpecification to advanced_auth in specefication
0.1.12 2021-12-23 8871 Fix examples for new field in specification
0.1.11 2021-12-23 8871 Add the ability to filter streams by user
0.1.10 2021-12-23 9005 Handling 400 error when a stream is not queryable
0.1.9 2021-12-07 8405 Filter 'null' byte(s) in HTTP responses
0.1.8 2021-11-30 8191 Make start_date optional and change its format to YYYY-MM-DD
0.1.7 2021-11-24 8206 Handling 400 error when trying to create a job for sync using Bulk API.
0.1.6 2021-11-16 8009 Fix retring of BULK jobs
0.1.5 2021-11-15 7885 Add Transform for output records
0.1.4 2021-11-09 7778 Fix types for anyType fields
0.1.3 2021-11-06 7592 Fix getting anyType fields using BULK API
0.1.2 2021-09-30 6438 Annotate Oauth2 flow initialization parameters in connector specification
0.1.1 2021-09-21 6209 Fix bug with pagination for BULK API
0.1.0 2021-09-08 5619 Salesforce Aitbyte-Native Connector