Salesforce Object (Bulk API)

1. Overview

Salesforce is a cloud-based CRM software designed for service, marketing, and sales.

Salesforce objects are database tables that permit you to store data that is specific to an organization. Salesforce objects are of two types:

• Standard Objects: Standard objects are the kind of objects that are provided by salesforce.com such as users, contracts, reports, dashboards, etc.

• Custom Objects: Custom objects are those objects that are created by users. They supply information that is unique and essential to their organization. They are the heart of any application and provide a structure for sharing data.

The Salesforce Object (Bulk API) source supports batch syncs.

2. Info Tab

You can review the parameters that can be found in the info tab below (Image 1).

Values

Parameter	Description	Example
Title	Mandatory. Input a name for your data sync	Salesforce Bulk API
Version	Mandatory. This is a pre-populated field containing a version number for your data sync. You can override it if you wish.	1.0.0
Parameters	Optional. Review our documentation on Parameters here for more information about this field.

Image 1: The Info Tab

3. Source Tab

The following table outlines the mandatory and optional parameters you will find on the Source tab (Image 2).

Source Details

The following parameters will help to define your data sync source and how it functions.

Parameter	Description	Example
Source	Mandatory. Select your source from the drop down menu.	Salesforce Object (Bulk API)
Object	Mandatory. The name of your Salesforce Object.
Auth URL	Mandatory. The URL that issues your Salesforce auth token.	https://test.salesforce.com/services/oauth2/token
Client ID	Mandatory. The encrypted Client ID to connect to your Salesforce Object. The Connections UI will automatically encrypt this value for you.
Client Secret	Mandatory. The encrypted Client Secret for the above Client ID. The Connections UI will automatically encrypt this value for yo.
Username	Mandatory. The encrypted Username of an account that can connect to your Salesforce Object. The Connections UI will automatically encrypt this value for you.
Password	Mandatory. The encrypted Password associated with the above account that can connect to your Salesforce Object. The Connections UI will automatically encrypt this value for you.

Schema

The Schema section is where you define which source columns you want to sync in your connection. You can repeat the values for multiple columns.

Parameter	Description	Example
Name	Mandatory. The name of your column as it appears in the source.	Name
Alias	Optional. You may choose to use an alias on your column so that it has a different name in the data sync.
Data Type	Mandatory. The data type of the column values.	Text
Description	Optional. You may choose to add a description to your column.

There are other options available for the Schema section if you click on Show Advanced.

Parameter	Description	Example
Mandatory	If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected If just Mandatory is checked on a column, then all rows are synced with the execution log status of failed, and the source error of "Mandatory Rule Violation" If just Validated is checked on a column, then all rows are synced.
Validate Data	If both Mandatory and Validated are checked on a column, then rows where the column is empty are rejected If just Validated is checked on a column, then all rows are synced.
Trim Whitespace	Optional if data type = text. If your data type was chosen as "text", you can choose whether to trim the whitespace (that is, spaces and other non-printing characters).
Max Length	Optional if data type = text. You can input a numerical value in this field that represents the maximum length of the data that can be synced in your column. If the value is exceeded, the row will be rejected (you can find this error in the Execution Log).

You can choose to add in a Transformation > String Replacement by inputting the following:

Parameter	Description	Example
Pattern	Mandatory if using a Transformation. The pattern for your string replacement, i.e. the string that will be searched and replaced.
Replacement	What you want to replace your pattern with.

Note that you can have more than one String Replacement

Filter

You have the option to add a source filter to your data sync. Please review the documentation here for more information on source filters.

Image 2: The Source Tab

4. Next Steps

• Configure your Destination

• Define your Sync Behaviour.

• Add in your Post Sync Scripts, if required.

• Define your Permissions.

• Click Jobs > Start a Job to begin your sync.