Versions Compared

Old Version 9

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version Current

changes.mady.by.user Lakshmi Manda

Saved on

Key

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

On this page

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to update or insert object records in Salesforce.com in Bulk API mode.

Image Removed

Prerequisites

None.

Support and Limitations

Works in Ultra Pipelines.

Troubleshooting

None.

Snap Input and Output

...

  • Min: 1
  • Max: 1

...

  • Mapper

...

  • Min: 0
  • Max: 1

...

  • JSON Formatter and File Writer

...

This Snap has at most one output view and produces documents in the view.

Snap Settings

...

Specify the name for the account. Preferably update the name if your project has more than one Snap of the same type.

Default Value: Salesforce Bulk Upsert
Example: Salesforce Bulk Upsert

...

Service version*

...

Specify the version number associated with the Salesforce service that you want to connect to. The expression evaluation is not supported.

Default Value: 41.0
Example: 41.0

...

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

Default Value: Account
Example: Account

...

Specify the name for the External ID field. Use this field to define the unique externalized key of the object. The Snap operates exclusively on the external ID field, and not on the Salesforce-generated record ID. The external ID is useful when you want to synchronize an external system to Salesforce.com.

If a record for a given external ID exists, the record is updated with the input record data. If no record exists for a given external ID, create a new record with the input record data. Use the external ID as the unique record identifier from an external system. 

To create an external ID field for an Account object:

...

On this page

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to update or insert object records in Salesforce Bulk API 2.0.

Note

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

Image Added

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

Multiexcerpt include macro
nameME_Expression_Fields_Limitation
pageSalesforce Bulk Create

Snap Views

TypeFormatNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input Document
  • Min: 1
  • Max: 1
  • Mapper
This Snap has exactly one input view and receives documents in the view. Each document contains Map data for a record ID and key-value pairs for fields to be updated. or inserted
OutputDocument
  • Min: 0
  • Max: 1
  • JSON Formatter and File Writer

This Snap has at most one output view and produces documents in the view.

Error

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


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*String

Specify a unique name for the Snap instance.

Default Value: Salesforce Bulk Upsert
Example: Salesforce Bulk Upsert

Service Version*

String/Expression/Suggestion

Multiexcerpt include macro
nameME_Service_Version
pageSalesforce Batch Create

Object Type*String

Specify the name of the Salesforce object or select one from the suggested list.

Note

This Snap does not support Net Zero Cloud Salesforce objects.

Default Value: Account
Example: Account

External-ID Field*String

Specify the name for the External ID field. Use this field to define the unique externalized key of the object. The Snap operates exclusively on the external ID field, and not on the Salesforce-generated record ID. The external ID is useful when you want to synchronize an external system to Salesforce.com.

If a record for a given external ID exists, the record is updated with the input record data. If no record exists for a given external ID, create a new record with the input record data. Use the external ID as the unique record identifier from an external system. 

To create an external ID field for an Account object:

  1. Log in to your Salesforce account.
  2. Go to App Setup > Customize > Account > Fields > New.
  3. Follow the instructions and create a new custom field.

Default Value: N/A
Example: external_Id_c__c

Related ObjectString

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 suggestion and the input schema suggestion only.

Default Value: N/A
Example: external_Id_c__cAccount

Related objectExternal IDString

Enter or select a an external ID of the related parent object. This property does not affect the Snap operation on records in Salesforce. It is provided for the property suggestion and the input schema suggestion only.

Default Value: N N/A
Example: Account

Related external IDString

Enter or select an external ID of the related parent object. This property does not affect the Snap operation on records in Salesforce. It is provided for the property suggestion and the input schema suggestion onlyAccountNumber__c

Display null or empty values as null



Checkbox

Select this checkbox to display empty string or null data as null in the output preview.

When you deselect this checkbox, the Snap displays empty string or null data as blank in the output preview.

Default Value: 

N/A
Example: AccountNumber__cPolling interval

Deselected

For a better understanding, refer to this Example.

Info

The output in the Salesforce application remains unaffected. Whether the checkbox is selected or deselected, the Salesforce record and its corresponding output continues to appear empty, as shown below: 

Image Added


Polling Interval*Integer

Define polling interval in seconds.

Default Value:  N/A5
Example: 5

Polling timeoutTimeout*Integer

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

Default Value:  N/A3000
Example: 300

Maximum retry attemptsRetry AttemptsInteger

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

Default Value:  N/A5
Example: 5

Retry interval Interval (seconds)Integer

Define the interval between retries in seconds.

Default Value:  N/A3
Example: 3

Snap ExecutionString

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

Default Value: Execute only
Example: Execute only

Example

Inserting Bulk Records in Salesforce

This example demonstrates how you can to insert or update a new bulk record in a Salesforce object.

Image Modified

The JSON Generator Snap generates five new JSON documents. The output from the Snap displays the names of the documents and customized serial numbers.

The following images display the Snap configuration and output: 


The Mapper Snap transforms the incoming data using the given mappings and produces new output data. The output from the Snap displays the names and customized serial numbers of the output documents. The following images display the Snap configuration and output: 

Image Modified


The Salesforce Bulk Upsert Snap updates or inserts data in Salesforce.com. The output from the Snap displays the names, IDs, and customized serial numbers of the updated or inserted documents. The following images display the Snap configuration and output: 

Image RemovedImage Added

Downloads

Multiexcerpt include macro
namedownload_instructions
pageOpenAPI

Attachments
patterns*.slp, *.zip

...