This page received its last significant update on 4/14/2020

Since then, there have been some significant changes to our strategy, direction, and focus, so statements and recommendations may be outdated and not all examples may work.

The most up to date information can be found on the homepage, as well as any pages that don't show this warning.

If you encounter any inaccuracies, we welcome you to help us improve this page or submit an issue.

Salesforce

The Salesforce extractor pulls raw data from Salesforce's REST API and extracts the following resources by default:

  • Users
  • Accounts
  • Leads
  • Opportunities
  • Contacts

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
  • Password
  • Security Token
  • Start Date

User Name

Configuration Notes

  • The user name used to sign in to your Salesforce account

Password

Configuration Notes

  • The password used to sign in to your Salesforce account

Security Token

Configuration Notes

  • 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:

  1. Sign in to your Salesforce Account.

  2. Go to your Account Settings (top right on the header bar)

  3. Click Reset My Security Token (Under the My Personal Information section)

  4. Click Reset Security Token

An email with the Security Token will be sent to your email.

Screenshot of Salesforce Security Token Reset

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.

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

Prerequisites

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.

Screenshot of Meltano UI with all extractors not installed and Salesforce Extractor highlighted

Let's install 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.

Screenshot of Salesforce Extractor Configuration

Advanced: Command Line Installation

  1. Navigate to your Meltano project in the terminal
  2. 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.

Configuration

  1. Open your project's .env file in a text editor
  2. 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"