In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
Overview
Salesforce Update is a Write-type Snap that enables you to update object records in Salesforce in Bulk API or REST API mode. In Salesforce Bulk API mode, this Snap submits batch jobs and sends the batch job information to the output view of the Salesforce Poller Snap. In REST API mode, this Snap updates Salesforce objects and returns results synchronously without the need of the Salesforce Poller Snap.
| Note |
|---|
| The ID field is required. This Snap updates records only by record ID and not by its external ID. |
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
Limitations
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.
Snap Views
| View Type | View Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| Each document contains Map data for an object ID and records of field and value pairs. |
| Output | Document |
|
| 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 and a key-value pair of created: false for each successfully updated record. |
| Error | Document |
| N/A | This Snap produces 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. The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error Pipeline. |
Snap Settings
Field | Field Type | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|
Label* | String | 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. Default Value: Salesforce Update | |||||||
Service Version* | String/Expression/Suggestion |
| |||||||
Batch Size* | Integer/Expression | Specify the number of records to be processed in a batch.
Default Value: 200 | |||||||
Object Type* | String/Expression/Suggestion | Enter or select the Salesforce object to be processed. Default Value: Account | |||||||
Salesforce API | Dropdown list | Set 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 | |||||||
Related Object | String/Expression/Suggestion | Enter or select a related parent object. This field 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] | |||||||
Related External ID | String/Expression/Suggestion | 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]] | |||||||
Bulk API Serial mode | Checkbox | Select this checkbox to allow the Bulk API to run in serial mode. Default Value: Not selected (Parallel mode) | |||||||
Standardize Error Output | Checkbox | Select this checkbox to enable the Snap to produce the error output with Reason, Original, Stack trace and Resolution. Default Value: Not selected | |||||||
Pass Through | Checkbox | Select this checkbox to pass the input document the output view under the key 'original'. If you deselect this checkbox, the input document will not be passed and there is no "original" key in the output document. Default Value: Selected
| |||||||
Snap Execution | Dropdown list |
| |||||||
| 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
Update a New Record
The following example that shows Pipeline demonstrates how to update a new record in a Salesforce object: .
First, configure the Mapper Snap to map 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:
| Note |
|---|
The Pipeline, available in the Downloads section, uses several Salesforce Snaps to perform create, update, delete, and lookup actions on Salesforce object records. |
Downloads
| Info |
|---|
Important Steps to Successfully Reuse Pipelines
|
| Attachments | ||
|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|