Skip to content

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 between a username/password combination or an OAuth.


Use Sandbox = boolean

  • No: Connect to a live Salesforce account. This is the default setting.
  • Yes: Connect to a sandbox Salesforce account.

Authentication = drop-down

Opens a dialog to select an OAuth connection. Click Manage to navigate to the OAuth tab to review OAuth connections and to add new connections. Read OAuth to learn how to create an OAuth connection.


Username = string

Provide a valid Salesforce username. Only used when Authentication Method is set to User/Password.


Password = drop-down

The secret definition containing the password for your Salesforce account. Your password should be saved as a secret definition before using this component. Only used when Authentication Method is set to User/Password.


Security Token = drop-down

The secret definition holding your Salesforce security token. Your security token should be saved as a secret definition before using this component. Only used when Authentication Method is set to User/Password.


Authentication = drop-down

The secret definition holding your Salesforce OAuth credentials. Your OAuth credentials should be saved as a secret definition before using this component. Only used when Authentication Method is set to OAuth.


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 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], will use 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], will use 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

This is optional, and specifies 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 be Account.
  • Relationships: The relationship to the parent relationship column. For example, OwnerId is a relationship column in Account, but the relationship is named Owner.
  • Type: Relationship columns refer to specific target objects. For example, OwnerId in Account refers to User. However, polymorphic objects like OwnerId in Event can refer to Calendar or User, 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 the Email column in User.

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.

  1. Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
  2. Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
  3. Will additionally log the body of the request and the response.
  4. Will additionally log transport-level communication with the data source. This includes SSL negotiation.
  5. 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 (preview)