Salesforce Output
The Salesforce Output component uses the Salesforce API to write back the contents of a source table (or view) into a table in Salesforce.
Properties
Name
= string
A human-readable name for the component.
Authentication Method
= drop-down
Select the authentication method. Choose OAuth to use an OAuth connection, or User/Password to use a username and password.
Authentication
= drop-down
(OAuth only)
Choose your profile from the drop-down menu.
Click Manage to navigate to the OAuth connections list to review OAuth connections and to add new connections. Read OAuth to learn how to create an OAuth connection.
Use Sandbox
= boolean
(User/Password only)
- No: Connect to a live Salesforce account. This is the default setting.
- Yes: Connect to a sandbox Salesforce account.
Username
= string
(User/password only)
Provide a valid Salesforce username.
Password
= drop-down
(User/Password only)
Select the secret definition that represents the password for your Salesforce account.
Choose the secret definition that represents your credentials for this connector.
If you have not already saved your credentials for this connector as a secret definition, click Add secret to create a secret definition representing these credentials. Read Secrets and secret definitions for details about creating a secret definition.
Security Token
= drop-down
(User/Password only)
Select the secret definition that represents your Salesforce OAuth credentials.
Choose the secret definition that represents your credentials for this connector.
If you have not already saved your credentials for this connector as a secret definition, click Add secret to create a secret definition representing these credentials. Read Secrets and secret definitions for details about creating a secret definition.
Use Bulk API
= drop-down
- No: Write up to 200 rows in real-time. This is the default setting.
- Yes: Write up to 10,000 rows asynchronously in the background. This can't be cancelled before completion.
Connection Options
= column editor
- Parameter: A JDBC parameter supported by the database driver. The available parameters are explained in the connection options section of the data model. Manual setup is not usually required, since sensible defaults are assumed.
- Value: A value for the given parameter.
Database
= drop-down
The Snowflake database. The special value [Environment Default]
uses the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.
Schema
= drop-down
The Snowflake schema. The special value [Environment Default]
uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
Source Table
= drop-down
Select the source table from which data will be unloaded (output). The tables available in the dropdown selection depend on the source schema.
Target Object
= drop-down
Select the Salesforce object (table) into which local data will be loaded (input).
Output Operation
= drop-down
Select the output operation to be performed into the target object. Available operations include Delete, Insert, Update, and Upsert.
Column Mappings
= column editor
Specify the columns in the source table that will be unloaded (output).
On Warnings
= drop-down
- Continue: Continue with the load if an error is raised.
- Fail: Fail the run if an error is raised.
Batch Size
= integer (optional)
Specify the number of rows to load to the target between each commit. On a very large export, this may be desirable to keep the size of the log files from growing very large before the data is committed.
Relationship Columns
= column editor
Click + to add a relationship column. For each column, enter the following:
- Parent Object: Drop-down list of available parent target objects. For example, if the "child" is
User
, the "parent" could beAccount
. - Relationships: The relationship to the parent relationship column. For example,
OwnerId
is a relationship column inAccount
, but the relationship is namedOwner
. - Type: Relationship columns refer to specific target objects. For example,
OwnerId
inAccount
refers toUser
. However, polymorphic objects likeOwnerId
inEvent
can refer toCalendar
orUser
, but only one may be used. - Index Column: The name of the column that uniquely identifies the parent target object. The
User
of the parent target object is identified by theEmail
column in User.
Surrogate Key
= drop-down (optional)
This field only appears if Use Bulk API
is set to Yes and Capture Batch Results
is set to On.
Select a column from the source table. The values from this column will appear in the batch results table in a column named surrogate_key
. The selected columns must not contain all null values, because this will cause the creation of the batch results table to fail.
Auto Debug
= drop-down
Choose whether to automatically log debug information about your load. These logs can be found in the task history and should be included in support requests concerning the component. Turning this on will override any debugging connection options.
Debug Level
= drop-down
The level of verbosity with which your debug information is logged. Levels above 1 can log huge amounts of data and result in slower execution. On used when Auto Debug is On.
- Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
- Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
- Will additionally log the body of the request and the response.
- Will additionally log transport-level communication with the data source. This includes SSL negotiation.
- Will additionally log communication with the data source, as well as additional details that may be helpful in troubleshooting problems. This includes interface commands.
Snowflake | Databricks | Amazon Redshift |
---|---|---|
✅ | ❌ | ❌ |