The target-salesforce loader sends data into Salesforce after it was pulled from a source using an extractor
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the target-salesforce loader to your
project using
:meltano add -
Configure the target-salesforce
settings using
:meltano config
meltano add loader target-salesforcemeltano config target-salesforce set --interactiveNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
target-salesforce
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this loader. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this loader.
This plugin has the following capabilities:
- about
- schema-flattening
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
target-salesforce settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
actionallow_failuresclient_idclient_secretdomainis_sandboxpasswordrefresh_tokensecurity_tokenusername
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config target-salesforce list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Action (action)
-
Environment variable:
TARGET_SALESFORCE_ACTION -
Default Value:
update
How to handle incomming records by default (insert/update/upsert/delete/hard_delete)
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set action [value]Allow Failures (allow_failures)
-
Environment variable:
TARGET_SALESFORCE_ALLOW_FAILURES -
Default Value:
false
Allows the target to continue persisting if a record fails to commit
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set allow_failures [value]Client ID (client_id)
-
Environment variable:
TARGET_SALESFORCE_CLIENT_ID
OAuth client_id
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set client_id [value]Client Secret (client_secret)
-
Environment variable:
TARGET_SALESFORCE_CLIENT_SECRET
OAuth client_secret
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set client_secret [value]Domain (domain)
-
Environment variable:
TARGET_SALESFORCE_DOMAIN -
Default Value:
login
Your Salesforce instance domain. Use 'login' (default) or 'test' (sandbox), or Salesforce My domain.
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set domain [value]Is Sandbox (is_sandbox)
-
Environment variable:
TARGET_SALESFORCE_IS_SANDBOX
DEPRECATED: Use domain. Is_sandbox-false = 'login', is_sandbox-True = 'test'
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set is_sandbox [value]Password (password)
-
Environment variable:
TARGET_SALESFORCE_PASSWORD
User/password username
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set password [value]Refresh Token (refresh_token)
-
Environment variable:
TARGET_SALESFORCE_REFRESH_TOKEN
OAuth refresh_token
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set refresh_token [value]Security Token (security_token)
-
Environment variable:
TARGET_SALESFORCE_SECURITY_TOKEN
User/password generated security token. Reset under your Account Settings
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set security_token [value]Username (username)
-
Environment variable:
TARGET_SALESFORCE_USERNAME
User/password username
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set username [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TARGET_SALESFORCE_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TARGET_SALESFORCE_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TARGET_SALESFORCE_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TARGET_SALESFORCE_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config target-salesforce set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-3-c0c0c4){kind=icon}
-2-c0c0c4){kind=icon}
