Page Comparison

On In this Pagearticle

Table of Contents

maxLevel	2
exclude	Older Versions\|Additional Resources\|Related Links\|Related Information

Required. The

Snap type:

Write

Description:

This Snap provides the functionality to delete objects in Salesforce in asynchronous mode.

The Snap in 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 deletes Salesforce objects and returns results synchronously without the need of the Salesforce Poller Snap.

Prerequisites:

[None]

Support and limitations: Works in Ultra Task Pipelines.

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 an ID of the object to be deleted.
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 in Bulk API mode. If it is executed in REST API mode, each document contains Map data for the ID of the deleted record and a key-value pair of "created":"false".
Error	This Snap has one optional error view and might produce documents in the view, if the input data causes an error in the REST API. Each document contains key/value pairs from the input view and an error message from Salesforce.com. The error message is in the value of the error key. If the Snap is in the 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

*

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

Service Version *

Multiexcerpt include macro

name	ME_Service_Version
page	Salesforce Batch Create

Batch Size

Required. In Bulk API, this property value is allowed to be from 1 through 10,000. Each input document can contain an ID value to delete one Salesforce record. The Snap stores input records 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. Decreasing the batch size increases the number of API calls against Salesforce.

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

Default value: 200
Example: 200, 10000Default value: 200

Note
Validation always uses the REST API.

Object Type

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

ExampleDefault Value: Account Account
Default valueExample: Account 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).
Example
Default value: REST Bulk API
Default valueExample: Bulk REST API

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 valueSelect this checkbox to enable the serial mode for Bulk API. Else, the Bulk API runs in parallel mode.

Default Value: Not selected (Parallel mode)

Standardize Error Output

If checked, 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 the input document along with the error message.

Default valueValue: Not selected

Pass Through

If selected, 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, the input document will not be passed and there is no "original" key in the output document.

Default value

. This field applies to REST API and Bulk API, but only when the batch size is one.

Default Value: Selected

Excerpt

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

name	Snap Execution
page	SOAP Execute

Multiexcerpt include macro

name	Execution_Detail_Write
page	SOAP Execute

Insert excerpt

	Salesforce Batch Create
	Salesforce Batch Create
nopanel	true

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

Example

The following Pipeline example shows how to delete a record in a Salesforce object:

In the above pipeline execution:

Object record ID is provided to Salesforce Delete Snap using a Mapper Snap renamed to "Pass through Data Snap":

The Salesforce Delete Snap deletes the specified record in the Account object:

Successful execution of the Snap gives the following preview:

Downloads

Attachments

upload	false
old	false
patterns	.slp, .zip

Insert excerpt

	Salesforce Snap Pack
	Salesforce Snap Pack
nopanel	true

Versions Compared

Old Version 27

New Version 28

Key

Settings

Example

Downloads