Versions Compared

Old Version 56

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 57

changes.mady.by.user Kalpana Malladi

Saved on

Key

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

In this article

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Overview

The Salesforce SOQL Snap is a Read-type Snap that retrieves object records from Salesforce using a Salesforce Object Query Language (SOQL) query. See Introduction to SOQL and SOSL for more information.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Task Pipelines.

Limitations

  • For a Salesforce SOQL Snap using the REST API, certain network failures while reading a REST response may result in a socket timeout exception that will not retire.
  • When using Primary Key (PK) Chunking mode in this Snap, the output document schemas in preview mode and execution mode may differ. For more information, see the Note under PK Chunking.
  • This Snap performs batch processing, that is, a batch of input documents are 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

View TypeView FormatNumber of ViewsExamples of Upstream and Downstream Snaps
InputDocument
Min: 0
Max: 1
  • JSON Generator
  • Mapper
OutputDocument
Min: 1
Max: 1
  • File Writer
  • JSON Formatter

Snap Settings

FieldField TypeDescription

Label*

String

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

Default Value: Salesforce SOQL
Example: Salesforce SOQL

Service Version*


String/Suggestion

Multiexcerpt include macro
nameME_Service_Version
pageSalesforce Batch Create

Salesforce API

Dropdown list

Select the Salesforce API mode to Bulk API or REST API.

Default Value: REST API
Example: Bulk API

Note

If you select Bulk API, the Object Type field becomes mandatory


SOQL Query*


String/Expression

Define the SOQL query statement. 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 + "'"

Default value: [None]

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. 

Batch size

    

Integer

Specify the number of records to process in a batch. This refers to the number of records in each batch during the download of large query results. Each batch read requires an API call against Salesforce to retrieve the set of records.

  1. REST API:
    The batch sizes 200 and 2000 are valid in REST API.
    According to the SFDC REST API documentation:
    "There is no guarantee that the requested batch size is the actual batch size. Changes are made as necessary to maximize performance."
    In fact, if the size of each record in the query result is relatively large (e.g. a few hundred output fields), SFDC may respond in a batch size of 200, And if the size of each record in the query result is relatively small, SFDC may respond in a batch size of 2000 regardless if the Batch size is set to 200 or 2000.
  2. Bulk API:
    Selecting the values 100,000 or 250,000 will make the Bulk API request as PK-chunking with a chunk size of 100,000 or 250,000. Other values 200 or 2000 will have the Snap submit a single regular Bulk API batch job to SFDC.
    According to the SFDC Bulk API documentation (Number of attempts to query):
    "15 attempts at 10 minutes each to process the batch. There is also a 2-minute limit on the time to process the query. If more than 15 attempts are made for the query, an error message of 'Tried more than fifteen times' is returned. If the query takes more than 2 minutes to process, a QUERY_TIMEOUT error is returned."
    Therefore, if the query is expected to take a long time to execute (e.g. the target SObject has more than several hundred thousand records and the number of output fields in a record is more than a few hundreds), it is highly recommended to set this property to 100,000 or 250,000 to avoid timeout errors.

Default Value: 2000 
Example: 2000

Object Type*


String

Specify the value for object type that enables you to define the name of the Salesforce object, such as Account. It is not required in REST API. However, SFDC requires it in Bulk API.

Default Value: Account
Example: Account  

Polling Interval*

Integer

Specify the polling interval in seconds for the Bulk API query execution. At each polling interval, the Snap checks the status of the Bulk API query batch processing.

Maximum value: 60

Default Value: 5
Example: 5

Polling Timeout*


Integer

Specify the polling timeout in seconds for the Bulk API query batch execution. If the timeout occurs while waiting for the completion of the query batch execution, the Snap throws a SnapExecutionException.

Default Value: 3000 
Example: 300

Include Deleted records


Checkbox

Select this checkbox to include deleted records in the query result. This feature is supported in REST API version 29.0 or later and Bulk API version 39.0 or later.

Default Value: Not selected

Pass Through


Checkbox

Select this checkbox to pass the input document through to the output view under the key 'original'. This property is applicable for REST and Bulk APIs.

Default Value: Selected 

Ignore Empty Result


Checkbox

