Versions Compared

Key

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

In this article Table of ContentsmaxLevelIn this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to delete records using Salesforce Bulk API 2.0. The Snap submits the delete requests in batches..

Note

Multiexcerpt include macro
macro_uuid400ce58f-0da5-4a11-ae68-7d54283f17be
nameSalesforce objects limitation
templateDataeJyLjgUAARUAuQ==
pageSalesforce Batch Create
addpanelfalse


Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Note

In Ultra Pipelines, set the Batch Size as 1 for the Snap to process one document/record at a time.

Limitations

  • This Snap performs batch processing; a batch of input documents is 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
Input Document
  • Min: 1
  • Max: 1

Mapper

Each document contains one Salesforce record.
OutputDocument
  • Min: 0
  • Max: 1

JSON Formatter and File Writer

Produces documents in the view.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current Pipeline execution when the Snap

encounters an error.
  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

  • Learn more about Error handling in Pipelines
    • encounters an error.

    • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

    • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

    Learn more about Error handling in Pipelines.


    Info

    Because of the potentially large size of the error messages, the Reason for the Salesforce error message in the error document field may be truncated.
    The complete error is available in the field full_error under the original object containing copies of the failed input records or in the logs.


    Snap Settings

    Field NameField TypeDescription

    Label*


    Default Value
    :Salesforce Bulk Delete
    Example
    :SalesforceBulk2Delete

    String

    Specify the name for the Snap. Update the Snap name if two or more Snaps of the same type are in your pipeline.


    Service Version*

    String/Expression/Suggestion

    Multiexcerpt include macro
    nameME_Service_Version
    pageSalesforce Batch Create

    Object Type*

    Default
    Default Value
    :Account
    Example
    Account

    String

    Specify the name of the

    object type. This property enables you to define the name of the Salesforce object

    Salesforce object or select one from the suggested list.

    Note

    This Snap does not support Net Zero Cloud Salesforce objects.


    Polling Interval*


    Default Value:
     N/A 5
    Example: 5

    Integer

    Define polling interval in seconds.


    Polling Timeout*

    Default
    Default Value: N/A 
    3000
    Example
    :300

    Integer

    Define the maximum time in seconds to wait for the query to complete.


    Maximum Retry Attempts

    Default
    Default Value
    : N/A 5
    Example
    : 5

    Integer

    Define the maximum number of retries to attempt in case of connection failure.


    Retry Interval (seconds)

    Default
    Default Value
    : N/A3
    Example
    : 3

    Integer

    Define the interval between retries in seconds.


    Snap Execution

    Default
    Default Value
    Execute only
    Example
    Validate and Execute 

    String

    Select one of the three modes in which the Snap executes. Available options are:

    • Validate & Execute: Performs limited execution of the Snap and generates a data preview during Pipeline validation. Subsequently, it performs full execution of the Snap (unlimited records) during Pipeline runtime.
    • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
    • Disabled: Disables the Snap and all Snaps that are downstream from it.

    ...



    Example

    Delete Records In Bulk from Salesforce

    This example demonstrates how to delete bulk records from a Salesforce object. 

    Note

    The delete function needs data; therefore, this Pipeline uses Salesforce Bulk Create and Bulk Delete Snaps to create and delete data. The example description includes only the delete action. Learn more about creating data, Salesforce Bulk Create.

    Image Modified

    You must pass a valid object record ID from Salesforce to delete a record. 

    In this example, the Salesforce Bulk Create Snap creates the IDs, and the Mapper2 Snap passes these IDs to the Salesforce Bulk Delete Snap. 

    The following images display the Mapper2 Snap configuration and output: 

    Image Modified


    The Salesforce Bulk Delete Snap deletes the specified records.
     The following images display the Snap configuration and output: 

    Image Modified

    Downloads

    Multiexcerpt include macro
    namedownload_instructions
    pageOpenAPI

    ...