Not available in Community Designer

Address and Geolocation Compound Fields

Bulk API does not allow you to read compound fields, e.g. address compound fields. See https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/compound_fields.htm

Attachments

Bulk API does not allow you to read base64 fields. Therefore, attachments cannot be read using SalesforceBulkReader.

API Requests

SalesforceBulkReader uses multiple API calls during its run. All of them count towards your Salesforce API request limit. The precise call flow is:

When working with SalesforceBulkReader, you can hit the limitations of the Bulk API. The following error messages should help you to determine what is going wrong.

FUNCTIONALITY_NOT_ENABLED: Selecting compound data not supported in Bulk Query

The SOQL query asks for a compound data field (e.g. address), but this operation is not supported by the Bulk API. Query the particular fields of the compound field instead.

See https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/compound_fields_address.htm

This example shows the basic use case of SalesforceBulkReader.

Read Account name, Industry, and Website fields from Account.

Solution

Create a Salesforce connection.

In SalesforceBulkReader, set up the Connection, SOQL Query, and Output mapping attributes.

Attribute	Value
Connection	Connection from the first step
SOQL query	SELECT Name, Industry, Website FROM Account
Output mapping	See the code below

//#CTL2

function integer transform() {
 	$out.0.Name = $in.0.Name;
 	$out.0.Industry = $in.0.Industry;
 	$out.0.Website = $in.0.Website;

 	return ALL;
}

You can use output mapping if you have specified the SOQL query attribute.

	Creating a metadata with SalesforceBulkReader
	Connect an edge to the output port. In Output mapping, select the fields in the left side and drag them to the right side.

This example shows way to read addresses.

Read a name and a shipping address (street, city, state/province, postal code, and country) of customers from energy industry.

//#CTL2

function integer transform() {
 	$out.0.Name = $in.0.Name;
 	$out.0.ShippingStreet = $in.0.ShippingStreet;
 	$out.0.ShippingCity = $in.0.ShippingCity;
 	$out.0.ShippingPostalCode = $in.0.ShippingPostalCode;
 	$out.0.ShippingState = $in.0.ShippingState;
 	$out.0.ShippingCountry = $in.0.ShippingCountry;

 	return ALL;
}

This example shows reading object IDs from Salesforce.

Read product names and object IDs of our Animal product family.

//#CTL2

function integer transform() {
 	$out.0.Id = $in.0.Id;
 	$out.0.Name = $in.0.Name;

 	return ALL;
}

SalesforceBulkReader is available since 4.3.0-M2. It uses Salesforce Bulk API version 37.0.

Since CloverETL 4.5.0-M2, SalesforceBulkReader uses Salesforce Bulk API version 39.0.

Since CloverETL 4.6.0-M2, SalesforceBulkReader can also read deleted or archived records. This is configured with Read mode attribute.