Versions Compared

Key

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

On this page

Table of Contents
maxLevel2
absoluteUrltrue

Overview

Use You can use this Snap to perform bulk SOQL queries using Salesforce Bulk API 2.0.

Prerequisites

Valid Salesforce OAuth 2 account with Read permissions.

Support and Limitations

Works in Ultra Pipelines.

...

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input Document
  • Min: 0
  • Max: 1
  • Mapper Snap
  • Filter
  • Router
A document containing values required for the bulk query.
OutputDocument
  • Min: 1
  • Max: 1
  • Document to Binary
  • Salesforce Upsert

A document containing the results of the query performed by the Snap.

Snap Settings

Parameter NameData TypeDescription
Default ValueExample 
Label*String
The

Specify the name for the Snap.

We recommend you to update the Snap name if there is

 You can modify this to be more specific, especially if you have more than one

Snap

of the same

type

Snap in your Pipeline.

Default ValueSalesforce Bulk Query

N/A

Example: Salesforce Bulk Query

Service version*

String
The Salesforce

Specify the Salesforce Bulk Query service version that you want to use for this query.

Default Value47.0
Example: 47.0

SOQL query*String
Required. This property enables you to define the SOSL query statement

Specify the query in SOQL format. You can enter a JavaScript expression, which is evaluated each time the Snap is executed. As in the second example below, on each document received from the input view, the % symbols will be replaced with the value pointed to by the JSON path $.Id in the input data.

Example:

Paste code macro
"SELECT Name FROM Account"
"SELECT Id,Name,Phone FROM Account WHERE Id='" + $Id + "'and  
     Name='" + $name + "'"


Note
titleUsing quotes in the WHERE clause
  • Do not use quotes for field names in the WHERE clause. Using quotes results in an error.
  • Use only single quotes for values in the WHERE clause as using double quotes results in an error.
  • The above rules do not apply when you are using SnapLogic expressions, you can use quotes for the field names and values as applicable. 

Default value

Default Value[None]
Example"select FirstName, LastName from " + $object + " order by Name LIMIT 5"

Max records per set*Integer
The The

Specify the number of records that you want the Snap to fetch in a single set.

Default Value10000
Example:5000

Polling interval*

Integer
Required. 

Specify the number of seconds for which you want the Snap to wait between two queries. At each polling interval, the Snap checks the status of the Bulk API query batch processing.

Minimum value: 1

Maximum value: 60

Default Value5
Example:10

Polling timeout*Integer
Required. The

Specify the number of seconds into the query batch execution before the query fails if it receives no response. If the timeout occurs while waiting for the completion of the query batch execution, the Snap throws a SnapExecutionException.

Minimum value: 10 

Default Value3000
Example: 300

Maximum retry attemptsInteger
The

Specify the maximum number of retry attempts that the Snap must make in case of a network failure. 

Minimum value: 1

Multiexcerpt include macro
nameretries
pageFile Reader

Default Value5
Example: 1

Retry interval (seconds)Integer
The

Specify the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure.

Minimum value: 0

Default Value1
Example: 3

Snap ExecutionString
Specifies the execution type

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

  • Validate & Execute: Performs limited execution of the Snap
(up to 50 records)
  • , and generates a data preview during Pipeline validation
;
  • . Subsequently, performs full execution of the Snap (unlimited records) during Pipeline
execution
  • runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution
; does not execute the Snap during Pipeline validation
  • without generating preview data.
  • Disabled: Disables the Snap and

, by extension, the downstream Snaps
  • all Snaps that are downstream from it.

Default

value/A

ValueValidate & Execute

Validate and ExecuteN

ExampleExecute only

Insert excerpt
Salesforce Batch Create
Salesforce Batch Create
nopaneltrue

Multiexcerpt include macro
nameTemporary Files
pageJoin

Examples

Querying for Contacts in Salesforce Using Upstream Parameters in the Bulk Query Snap

...