On In this Pagearticle
Table of Contents | ||||
---|---|---|---|---|
|
Snap type:
Read
Description:
Overview
This Snap provides the functionality to poll the status of the batch job submitted to Salesforce by the preceding Salesforce Snaps (Create/Delete/Update/Upsert) in Bulk API mode. This Snap uses the Salesforce Bulk API to check the batch job status and retrieve the result for each record. The Snap sends the successful record writes to the output view and the failed record writes to the error view.
+Prerequisites
:None.
Support
and limitations:for Ultra Pipelines
Works in Ultra Task Pipelines.
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.
Limitations and Known Issues
None.
Snap Views
View Type | View Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| This Snap has exactly one input view and receives documents in the view. Each document contains a Map data for the job ID (key: "jobId"), batch ID (key: "batchId") and URL (key: "url"), and records of field-value pairs. |
Output | Document |
|
| This Snap has exactly one output view and produces documents in the view. Each document contains Map data that includes an object ID and records of the field-value pairs for the successful record write. |
Error | Document |
| N/A | This Snap has one optional error view and produces documents in the view. Each document contains Map data that includes an object ID, records of the field-value pairs for the failed record write, and an error message. |
Snap Settings
Field | Field Type | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
Label* | String | Required. 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 | Required. The version number associated with the Salesforce service that you want to connect to."v34.0" for REST API or "34.0" for Bulk API. Example: 34.0Default value: 34.0 | ||||||
Polling interval | String | Required. Enables you to define the polling interval in seconds for the Bulk API batch job execution. At each polling interval, the Snap checks the status of the Bulk API batch processing. Example: 5 | ||||||||
Polling timeout | String | Required. Enables you to define the polling timeout in seconds for the Bulk API batch job execution. If the timeout occurs while waiting for the completion of the batch job execution, the Snap throws a SnapExecutionException. Default Value: 3000 | ||||||||
Pass through | If the Pass through property is selected, the Checkbox | nameSelect this checkbox to display input data fields are shown as the top level flatmap data merged with the response from SFDC in the output document. If the Pass through in Poller Snap is not selectedyou deselect this checkbox, the output document will have the response from SFDC only. Default valueValue: Selected | ||||||||
Multiexcerpt include macro | ||||||||||
Snap Execution | page | SOAP ExecuteDropdown list |
|
Examples
Pipeline: Salesforce.com Data to a File: This pipeline reads data using a Salesforce read and writes it to a file.
Expand | ||
---|---|---|
| ||
The following pipeline shows how a Salesforce Create Snap creates an object record and the Salesforce Poller Snap is used to poll the status of the object creation action:
In the pipeline execution:
|
Expand | ||
---|---|---|
| ||
Salesforce Poller pipeline with generic error output viewIn this pipeline, the Salesforce Poller Snap polls the status from a delete action. The status of the invalid records are routed to the error view. The Salesforce Delete Snap deletes the record 001i000001g41S9AAI from the object type Account.
The output error view is displayed below: |
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|