Using components: Salesforce Destination

Use the Salesforce destination component to store the output of a data flow in Salesforce Sales cloud object.

The destination component uses Salesforce Bulk API.

Connection

Select an existing Salesforce connection or create a new one (for more information, see Allowing Integrate.io ETL access to my data on Salesforce.)

Destination Properties

  • API Version - list of Salesforce Bulk API versions we support. Read more about Bulk API 2.0 here
  • Target object - select the name of the target object in your Salesforce org. By default, if the table doesn't exist, it will be created automatically.

Operation type

  • Append (Insert only) - default behavior. Data will only be appended to the target object. Note that you can't insert data into the internal id field.
  • Update - update existing data according to the selected update key. 
    • Update key - when operation type is update, you must map a key field and select it as the update key. This can be either the internal id field, or an external key field. The external key should not allow duplicate values.
  • Upsert - inserts new data into the object and updates existing data according to the selected upsert key.
    • Upsert key - when operation type is upsert, you must map a key field and select it as the upsert key. This can be either the internal id field, or an external key field. The external key should not allow duplicate values.
  • Delete - deletes data in the destination object by Salesforce internal id field.
  • Hard Delete - deletes data in the destination object by Salesforce internal id field. This allows records to bypass the recycle bin and immediately become available for deletion.

Advanced options

  • Batch size - number of records that are inserted to Salesforce in each batch (default 1000). Only available in Bulk API 1.0
  • Maximum errors - maximum number of errors to tolerate when inserting data into Salesforce. Note that the actual number of errors may be greater than the maximum due to the parallel nature of the process.
  • Thread count - number of threads can be used when writing the data in parallel to Salesforce. A one node cluster can run around 5 threads in parallel (assuming no other packages are running).
  • Include null fields on the payload - include null values using update/upsert operation type in Salesforce.
  • Output failed records - number of failed records for a completed job using any operation type in Salesforce with CSV file as an output. Currently, we have limitation using package variables in file path of output failed records. Only available in Bulk API 1.0

Schema Mapping

Map the dataflow fields to the target object fields. When using the insert operation, fields defined as mandatory in the object must be mapped to input fields. When using the upsert operation, you should map the mandatory fields if you expect to insert data. If you use the internal id field as the upsert key, make sure to use null in the mapped field's value for new records. When using the delete operation, the internal id field must map to an input field.