Salesforce
Salesforce is a cloud-based CRM platform.
We pull all the underlying data from Salesforce (SFDC) into a SQL-enabled environment to allow you to get a more in-depth analysis of your CRM data.
Features
Feature Name | Supported | Notes |
---|---|---|
Capture deletes | check | ORGANIZATION table |
History mode | check | |
Custom data | check | |
Data blocking | check | |
Column hashing | check | |
Re-sync | check | |
API configurable | check | API configuration |
Priority-first sync | ||
Fivetran data models | check | |
Private networking | check | |
Authorization via API | check |
Supported products
Product Name | Notes |
---|---|
Sales Cloud | |
Financial Services Cloud | |
Service Cloud | Including Salesforce Knowledge |
Marketing Cloud | Using our Marketing Cloud Connector |
Engagement | Using our Heroku PostgreSQL or Heroku Kafka connectors |
Industries | Industry-specific like finance and healthcare |
Communities | |
Trailhead |
Supported environments
Our two Salesforce connectors, Salesforce and Salesforce Sandbox, support the following environments:
CONNECTOR NAME | ENVIRONMENT |
---|---|
Salesforce | Production |
Salesforce Sandbox | Sandbox |
Setup guide
Follow our step-by-step Salesforce setup guide to connect Salesforce with your destination using Fivetran connectors.
Sync overview
Formula fields
Salesforce objects often include automatically populated fields called formula fields. Their values are derived from formulas created by your Salesforce administrators. Due to Salesforce limitations, these fields cannot be synced incrementally with reliable integrity. To avoid data integrity issues, Fivetran automatically detects formula fields and excludes them from the tables synced to your destination.
However, if you want to sync your formula fields, Fivetran recommends that you use a transformation-based approach to sync them. For more information, see our Formula Fields documentation.
Global variables
We support the fields that reference the following Global Variables:
$Api
$CustomMetadata
$Label
$Organization
$Permission
$Profile
$RecordType
$Setup
$System.OriginDateTime
$User
$UserRole
The following global variables rely on specific tables. You must select the relevant tables on the Schema tab of your connector details page.
GLOBAL VARIABLE | DEPENDENT TABLES |
---|---|
$CustomMetadata | Referred custom metadata table |
$Label | EXTERNAL_STRING and EXTERNAL_STRING_LOCALIZATION |
$Organization | ORGANIZATION |
$Permission | CUSTOM_PERMISSION , ORGANIZATION , PERMISSION_SET_ASSIGNMENT , and SETUP_ENTITY_ACCESS |
$Profile | PROFILE and USER |
$RecordType | RECORD_TYPE |
$Setup | Referred custom setting table, USER |
$User | USER |
$UserRole | USER and USER_ROLE |
The following are user-dependent global variables. We generate their translations dynamically based on the connecting user's details.
$Label
$Permission
$Profile
$Setup
$User
$UserRole
API usage
The number of API calls that we use varies from company to company. Our Salesforce connector is optimized to use the fewest API calls possible. In practice, customers find that Fivetran is not a significant API consumer.
REST and Bulk API usage
We use both the Salesforce REST API and the Bulk API to sync your Salesforce data. The Bulk API works better with high-volume data. We choose between the Bulk and REST APIs depending on the volume of data we need to sync for a table. For historical syncs or high-volume incremental syncs, we use the Bulk API; otherwise, the REST API.
Bulk API quota
Each Salesforce account has a rolling 24-hour Bulk API quota. If 90% of the bulk jobs quota has been consumed, to continue the sync we fall back to the REST API.
REST API quota
Each Salesforce account has a rolling 24-hour REST API quota. We automatically postpone by one hour whenever 90% of the Salesforce API call quota has been consumed. This ensures there is always API quota available for other business-critical applications.
Monitoring the API usage
The system table FIVETRAN_API_CALL tracks information about API calls made to sync data into the destination.
Delete capture limitation
History objects
We don't capture deletes of the field tracking history objects because we don't have dedicated endpoints to fetch deleted records for each object. To capture deletes for a specific history object, we can't use the getDeleted()
because the call returns all the records deleted during the specified date range for all the history objects.
Re-sync scenarios
Deleted records are retained in the Recycle Bin for 15 days. After 15 days, deleted items are purged from the Recycle Bin, and we can't use the getDeleted()
to fetch them.
We show a re-sync table warning to capture deletes if:
- We are unable to capture deleted records of a specific table for more than 15 days.
- We receive exceptions like
TooMuchDataException
when fetching deleted records.
(Optional) AWS PrivateLink
IMPORTANT: You must have a Business Critical plan to use AWS PrivateLink.
If you select PrivateLink as a connection method, Fivetran uses AWS PrivateLink to move your data securely between Salesforce and your destination. You must have a Salesforce Private Connect license to use AWS PrivateLink.
To set up AWS PrivateLink for your Salesforce source, follow the instructions in the Salesforce setup guide.
Incremental syncs
We sync most tables using incremental syncs. To run incremental syncs, Fivetran requires reliable timestamp fields. Timestamp fields allow us to detect which rows have changed since the last sync and sync only new or modified data. In Salesforce, we use one of the following timestamp fields to track when data was last updated in the source:
SystemModStamp
LastModifiedDate
CreatedDate
LoginTime
If none of these fields are available in a table, then we re-import the table.
NOTE: Salesforce does not update the incremental column
SystemModstamp/LastModified
for objects when there is an update in derived fields. Salesforce derived field values are never actually stored nor modified. As a result, your incremental syncs will not include updated data from these fields. To learn more about derived fields, see Salesforce's documentation.
Re-import tables
We re-import tables for the relevant Salesforce objects that have the replicateable property set to FALSE
.
We also re-import the AccountTeamMember
and OpportunityTeamMember
tables because Salesforce does not update the SystemModstamp
column for these tables if you change their access settings by modifying the organization-wide sharing defaults.
The re-import frequency depends on the time it takes for a table to re-sync.
Table Import Duration | Import frequency |
---|---|
3 seconds or less | every sync |
between 3 seconds and 5 minutes | once a day if the sync frequency is 24 hours; otherwise, twice a day |
more than 5 minutes | once a week on Saturday |
Schema information
Fivetran follows a one-to-one mapping with all objects in Salesforce. If you can't find something that you're looking for, your Salesforce user may have limited access to the information. Fivetran tries to sync all possible objects, except for formula fields, which must be replicated using transformations to ensure integrity.
Schema
This schema diagram illustrates how objects relate to one another. It is not a complete Entity Relationship Diagram. It shows relationships for some central entities and workflows. Many standard and all custom entities that are delivered by the Fivetran Salesforce connector are omitted for brevity.
To zoom, open the ERD in a new window.We also offer you information about the connector in the fivetran_query
table.
System tables
FIVETRAN_API_CALL
The FIVETRAN_API_CALL
table tracks the information about all the API calls Fivetran makes to sync data into the destination.
COLUMN |
---|
start 🔑 |
method |
uri |
update_id |
FIVETRAN_DEPENDENT_PICKLIST_RELATION
The FIVETRAN_DEPENDENT_PICKLIST_RELATION
table stores the dependent picklist relations.
COLUMN |
---|
dependent_picklist_value_index 🔑 |
parent_picklist_value_index 🔑 |
FIVETRAN_FORMULA
The FIVETRAN_FORMULA
table stores the formulas defined in Salesforce, which we use to translate formula fields.
COLUMN |
---|
field 🔑 |
object 🔑 |
formula |
FIVETRAN_FORMULA_FAILURE_REASON
The FIVETRAN_FORMULA_FAILURE_REASON
table stores the information about why Fivetran couldn't translate a particular formula field.
COLUMN |
---|
_fivetran_id 🔑 |
object |
field |
failure_reason |
failure_detail_1 |
failure_detail_2 |
FIVETRAN_FORMULA_MODEL
The FIVETRAN_FORMULA_MODEL
table stores SQL view models for the objects with translated formula fields.
COLUMN |
---|
object 🔑 |
model |
FIVETRAN_PICKLIST_FIELD
The FIVETRAN_PICKLIST_FIELD
table stores information about all the picklist fields.
COLUMN |
---|
index 🔑 |
entity_name |
field_name |
FIVETRAN_PICKLIST_FIELD_VALUE
The FIVETRAN_PICKLIST_FIELD_VALUE
table stores possible values for the picklist fields.
COLUMN |
---|
index 🔑 |
picklist_field_index |
value |
label |
FIVETRAN_QUERY
The FIVETRAN_QUERY
table records the details for every Salesforce Object Query Language (SOQL) query Fivetran makes.
COLUMN |
---|
id 🔑 |
done |
modified_field |
modified_since_inclusive |
merge_mode |
query |
rows_updated_or_inserted |
source_object |
source_api |
start |
Unsupported data types and object types
Our Salesforce connector does not support the following data types and object types:
- base64 type
- complexvalue type
- Deprecated and hidden objects
- Objects that don't support
LIMIT
- BigObject, or objects whose names end with
__b
- Non-queryable objects
- Objects that can't be accessed using Salesforce Object Query Language (SOQL) queries or Salesforce APIs
- Object whose names end with
__x
or__hd
- The
AccountUserTerritory2View
object due to sync performance issues
Compound fields
Although Fivetran does not sync compound fields as is, we sync all fields of a compound field in a Salesforce object as the corresponding individual fields in their respective tables corresponding to the object. For example, the Address compound field may appear as BillingAddress
in the User
object in Salesforce. In that case, the subfields of the Address compound field are synced to the USER
table in your destination as individual columns that have the billing_
prefix (for example, billing_latitude
, billing_postal_code
, etc.). You can reconstruct the compound field downstream using these individual fields.
Type conversion
We convert empty strings (""
) to null
objects.
Syncing empty tables and columns
Fivetran can sync empty tables and columns for your Salesforce connector. For more information, see our Features documentation.