Versions Compared

Old Version 30

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 31

changes.mady.by.user Kalpana Malladi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Write


Description:

This Snap provides the functionality to update object records in Salesforce in Bulk API or REST API mode. The Snap in Salesforce Bulk API mode submits batch jobs and sends the batch job information to the output view for the Salesforce Poller Snap. The Snap in REST API mode updates Salesforce objects and returns results synchronously without the need of the Salesforce Poller Snap.

Note
The ID field is required. This Snap will update records only by record ID and not by its external ID.


Prerequisites:

[None]


Support and limitations:
  • Works in Ultra Task Pipelines.
  • This Snap performs batch processing, that is, a batch of input documents are processed for each HTTP request sent to Salesforce. Values of all the expression-enabled fields must remain constant during the Snap execution or validation. Hence, all expression fields can support Pipeline parameters only when they are expression-enabled. The input data parameters are not supported for expression fields, for example, $serviceVersion.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Salesforce Accounts for information on setting up this type of account.

Views:


Input

This Snap has exactly one input view and receives documents in the view. Each document contains Map data for an object ID and records of field and value pairs.

Output

This Snap has at most one output view and produces documents in the view. Each document contains Map data that includes the Job ID, Batch ID, URL, and an array of records if it is in Bulk API mode. If it is executed in REST API mode, each document contains input data plus a key-value pair of created: false for each successfully updated record.

Error

This Snap has one optional error view and can produce documents in the view if the input data causes an error in REST API. Each document contains the record ID and an error message from Salesforce.com. If the Snap is in Bulk API, a similar set of data is available in the error view of the Salesforce Poller Snap connected to this Snap directly or indirectly.


Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Service Version*


Multiexcerpt include macro
nameME_Service_Version
pageSalesforce Batch Create


Batch Size*

Required.  In Bulk API, this property value is allowed to be from 1 through 10,000. Each input document forms one Salesforce record to be updated. The Snap stores record in memory until the number of records reaches the batch size and sends the request to SFDC in a single batch.   Increasing the batch size increases the amount of memory used during the data load. Decreasing the batch size increases the number of API calls against Salesforce.

In REST API, the Snap can update only one record per each request regardless of the value of the Batch size property.

Default Value: 200
Example: 200, 10000

Object Type*
 

This property enables you to define the name of the Salesforce object, such as Account.

Default Value:  Account
Example:  Account

Salesforce API


Required. This property sets the Salesforce API mode to Bulk API or REST API. The Snap in REST API mode creates one record at a time and returns the results at the output. REST API can be simpler and faster if the number of records to be created is small (a few).

Default Value: Bulk API
Example: REST API


Null Setting With Bulk API


If selected, in Bulk API mode, null values in the input document can set nullable fields null in the Salesforce object. 

Default Value: False

Related Object



Enter or select a related parent object. This property does not affect the Snap operation on records in Salesforce. It is provided for the property suggest and the input schema suggests only. 

Default Value:  [[None]]
Example:  Account

Related External ID


Enter or select an external ID of the selected related parent object. This property does not affect the Snap operation on records in Salesforce. It is provided for the property suggest and the input schema suggests only. 

Default Value:   [[None]]
Example:  AccountNumber__c


Bulk API Serial mode


If selected, Bulk API will run in Serial mode. If not selected, Bulk API will run in Parallel mode. This is only relevant to BULK API. 

Default value: Not selected (Parallel mode)

Standardize Error Output


If checked, the Snap will produce the error output with Reason, Original, Stack trace and Resolution.
If unchecked the output view will simply show the input document along with the error message.

Default Value:  Not selected

Pass Through


If selected, the input document will be passed through to the output view under the key 'original'.

If Pass through is not selected, the input document will not be passed and there is no "original" key in the output document.

Default Value:  Selected

Info

For Bulk APIs, if you select this check box and if the Batch size is equal to 1, the input document is passed to the output view under the key original. If the Batch size is greater than 1, the list of input documents is displayed under Records and the input document is not included under the original key.


Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute


Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute


  

Note

If you want to get the resulting status for each record to be updated in Bulk API mode, you must connect a Salesforce Poller Snap after the Salesforce Update Snap.

Examples

Sample Salesforce Pipeline: This pipeline, available in the Downloads section, uses several Salesforce Snaps to perform create, update, delete, and lookup actions on Salesforce object records. 

Update a New Record

The following is another example that shows how to update a new record in a Salesforce object: 



In the above pipeline execution: 

A Mapper Snap maps the Object record details (that need to be updated using record ID) to the input view of Salesforce Update Snap: 

The Salesforce Update Snap updates the record (using its ID) in the Account object:  



Successful execution of the Snap gives the following preview:

Downloads

Attachments
patterns.*slp, .*zip

Insert excerpt
Salesforce Snap Pack
Salesforce Snap Pack
nopaneltrue