The tap-salesforce Singer tap pulls data from Salesforce that can then be sent to a destination using a Singer target.

Alternative variants #

Multiple variants of tap-salesforce are available. This document describes the meltano variant.

Alternative variants are:

Standalone usage #

Install the package using pip: 

pip install git+https://gitlab.com/meltano/tap-salesforce.git@v1.5.0

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific tap-salesforce instructions to learn more.

Capabilities #

Settings #

tap-salesforce requires the configuration of one of the following groups of settings:

The settings for tap tap-salesforce that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Username (username) #

The username (or email address) used to sign in to your Salesforce account.

Password (password) #

The password used to sign in to your Salesforce account.

Security Token (security_token) #

How to get #

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.

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

:::

Client ID (client_id) #

Salesforce client ID. See https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.html.

Client Secret (client_secret) #

Salesforce client secret. See https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.html.

Refresh Token (refresh_token) #

Salesforce refresh token. See https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_web_server_oauth_flow.html.

Start Date (start_date) #

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.

Is Sandbox (is_sandbox) #

  • Default: false

Use Salesforce Sandbox

API Type (api_type) #

  • Default: REST

Used to switch the behavior of the tap between using Salesforce’s “REST” and “BULK” APIs.

Select Fields By Default (select_fields_by_default) #

  • Default: true

Select by default any new fields discovered in Salesforce objects

State Message Threshold (state_message_threshold) #

  • Default: 1000

Used to throttle how often STATE messages are generated when the tap is using the “REST” API.

This is a balance between not slowing down execution due to too many STATE messages produced and how many records must be fetched again if a tap fails unexpectedly. Defaults to 1000 (generate a STATE message every 1000 records).

Maximum number of threads to use (max_workers) #

  • Default: 8

Maximum number of threads to use.

Looking for help? #

If you're having trouble getting the tap-salesforce tap to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!