Salesforce SOSL is a Read-type Snap. You can use this Snap to search the Salesforce objects and fields from Salesforce by defining the search statement in the Salesforce Object Search Language (SOSL). The Snap uses the REST API to perform the search. See Introduction to SOQL and SOSL for more information.
To use newer Salesforce objects, use the latest API versions where those objects are available.
Specify the version number associated with the Salesforce service that you want to connect to. Alternatively, click the Suggestion icon to view the list of versions associated with your account and select a version.
Default Value: 34.0 Example: 34.0
SOSL statement*
String/Expression
Enables you to specify the following for source objects:
text expression
scope of fields to search
list of objects and fields to retrieve
conditions for selecting rows in the source objects
Refer to the following online documents for more information on SOSL:
Default Value: [None] Example: FIND {map*} IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead
Pass through
Checkbox
Select this checkbox to include the entire input data in the Snap's output. The Snap includes this data within the$originalfield in the output.
If you deselect this checkbox, the input document will not be passed and there is no "original" key in the output document.
Default Value: Selected
Ignore empty result
Checkbox
If selected, no document will be written to the output view when the operation does not produce any result. If this property is not and Pass through is selected, the input document will be passed through to the output view.
Default Value: Selected
Bulk content type
Dropdown list
Select the content type for Bulk API: JSON or XML.
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 or higher. In preview mode, the Snap always executes in REST API, and this property value will have no effect. In REST API, 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.
Default Value: XML Example: JSON
Snap Execution
Dropdown list
Select one of the following three modes in which the Snap executes:
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: Validate & Execute
Example
Reading Object Records using SOSL
The following Salesforce SOSL Snap shows how the Snap is configured and how the object records are read using SOSL. The SOQL/query retrieves records from Account object that begin with the string United:
Successful execution of the Snap gives the following preview:
Snap Pack History
Click to view/expand
Release
Snap Pack Version
Date
Type
Updates
August 2024
438patches28607
Latest
Fixed an issue with theSalesforce PublisherSnap where an invalid session triggered infinite retries, resulting in many open file descriptors that eventually crashed the node.
August 2024
438patches28040
Latest
Fixed an issue with the Salesforce SOQL Snap where the URL encoding was improperly applied to sandbox instance URLs. Now, the Snap ensures URL sandbox instance URLs are properly encoded.
Redirections for legacy (non-enhanced) hostnames stop in production orgs and demo orgs. Production orgs get this release starting in January 2025.
Redirections for legacy (non-enhanced) hostnames stopped in sandboxes, Developer Edition orgs, patch orgs, scratch orgs, and Trailhead Playgrounds.
When deploying a new My Domain, including enhanced domains, Salesforce automatically redirects previous URLs. For detailed information, such as hostname formats for legacy (non-enhanced) domains, refer to the Prepare for the End of Redirections for Non-Enhanced Domains.
To align with Salesforce’s redirection changes for non-enhanced domains, the classic URL format (https://snaplogic--devqa.my.salesforce.com/) is no longer supported for Sandbox environments. As a result, any existing Salesforce pipelines using classic URLs will stop functioning as before.
Fixed an issue with the Salesforce Mutual Authentication Account where the 8443 port was not used while authorizing the account. Now, the access token request uses the 8443 port for authorizing the Mutual Authentication Account.
Breaking change
Prior to 436patches25192, the Salesforce Mutual Authentication Account supported default Login URLs such as https://login.salesforce.com and https://test.salesforce.com. From 436patches25192, this account no longer supports the default Login URLs—your existing pipelines using the Mutual Authentication Account with the default Login URLs might break.
To prevent this breaking change, you must provide a valid Salesforce Login URL as part of your account configuration.
February 2024
main25112
Stable
Enhanced the Salesforce Bulk Query Snap with expression support for the Include Deleted Records checkbox.
November 2023
435patches24747
Latest
Fixed an issue that caused the input stream to not close properly, which resulted in stale connections.
November 2023
435patches24368
Latest
Enhanced the performance of the Salesforce Bulk Query Snap with a new Maximum threads field. This field enables you to download query results simultaneously in multiple threads.
November 2023
435patches24006
Latest
Enhanced the Salesforce Read Snap by adding expression enablement to the following checkboxes:
Use PK chunking if supported
Include Deleted Records
November 2023
main23721
Stable
Updated and certified against the current SnapLogic Platform release.
August 2023
434patches23646
Latest
Fixed an issue where a long-running pipeline containing the Salesforce Subscriber Snap would suddenly stop responding.
August 2023
434patches22537
Latest
Improved the Salesforce Bulk Upsert Snap error messages by limiting the length of the reason displayed with the error.
August 2023
main22460
Stable
Updated and certified against the current SnapLogic Platform release.
May 2023
433patches21367
Latest
The Salesforce SOQL Snap now honors the selection of the Match Data Type checkbox when the value entered for Batch Size is greater than 50,000.
The Salesforce Read Snap now honors the selection of the Match Data Type checkbox if the Use PK chunking if supported checkbox is also selected.
May 2023
main21015
Stable
Upgraded with the latest SnapLogic Platform release.
February 2023
432patches20586
Latest
Fixed an issue with the Salesforce SOQL and Salesforce Read Snaps where the Match Data Type checkbox selection was not honored if the Salesforce API field was set to Bulk API.
February 2023
432patches20393
Latest
The Display null or empty values as null checkbox in the following Salesforce Snaps enable you to control the display of empty string and null data as null in the output preview.
The Salesforce Account no longer validates an invalid URL but fails with an error:
Error processing table usr__c = ErrorDto{failure='Failed to perform AutoSync for table usr__c
February 2023
432patches20145
Latest
Fixed an issue with the Salesforce Read Snap that was causing an error for the Time data type.
February 2023
432patches20087
Latest
The Salesforce Create, Update, and Upsert Snaps now include an Apply active assignment rules checkbox so you can control whether to use assignment rules for the selected object
February 2023
432patches20008
Latest
Fixed an issue with the Salesforce Read Snap where using the bulk API request would fail due to column specification.
Added support to use PK chunking on any batch size with the bulk API request and to automatically disable PK chunking if it is known that it cannot be done
February 2023
main19844
Stable
Upgraded with the latest SnapLogic Platform release.
November 2022
main18944
Stable
Upgraded with the latest SnapLogic Platform release.
CometD version upgrade from 5.0.9 to 7.0.6 (latest).
The simplified logging provides useful diagnostic information without logging any sensitive data.
The Snap asynchronously makes callbacks or listens to the CometD API to identify and respond to specific events.
The Snap processes the most recent message so that it can send that replay ID if there is a need to resubscribe. If the server responds with an invalid replay ID, the Snap automatically sets the Replay ID value to -2 to get all available messages.
Upgraded the Cometd version from 5.0.9 to the latest 7.0.6 version.
Fixed an issue where the Snap reported an error and stopped only at the next resubscribe attempt when it encountered the daily limit exceeded error. Now, the Snap displays the error and stops immediately when it encounters the daily limit exceeded error.
Simplified the logging that provides useful diagnostic information without logging any sensitive data.
Enhanced the Snap design to make the callbacks or listeners asynchronously by the Cometd API when there is a specific event, and the Snap responds accordingly.
Enhanced the tracking of replay ID of the most recent message processed so that Snap can send that replay ID if there is a need to resubscribe. If the server responds that the replay ID is invalid, Snap automatically sets theReplay IDvalue to-2to get all available messages.
Upgraded with the latest SnapLogic Platform release.
4.28 Patch
428patches14355
Latest
Fixed an issue with Salesforce Snaps where the Service Version could not be retrieved from SFDC due to a blocked URL, failing the Snap execution.
4.28
main14627
Stable
Upgraded with the latest SnapLogic Platform release.
4.27 Patch
427patches14079
Latest
Fixed an issue with the Salesforce Subscriber Snap where the Snap was unable to re-subscribe to a topic if it did not receive any message for 72 hours —stopped and displayed an error message. With this fix, the Snap automatically sets the Replay ID value to -2 when:
the specified Replay ID is invalid or outside the retention window.
the most recently received Replay ID for an event is outside the 72-hour retention window.
4.27 Patch
427patches13944
Latest
Fixed an issue with Salesforce accounts, where an account password containing special characters and an empty security token was not properly encoded and the account was not validated.
4.27 Patch
427patches13789
Latest
Fixed the following issues with Salesforce Snaps:
High memory use due to leaked resources.
Hung Pipelines due to blocked threads.
4.27
main12833
Stable
Added Salesforce Mutual Authentication Account to Salesforce Snap Pack that provides an additional layer of security while authentication. Both the client and server authenticate themselves using Client Certificate Authentication. This account is not supported for Salesforce Subscriber and Salesforce Publisher Snaps.
Extended the supportofSalesforce OAuth2 Account to all the Salesforce Snaps in addition to the Salesforce Bulk Snaps.
Revised the name of Salesforce Attachment Download to Salesforce Download Snap. Enhanced this Snap with a new field File Type to support download of attachments from Salesforce by passing Content Data ID in addition to the Attachment ID.
Updated the default Salesforce API Service Version to 52.0 for the following Snaps:
Enhanced the following Snaps to support Pipeline parameters only for expression fields, while the input data parameters are not supported for expression fields.
Enhanced the Salesforce Subscriber Snap with improved resilience to network failures and fixed an issue with duplicate documents.
4.26
main11181
Stable
Upgraded with the latest SnapLogic Platform release.
4.25 Patch
425patches10182
Latest
Fixed an issue with the Salesforce Read Snap where the retry fields do not work as expected when a Pipeline has more than ten Snaps.
4.25 Patch
425patches9609
Latest
Enhanced the Salesforce Read Snap to allow you to add an optional second output view that exposes the schema of the target object as the output document. The output view of the Snap has a minimum of one output and a maximum of two outputs.
4.25
main9554
Stable
Enhanced the Salesforce Upsert Snap to support CSV payload using the new field Bulk Content Type in Bulk API mode as Salesforce API has recently been supporting CSV payload as well. Earlier, this Snap supported only XML data type; you can now select CSV content type from the Bulk Content Type drop-down list. The default content type is set to XML to preserve backward compatibility. This enhancement also addresses the null values issue during Bulk API mode.
Enhanced the Snaps in the Salesforce Snap Pack by updating the field labels to title case. If you have existing Pipelines using Salesforce Snaps that include the field names in the error messages, you must update those Pipelines to use the new field labels.
This Salesforce Snap patch contains an issue affecting the Salesforce Subscriber and Salesforce Publisher Snaps. If you do not use these Snaps in your Pipelines, then you can use this patch version. Else, we recommend you to not use this patch version as Pipelines will fail. We will fix this issue soon in an upcoming patch.
4.24
main8556
Stable
Upgraded with the latest SnapLogic Platform release.
Upgraded with the latest SnapLogic Platform release.
4.22
main6403
Stable
Upgraded with the latest SnapLogic Platform release.
4.21 Patch
salesforce8829
Latest
Fixed the Salesforce Create, Update, Bulk Create, Bulk Update, and Bulk Upsert Snaps, enabling you to upload files containing duplicate values across multiple fields.
4.21
snapsmrc542
Stable
Upgraded with the latest SnapLogic Platform release.
4.20 Patch
salesforce8814
Latest
Fixed the Salesforce Create, Update, Bulk Create, Bulk Update, and Bulk Upsert Snaps, enabling you to upload files containing duplicate values across multiple fields.
4.20 Patch
salesforce8797
Latest
Fixed the Salesforce Subscriber Snap wherein the Salesforce Subscriber and Mapper Snap combination generates Null output for Array object type.
Enhanced the Salesforce Subscriber Snap to capture Change Data Capture (CDC) events.
4.18
snapsmrc523
Stable
Upgraded with the latest SnapLogic Platform release.
4.17 Patch
salesforce7474
Latest
Added Order by clause and Limit clause properties to the Salesforce Reader Snap to fix an issue wherein the Snap throws an error while fetching records.
4.17
ALL7402
Latest
Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17
snapsmrc515
Latest
Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16 Patch
salesforce6889
Latest
Added two new properties, Number of retries and Retry interval, to the Salesforce Read, SOQL, Publisher, and Subscriber Snaps. These properties let you handle retry attempts and intervals in case of a network failure.
4.16
snapsmrc508
Stable
Added two new Snaps:
Salesforce Publisher: Publish Salesforce platform event records to a given event custom sObject (Salesforce Object).
Salesforce Subscriber: Subscribe to Salesforce platform event records for a given event custom sObject.
4.15 Patch
salesforce6405
Latest
Fixed an issue with resource leak in PK Chunking in Salesforce Read and SOQL Snaps.
4.15 Patch
salesforce6349
Latest
Fixed an issue with the Salesforce SOQL Snap timing out while waiting for a connection from the pool.
4.15
snapsmrc500
Stable
Upgraded with the latest SnapLogic Platform release.
4.14 Patch
salesforce5670
Latest
Fixed the Salesforce SOQL Snap that fails to execute if the parameter values of a SOQL query expression contain the WHERE clause.
4.14
snapsmrc490
Stable
Upgraded with the latest SnapLogic Platform release.
4.13
snapsmrc486
Stable
Fixed an issue where the Salesforce Read Snap fails to download the PK-Chunking CSV file due to network failure or running out of disk space.
Fixed an issue where theSalesforce Lookup Snap does not match the datatype with the Bulk API; for instance, boolean data returns string.
Fixed an issue where the Salesforce SOQL Snap does not preview data in pipelines.
Fixed an issue where PK Chunking files are not deleted from the temp directory.
4.12 Patch
salesforce4839
Latest
Fixed a defect that occurs when downstream Snaps are slow in processing documents downloaded from SFDC.
4.12 Patch
salesforce4773
Latest
Added a new option in Advanced properties - "Validate record count downloaded in Bulk API" that compares the number of records processed vs downloaded and routes output to Error View (if Error View is enabled) if there is a mismatch.
4.12
snapsmrc480
Stable
Updated Salesforce SOQL and Lookup Snaps to ensure that they are consistent with SnapLogic guidelines of writing Snap data exceptions to error views and continuing to process next documents vs. hard stopping.
Enhanced the Salesforce read operations for the Read, SOQL, and SOSL Snaps to display the original Salesforce error cause, reason, and resolution.
4.11 Patch
salesforce4299
Latest
Fixed an issue wherein the Salesforce SOQL Snap did not get an input stream from the next records URL.
Fixed an issue with the Salesforce SOQL Snap querying del