This page received its last significant update on 4/14/2020
The Salesforce extractor pulls raw data from Salesforce's REST API and extracts the following resources by default:
For more information you can check the documentation for tap-salesforce.
# Salesforce Setup
In order to access your Salesforce data, you will need:
- User Name
- Security Token
- Start Date
- The user name used to sign in to your Salesforce account
- The password used to sign in to your Salesforce account
# Security Token
- Access to Salesforce's API requires a security token that will authenticate you with the server
If you don't already have a Salesforce Security Token for your account, you can generate one through the following steps:
Sign in to your Salesforce Account.
Go to your Account Settings (top right on the header bar)
Reset My Security Token(Under the
My Personal Informationsection)
Reset Security Token
An email with the Security Token will be sent to your email.
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).
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.
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.
# Start Date
This property 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.
# Meltano Setup
# Configure the Extractor
Open your Meltano instance and click "Pipelines" in the top navigation bar. You should now see the Extractors page, which contains various options for connecting your data sources.
tap-salesforce by clicking on the
Install button inside its card.
On the configuration modal we want to enter your username and password, the Security Token Salesforce extractor will use to connect to Salesforce, and the Start Date we want the extracted data set to start from.
# Advanced: Command Line Installation
- Navigate to your Meltano project in the terminal
- Run the following command:
meltano add extractor tap-salesforce
If you are successful, you should see
Added and installed extractors 'tap-salesforce' in your terminal.
- Open your project's
.envfile in a text editor
- Add the following variables to your file:
export TAP_SALESFORCE_USERNAME="Your Salesforce Username" export TAP_SALESFORCE_PASSWORD="Your Salesforce Password" export TAP_SALESFORCE_SECURITY_TOKEN="Your Salesforce Security Token" export TAP_SALESFORCE_START_DATE="2018-01-01T00:00:00Z"