The salesforce batch sink is responsible for using Salesforce API to insert/upsert/update salesforce objects. The sink should handle large batches of data (~10 GB) and should handle all object types - contacts, campaigns, oppurtunities, leads, custom objects. Users should be able to upload subset of fields
...
| Section | User Configuration Label | Description | Default | User Widget | Early Validations |
|---|---|---|---|---|---|
| Authentication | Username | Salesforce username | Text Box | Try a to login to bulk API with given credentials. | |
| Password | Password | ||||
| Consumer Key | Consumer Key from the connected app | Text Box | |||
| Consumer Secret | Consumer Secret from the connected app | Password | |||
| Login Url | For Salesforce sandbox runs login url is different. That's why user needs to have this option. | https://login.salesforce.com/services/oauth2/token | Text Box | ||
| Advanced | SObject | Name of Salesforce sObject - ex: Contact, Campaign, Oppurtunity. | Text Box | Check if sObject with given name exists in Bulk API. | |
| Operation | Possible values are:
| Insert | Select | If operation is upsert or insert. Validate input schema to contain id/external id fields. | |
| Upsert external id field | External id field name. Used only for upsert. [5] | Text Box | If empty and operation is upsert fail. If not empty and operation is insert or update fail. | ||
| Maximum bytes per batch | If size of batch data is larger than given number of bytes, split the batch. | 10,000,000 [2] | Text Box | If more than 10,000,000 than fail [3] | |
| Maximum records per batch | If there are more than given number of records, split the batch. | 10,000 [2] | Text Box | If more than 10,000 fail [4] | |
| Error handling | Bulk API will return success results per row so this is necessary [1] (unlike for source plugins). Possible values: "Skip on error" - ignores any reports about records not inserted. Simply prints an error log. | Skip on error | Select |
...
Upsert - Salesforce requires user to provide and an external id field name. This field is used as basis for upsert (Salesforce will decide if objects are the same using it).
Id field can be used for that (which is present for all Salesforce sObjects). Also user can create a custom field and checkmark it as "External Id" via Salesforce UI.
Update - Using Specifying an external id field as a basis is not supported. For updates Salesforce will always use 'Id' field as basis.