The salesforce batch sink is responsible for using Salesforce API to upsert 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 opartion is upsert check if input schema contains 'Id' field. | |
| 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 |
...
[4] according to Bulk API Limitations batch will fail if it has more than 10.000 records. So if user sets maximum records to something more than 10.000 we should tell the user that it does not make sense by failing the pipeline.
[5] for upsert and update operations user will have to provide inputSchema which has Id fields. This is required by Salesforce
Salesforce Bulk API for INSERT and how we use it.
...