Salesforce Output Component

Salesforce Output Component



Salesforce Output

The Salesforce Output connector uses the Salesforce API to write back the contents of a source table (or view) into a table in Salesforce.

Important Information

  • There are certain special pseudo columns that can be part of a query filter, but are not returned as data. This is fully described in the Salesforce Data Model.
  • Warning: this component is potentially destructive. The output operations performed by this connector can delete, overwrite, and truncate Targets Objects within Salesforce, and these operations may be irreversible.


Redshift Properties

Property Setting Description
Name String A descriptive name for the component.
Authentication Method Select Select the method of authenticating the Salesforce Output connector (current options include User/Password and OAuth).
Authentication Select Select an OAuth entry for authentication. OAuth entries must be configured in advance, see Salesforce Output Authentication Guide for details. This property is only available when OAuth is selected as the Authentication Method.
Use Sandbox Select No: connect to a live account. This is the default setting.
Yes: connect to a sandbox account.
Username String Provide a valid Salesforce username (only available when User/Password is selected as the Authentication Method).
Password String Provide a valid Salesforce password. Users have the option to store passwords in the component; however, use of the Password Manager feature is recommended (only available when User/Password is selected as the Authentication Method).
Security Token String Provide a Salesforce security token, generated on the Salesforce website (only available when User/Password is selected as the Authentication Method).
Use Bulk API Select 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 cannot be cancelled before completion).
Connection Options Parameter A JDBC parameter supported by the Database Driver—manual setup is not usually required, since sensible defaults are assumed (available parameters are explained in the Data Model).
Value A value for the given Parameter.
Source Schema Select The source of the local data to be output to Salesforce ([Environment Default] is set as default and uses the schema defined in the environment).
Source Table Select The table (or view) on the Source Schema from which data will be output.
Target Object Select The Salesforce Object (table) into which local data will be input.
Output Operation Select Select whether to Insert, Upsert, Update, or Delete data into the Target Object.
Salesforce ID Select Select the unique ID of the row within the Target Object into which the local data will be written (only available when Upsert, Update, or Delete is selected as the Output Operation).
Column Mappings Source Columns Specify the columns in the Source Table that will be output.
Target Columns Specify columns in the Target Object where the Source Columns will be output.
Auto Debug Select On: Select this option to automatically log debug information about the load (these logs can be found in the Task History and should be included in support requests concerning the component).
Off to override any debugging Connection Options.
Debug Level Select Select the desired level of detail of debug information logged (Beyond 1, huge amounts of data may be logged, resulting in slower execution):
1: Log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Also log cache queries and additional information about the request, if applicable.
3: Also log the body of the request and the response.
4: Also log transport-level communication with the data source. This includes SSL negotiation.
5: Also log communication with the data source and additional details helpful in troubleshooting problems (this includes interface commands).

Snowflake Properties

Property Setting Description
Name String A descriptive name for the component.
Authentication Method Select Select the method of authenticating the Salesforce Output connector (current options include User/Password and OAuth).
Authentication Select Select an OAuth entry for authentication. OAuth entries must be configured in advance, see Salesforce Output Authentication Guide for details. This property is only available when OAuth is selected as the Authentication Method.
Use Sandbox Select No: connect to a live account. This is the default setting.
Yes: connect to a sandbox account.
Username String Provide a valid Salesforce username (only available when User/Password is selected as the Authentication Method).
Password String Provide a valid Salesforce password. Users have the option to store passwords in the component; however, use of the Password Manager feature is recommended (only available when User/Password is selected as the Authentication Method).
Security Token String Provide a Salesforce security token, generated on the Salesforce website (only available when User/Password is selected as the Authentication Method).
Use Bulk API Select 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 cannot be cancelled before completion).
Connection Options Parameter A JDBC parameter supported by the Database Driver—manual setup is not usually required, since sensible defaults are assumed (available parameters are explained in the Data Model).
Value A value for the given Parameter.
Database Select A database in which the the local data can be found.
Schema Select The source of the local data to be output to Salesforce ([Environment Default] is set as default and uses the schema defined in the environment).
Target Table Select The table (or view) on the Schema from which data will be output.
Target Object Select The Salesforce Object (table) into which local data will be input.
Output Operation Select Select whether to Insert, Upsert, Update, or Delete data into the Target Object.
Salesforce ID Select Select the unique ID of the row within the Target Object into which the local data will be written (only available when Upsert, Update, or Delete is selected as the Output Operation).
Column Mappings Source Columns Specify the columns in the Source Table that will be output.
Target Columns Specify columns in the Target Object where the Source Columns will be output.
Auto Debug Select On: Select this option to automatically log debug information about the load (these logs can be found in the Task History and should be included in support requests concerning the component).
Off to override any debugging Connection Options.
Debug Level Select Select the desired level of detail of debug information logged (Beyond 1, huge amounts of data may be logged, resulting in slower execution):
1: Log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Also log cache queries and additional information about the request, if applicable.
3: Also log the body of the request and the response.
4: Also log transport-level communication with the data source. This includes SSL negotiation.
5: Also log communication with the data source and additional details helpful in troubleshooting problems (this includes interface commands).

BigQuery Properties

Property Setting Description
Name String A descriptive name for the component.
Authentication Method Select Select the method of authenticating the Salesforce Output connector (current options include User/Password and OAuth).
Authentication Select Select an OAuth entry for authentication. OAuth entries must be configured in advance, see Salesforce Output Authentication Guide for details. This property is only available when OAuth is selected as the Authentication Method.
Use Sandbox Select No: connect to a live account. This is the default setting.
Yes: connect to a sandbox account.
Username String Provide a valid Salesforce username (only available when User/Password is selected as the Authentication Method).
Password String Provide a valid Salesforce password. Users have the option to store passwords in the component; however, use of the Password Manager feature is recommended (only available when User/Password is selected as the Authentication Method).
Security Token String Provide a Salesforce security token, generated on the Salesforce website (only available when User/Password is selected as the Authentication Method).
Use Bulk API Select 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 cannot be cancelled before completion).
Connection Options Parameter A JDBC parameter supported by the Database Driver—manual setup is not usually required, since sensible defaults are assumed (available parameters are explained in the Data Model).
Value A value for the given Parameter.
Project Select The target BigQuery project to load data into ([Environment Default] is set as default and uses the project defined in the environment).
Dataset Select The target BigQuery dataset to load data into ([Environment Default] is set as default and uses the dataset defined in the environment).
Source Table Select The table (or view) on the Source Schema from which data will be output.
Target Object Select The Salesforce Object (table) into which local data will be input.
Output Operation Select Select whether to Insert, Upsert, Update, or Delete data into the Target Object.
Salesforce ID Select Select the unique ID of the row within the Target Object into which the local data will be written (only available when Upsert, Update, or Delete is selected as the Output Operation).
Column Mappings Source Columns Specify the columns in the Source Table that will be output.
Target Columns Specify columns in the Target Object where the Source Columns will be output.
Auto Debug Select On: Select this option to automatically log debug information about the load (these logs can be found in the Task History and should be included in support requests concerning the component).
Off to override any debugging Connection Options.
Debug Level Select Select the desired level of detail of debug information logged (Beyond 1, huge amounts of data may be logged, resulting in slower execution):
1: Log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2: Also log cache queries and additional information about the request, if applicable.
3: Also log the body of the request and the response.
4: Also log transport-level communication with the data source. This includes SSL negotiation.
5: Also log communication with the data source and additional details helpful in troubleshooting problems (this includes interface commands).