Skip to main content

Salesforce Bulk API Receiver Connector

It enables effective use of the Salesforce Bulk API and a more secure and performant integration for big data uploads or updates.

Required Connector Properties

  • Username/Password Credential: It refers to the Basic credentials defined for Salesforce login operations. The name of a previously defined credential is provided.

  • Client Id/ Client Secret Credential: It refers to the OAuth2 credentials defined for Salesforce login operations. The name of a previously defined credential is provided.

  • Bulk Api v2 Version: It refers to the version for Salesforce Bulk API.

  • Process Type: It has two options: Bulk Query and Bulk Data.

    • Bulk Query: It is a feature used to query large data sets and get the results of these queries. Bulk query is used to query large data sets against a Salesforce object and comes with Salesforce Bulk API to process the results more efficiently. The response is returned in CSV format.
    • Bulk Data: It refers to a concept generally used to perform large data uploads and updates on the Salesforce platform. As part of the Salesforce Bulk API, it is used to bulk load or update large datasets in CSV format.

Required properties if Bulk Data is selected:

  • Bulk Operation: It has two options: Create Job and Upload Job Data. In the Create job option, a job is created and contains parameters that specify what type of operation to perform (for example, Create, Update, Delete) and which Salesforce object to perform an operation on. A job ID is received as a result of the Create Job step, and this ID is used to follow the process and get results in subsequent steps. In the Upload Job Data step, a job is created and the file, arranged in accordance with the format of the data to be uploaded (CSV), is sent to the Salesforce platform by associating it with the specified job ID.The "Upload Job Data" step associates the data on which the operation will be performed with the specified job and makes this data ready for upload.

  • Object Name: This parameter specifies which Salesforce object the action is directed to. For example, Account, Contact, Opportunity.

  • Operation: This determines the transaction type. For example, Create, Update, Delete.

  • Column Delimiter: It is used to separate columns. A comma (,) is usually used.

  • Line Ending: Used to identify line breaks.

  • External ID: If Operation Upsert is selected, an external ID is required. This parameter specifies the name of the external identity field.

Required properties if Bulk Query is selected:

  • Column Delimiter: It is used to separate columns. A comma (,) is usually used.

  • Line Ending: Used to identify line breaks.

  • SELECT: It is used to determine the fields to be retrieved from the database.

  • FROM: It is used to determine which object to retrieve data from.

  • WHERE: It is used to filter query results.

  • ORDER BY: It is used to retrieve query results in a specific order.

  • Order Type: Specifies the order used in the sorting process. "ASC" indicates that the sorting is from smallest to largest (or A to Z in alphabetical order). The expression "DESC" indicates that the sorting process should be from largest to smallest (or from Z to A in alphabetical order).

  • Place Null Records: It is used to determine the order of null values. The "NULLS FIRST" statement puts the records with null values first in the sorting process, and the "NULLS LAST" statement puts the records with null values later in the sorting process.

  • LIMIT: It is used to determine how many records to retrieve from the query results.