Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
On this Page

In this article

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

Snap type:

Write

Description:

This Snap provides the functionality

Overview

Salesforce Update is a Write-type Snap that enables you to update object records in Salesforce

in

in Bulk API 1.0 or REST

API

API mode.

 The Snap in Salesforce

Salesforce Poller Snap checks the result of the batch job when in Bulk API mode

submits batch jobs and sends

Snap submits the batch job and writes the batch job information to the output view

for the Salesforce Poller Snap. The Snap in

. In the REST API mode

updates Salesforce objects and

, the Snap updates record to the Salesforce object and returns results synchronously without the need

of

for the Salesforce Poller Snap.

Note
  • The ID field is required. This Snap
will update
  • updates records only by record ID and not by its external ID.
  • Multiexcerpt include macro
    macro_uuid1a85276d-640d-4891-8f76-1d4e5ec8cf45
    nameSalesforce objects limitation
    templateDataeJyLjgUAARUAuQ==
    pageSalesforce Batch Create
    addpanelfalse

Salesforce Update SettingsImage Added

Prerequisites

:

[

None

]

.

Support

and limitations:

for Ultra Pipelines

Works in Ultra Task Pipelines.

Account: 

Limitations

  • 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:InputThis Snap has exactly one input view and receives documents in the view.
  • 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

TypeFormatNumber of ViewsExamples of Upstream and Downstream SnapsDescription
InputDocument
  • Min: 1
  • Max: 1
  • Salesforce Delete
  • Mapper
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.
Document
  • Min: 1
  • Max: 1
  • Copy
  • Mapper
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
and a key-value pair of created: false for each successfully updated record.
ErrorDocument
  • Min: 1

  • Max: 1

N/A

This Snap

has one optional error view and can produce

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.
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.

The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error Pipeline.

Snap Settings

RequiredThis property enables you to define Required. This property sets With If selected, in Bulk API mode, can set nullable fields null object  FalseIf selected, If checked, If selected, multiexcerpt-include-macropageSOAP Execute

Field

Field TypeField Dependency

Description

Label*


StringNoneRequired.

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

Pipeline.

Default Value: Salesforce Update
ExampleSalesforce Update

Service Version*


String/Expression/SuggestionNone

Multiexcerpt include macro
nameME_Service_Version
pageSalesforce Batch Create


Batch Size*

Integer/ExpressionNone

Specify the number of records to be processed in a batch.

Info

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

 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

Size.

Default Value: 200
Example: 200, 10000

Object Type*
 

String/Expression/SuggestionNone

Specify the name of the Salesforce object , such as Accountor select one from the suggested list.

Note

This Snap does not support Net Zero Cloud Salesforce objects.


Default Value:   Account
Example:   Account

Salesforce API


Dropdown listNone

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
Example: REST API

Null Setting with Bulk APICheckboxNone

Select this checkbox to set the nullable fields to null in the Salesforce object if there are null values in the input document

. This field works only if you select Bulk API mode in the Salesforce

API field.

Default Value: Deselected
Example:

Selected

Related Object



String/Expression/SuggestionNone

Enter or select a related parent object. This property 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]]
Example: Account_r

Apply active assignment rulesCheckboxAppears when you select REST API from the Salesforce API dropdown and when the Object Type is Account, Case, or Lead.

Select this checkbox to apply the active assignment rules for the selected object type (Account, Case, or Lead).

If you deselect this checkbox, active assignment rules are not applied for the selected object type (AccountCase, or Lead).

Default Value: Selected

Related External ID


String/Expression/SuggestionNone

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


CheckboxNone

Select this checkbox to allow the Bulk API will to run in Serial serial mode. If not selected,
Deselect this checkbox to allow the Bulk API will to run in Parallel Batch mode. This is applicable only relevant to for BULK API. 

Default valueValue: Not selected (Parallel Batch mode)

Standardize Error Output


CheckboxNone

Select this checkbox to enable the Snap will to produce the error output with Reason, Original, Stack trace and Resolution.
If unchecked the output view will simply show Deselect this checkbox to display the input document along with the error message in the output view.

Default Value:  Not selected

Pass Through


CheckboxNone

Select this checkbox to pass the input document

will be passed through to

the output view under the key 'original'.

If

Pass through is not selected

you deselect this checkbox, 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 checkbox 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.


name

Snap Execution


Dropdown listNone

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 example Pipeline demonstrates how to update a new record in a Salesforce object.

Image RemovedImage Added

In the above pipeline execution: 

A Mapper Snap maps 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

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.


Attachments
patterns.*slp, .*zip

Insert excerpt
Salesforce Snap Pack
Salesforce Snap Pack
nopaneltrue