Select this checkbox to ignore empty result, so no document will be written to the output view when the operation does not produce any result.
If you deselect this checkbox and select Pass through, the input document will be passed through to the output view. This property is ignored in Bulk API mode.

Default value: Selected

Bulk Content Type



Dropdown list

Select the content type for Bulk API: JSON or XML.  

Note
  • The numeric type field values will be read as numbers in JSON content type, and as strings in XML content type, in the output documents.
  • JSON content type for Bulk API is available in Salesforce API version 36.0.
  • In REST API, the number-type field values will always be read as numbers. If the Bulk API has been selected along with 100,000/ 250,000 as batch size value, the content-type will always be CSV regardless of the value set in this property.
  • When you configure the Snap in PK Chunking (that is, if the Batch size is set to 100,000 or 250,000), the Snap performs the preview execution in Bulk API, not in PK Chunking.

Default Value: XML 
Example: JSON

Match Data type



Checkbox

Select this checkbox to match the data types of the Bulk API results with the data types of REST API. This property applies if the content type is not JSON in Bulk API. In Bulk API, Salesforce.com returns all values as strings if Bulk content type is XML or Batch size is for PK Chunking. If this property is checked, the Snap attempts to convert strings values to the corresponding data types if the original data type is  one of boolean, integer, double, currency and percent. 

This property is ignored in REST API or with JSON Bulk content type. In Bulk API (not with JSON Bulk content type), Salesforce.com does not return any value for null. Therefore, if the value is null, the key-value entry is not present in the output document, which is different from the REST API result.

Default Value: Not selected

Escape Single Quotes in Parameter ValuesCheckbox

Select this checkbox to escape single quotes in the parameter values when the SOQL query property is expression-enabled. You must use this feature when the WHERE clause values are parameterized and contain single quotes. For example, "SELECT Name,Email FROM Contact WHERE Name='" + $Name + "'".
If you clear the selection, the SOQL query property is evaluated without escaping the single quotes.

Default Value: Selected

Preview in Bulk APICheckbox

Select this checkbox to view the preview in Bulk API. If you select this option and the Salesforce API property is Bulk API, the Snap is executed in Bulk API during the preview.

Info

If the query is expected to take long to complete its execution, the preview will also take longer or fail with a timeout error. Users may add "LIMIT 50" to the query to get the preview result fast.
If you deselect this checkbox and Salesforce API is Bulk API, the Snap previews in REST API. The data schema of the query results in REST API may be different from the ones in Bulk API, and the data types of some fields are different between REST API and Bulk API. This issue may result in cases where the pipeline previews successfully, but fails in execution.

Default Value: Not selected

Number of RetriesInteger

Specify the maximum number of retry attempts in case of a network failure. 

Note

  • If the value is larger than zero in PK-Chunking, the Snap overrides user settings and sets Use temp files in PK-Chunking property to true.

  • In Bulk API and PK-Chunking modes, the Snap downloads each batch of data into a temporary local file. When the download is complete, the Snap writes the output documents parsed from the temporary file to avoid the possibility of duplicated output documents in the downstream Pipeline. Ensure that the local drive has sufficient free disk space in the node where the Pipeline executes. All temporary local files are deleted when they are no longer needed.

Minimum value: 0

Default Value: 1
Example: 3

Multiexcerpt include macro
nameretries
pageFile Reader

Retry Interval (seconds)Integer

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

Minimum value: 0

Default Value: 1
Example: 3

Advanced Properties 

Use this field set to set advanced properties. By default, the advanced properties are not required and is an empty table property. Click  to add an advanced property to set a value other than the default value. This field set contains the following fields:

  • Properties
  • Values
PropertiesDropdown list

Select either of the following properties:

  • Use temp files in PK-Chunking 
  • Number of threads in PK-Chunking
  • Validate record count downloaded in Bulk API

Default Value: Use temp files in PK-Chunking
Example: Number of threads in PK-Chunking

Use temp files in PK-Chunking 

Enter true if Groundplex is located where the network connection to SFDC is relatively slow. This will have the Snap in PK-Chunking download CSV files into compressed temporary local files in order to prevent SFDC to close input streams prematurely. Ensure that the Goundplex node has sufficient free disk space. Compressed local files are less than 10% of the total CSV data size.

