Not available in Community Designer

SalesforceWriter supports writing attachments. You can either receive the attachment from byte fields or and read the attachment from files.

The both options are mutually exclusive. If both options are specified, reading the attachment from byte fields has higher priority over reading the attachment from files.

Attachments from byte fields

Attachment can be read from input metadata field of byte or cbyte data type. The field containing the attachment is to be mapped to byte field, e.g. Body field in Attachment object.

Attachments from files

To read attachments from files, map field with file URL to a string field with _FileURL suffix, which is below the corresponding byte field, e.g. Body_FileURL field in Attachment object.

You can map only one file per record. Wild cards in file name are not supported.

When specifying Salesforce objects and fields, always use the API Name of the element.

SOAP API does not support HardDelete operation. If you need HardDelete operation, use SalesforceBulkWriter.

Limits introduced by Salesforce API

Single API soap call cannot contain more than 200 objects.

Single soap message cannot exceed 50MB (encoded as UTF-8).

The component will do its best to bundle as many objects (records) as possible together into a single call to reduce number of used API requests. In most cases all 200 records will fit into the 50MB limit, so the component will need 1 API request for 200 records.

When writing very long text fields or attachments it's possible that a smaller number of records will take all 50MB. In such case the component sends as many records as possible in every call but ensures that the soap message will not exceed 50MB limit. Rest of the records will be sent in another call. Users don't need to worry about sizing the messages themselves. If they want however, they can monitor the bundling of records. The number of records and expected size of the message is included in graph log on DEBUG level.

Usage of API calls

The component uses several API calls during its run:

This example shows a basic use case with insertion of records.

Insert records with new contacts into Salesforce. Input data fields have the same field names as Salesforce data fieds.

This example shows updating of Salesforce objects.

Punch Cards Ltd. has changed its name to United Floppies Ltd. Update the name in Account table/object.

//#CTL2

function integer transform() {
 	$out.0.Id = $in.0.Id;
 	$out.0.Name = "United Floppies Ltd.";

 	return ALL;
}

This example shows upserting records.

There is a list of contacts (name and surname) and new phone number. Update the phone numbers of the contacts. If there is no such contact, create a new one.

//#CTL2

function integer transform() {
 	$out.0.Id = $in.0.Id;
 	$out.0.FirstName = $in.0.FirstName;
 	$out.0.LastName  = $in.0.LastName;
 	$out.0.Phone     = $in.0.Phone;

 	return ALL;
}

This example shows deleting records.

A contact Ab C has been inserted by mistake. Delete the contact.

This example shows writing attachments into Salesforce. The content of the file is received from a byte field of input port metadata.

Insert an attachment to Account 'Floppies United'.

Solution

Create a Salesforce connection.

Read id of the 'Floppies United' account with SalesforceBulkReader.

Read attachment with FlatFileReader into a byte field. The metadata on output port on FlatFileReader use EOF as delimiter; set record delimiter and default field delimiter empty.

Merge the data streams with Combine.

Write the attachment with SalesforceWriter.

In SalesforceWriter, use Connection, Salesforce object, and Input mapping attributes.

Attribute	Value
Connection	Connection from the first step
Salesforce object	Attachment
Input mapping	See the code below.

//#CTL2

function integer transform() {
 	$out.0.ParentId = $in.0.Id;
 	$out.0.Body     = $in.0.FileContent;
 	$out.0.Name     = $in.0.FileName;

 	return ALL;
}

	Note
	In SalesforceWriter you can read files to be uploaded directly. In input mapping, map URL of the file to Body_FileURL field.

This example shows writing attachments to Salesforce. The content of the attachment is not received from byte fields, but read from files.

Input data to SalesforceWriter contains ContactID, Filename, and path to the file. Write the files to the Salesforce as attachments.

//#CTL2
function integer transform() {
	$out.0.ParentId = $in.0.id;
	$out.0.Name = $in.0.name;
	$out.0.Body_FileURL = $in.0.filename;

	return ALL;
}

SalesforceWriter is available since 4.4.0-M1. It uses Salesforce SOAP API version 37.0.

Since CloverETL 4.5.0-M2, SalesforceWriter uses Salesforce SOAP API version 39.0.

Since CloverETL 4.5.0, you can set batch size.