On In this Pagearticle
| Table of Contents | ||||
|---|---|---|---|---|
|
Snap type:
Write
Description:
Overview
Salesforce Update is a Write-type Snap that enables you 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: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.
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.
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 plus a key-value pair of created: false for each successfully updated record. | |
| Error | Document |
| N/A | 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. |
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. | ||||||||
Service Version* | String/Expression/Suggestion |
| |||||||
Batch Size* | String/Expression | 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 | |||||||
Object Type* | String/Expression | This property enables you to define the name of the Salesforce object, such as Account. Default Value: Account | |||||||
Salesforce API | Dropdown list | 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 | |||||||
Related Object | String/Expression/Suggestion | 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]] | |||||||
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. |
|
to run in Parallel mode. This is applicable only |
for BULK API. 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. |
Deselect this checkbox to display the input document along with the error message in the output view. 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
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 | ||
|---|---|---|
|
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|