Setting this property to true may also be necessary if any of the downstream Snaps are relatively slow in processing the document stream. By default, the Snap in PK-Chunking downloads, parses and writes to the output view in streaming mode without using large memory or temporary files. In a normal network condition, this streaming mode is efficient and scalable. However, it has been observed that SFDC tends to close HTTP input streams prematurely if client apps pause reading the input stream momentarily to perform other processing.

Number of threads in PK-Chunking

In PK-Chunking, the Snap invokes multiple threads to download CSV files in parallel with one CSV file per each thread. The maximum number of threads is 8 by default, but a lower number may be more efficient if the network connection to SFDC is relatively slow or downstream Snaps are slow in processing documents.

Validate record count downloaded in Bulk API

This property applies to Bulks API with Batch size 10,000 or smaller (not including PK Chunking). If set to true, the Snap checks if the number of records downloaded is the same as the one processed in Salesforce.com.

Note
titleMismatch in Record Count - Error View

This property is inherently applied with its default value when the user doesn't explicitly configure it, if it is enabled (set to true) it is advisable that the error view be enabled to allow the Snap to send the output to error view in case of record count mismatch.


ValuesString/Integer

Specify the value for property selected in the Properties field. The default values are:

  • Use temp files in PK-Chunking: false
  • Number of threads in PK-Chunking: 8
  • Validate record count downloaded in Bulk API: false

Snap Execution

Dropdown list
Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

Multiexcerpt include macro
nameTemporary Files
pageJoin

PK Chunking

PK chunking splits bulk queries on very large tables into chunks based on the record IDs, or primary keys, of the queried records. Each chunk is processed as a separate batch that counts toward your daily batch limit. PK chunking is supported for the following objects: Account, Campaign, CampaignMember, Case, Contact, Lead, LoginHistory, Opportunity, Task, User, and custom objects. 

PK chunking works by adding record ID boundaries to the query with a WHERE clause, limiting the query results to a smaller chunk of the total results. The remaining results are fetched with additional queries that contain successive boundaries. The number of records within the ID boundaries of each chunk is referred to as the chunk size. The first query retrieves records between a specified starting ID and the starting ID plus the chunk size, the next query retrieves the next chunk of records, and so on. Since Salesforce.com appends a WHERE clause to the query in the PK Chunking mode, if SOQL Query has LIMIT clause in it, the Snap will submit a regular bulk query job without PK Chunking. See PK Chunking Header for more details. 

If 100,000 or 250,000 is selected for Batch size, the value is used as a chunk size in the PK Chunking. Note the chunk size applies to the number of records in the queried table rather than the number of records in the query result. For example, if the queried table has 10 million records and 250,000 is selected for Batch size, 40 batches are created to execute the bulk query job. One additional control batch is also created and it does not process any record. The status of the submitted bulk job and its batches can be monitored by logging onto the your Salesforce.com account in a web browser and going to Setup > Administration Setup > Monitoring > Bulk Data Load Jobs. 

PK Chunking requires Service version 28.0 or later. Therefore, if 100,000 or 250,000 is selected for Batch size and Service version is older than 28.0, the Snap submits a regular bulk query job without PK Chunking.

Note

The output document schemas in preview mode (validation) and execution mode for this Snap may differ when using Primary Key (PK) Chunking mode. This is because the Snap intentionally generates the output preview using regular Bulk API instead of PK Chunking, to reduce the costs involved in the PK Chunking operation.
Salesforce recommends use of PK Chunking if the target Salesforce object (table) is relatively large (for example, more than few 100,000 records).

CSV files are generated as a result of PK Chunking Bulk API request in Salesforce.com. The Snap downloads them into temporary files in local disk of the instance where the pipeline is executed. Therefore, users should make sure sufficient free disk space is available for all CSV files. These temporary files are removed when the CSV parsing is completed.

Example

Pipeline: Data from Salesforce.com and ServiceNow: This pipeline makes use of Salesforce SOQL Snap and illustrates how to work with data from Salesforce and ServiceNow. 

The following Salesforce SOQL Snap shows how the Snap is configured and how the object records are read using SOQL. The SOQL/query retrieves records from Account object that were last modified on a specified date:  

Successful execution of the Snap gives the following preview:

Insert excerpt
Salesforce Snap Pack
Salesforce Snap Pack
nopaneltrue