Salesforce SOSL
- Kalpana Malladi
- Diane Miller (Deactivated)
- Lakshmi Manda
In this article
Overview
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.
Prerequisites
None.
Support and limitations
Works in Ultra Pipelines.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snap | Description |
---|---|---|---|---|
Input | Document |
|
| SOSL statement. |
Output | Document |
|
| Salesforce records in Salesforce Object Search results (SOSL). |
Error | The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error Pipeline |
Snap Settings
Field | Field Type | Description | |
---|---|---|---|
Label* | String | 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 Lookup | |
Service version* | String/Expression/Suggestion | 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. | |
SOSL statement* | String/Expression | Enables you to specify the following for source objects:
Default Value: [None] | |
Pass through | Checkbox | Select this checkbox to include the entire input data in the Snap's output. The Snap includes this data within the $original field in the output. If you deselect this checkbox, the input document will not be passed and there is no " | |
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. | |
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 | |
Snap Execution | Dropdown list | Select one of the following three modes in which the Snap executes:
Default Value: Execute only |
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
Release | Snap Pack Version | Date | Type | Updates |
---|---|---|---|---|
November 2024 | 439patches29230 | Latest | Fixed the vulnerabilities in CXF library dependencies within the Salesforce Snap Pack to enhance security and ensure reliable functionality. | |
November 2024 | 439patches29014 | Latest | Fixed an issue with the Salesforce Lookup, SOQL, and SOSL Snaps, where errors were not routed to the error pipeline when Route Error Data to Error View was enabled, and a referenced expression variable was missing in the upstream or pipeline parameters. | |
November 2024 | main29029 | Stable | Updated and certified against the current SnapLogic Platform release. | |
August 2024 | 438patches28607 | Latest | Fixed an issue with the Salesforce Publisher Snap 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. Breaking change from Salesforce Salesforce is retiring some of the hostnames for non-enhanced domains from August 2024:
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. Workaround To run your pipelines successfully, you must append sandbox to your classic URLs: https://snaplogic--devqa.sandbox.my.salesforce.com/ Learn more about the enhanced domains deployment by Salesforce. | |
August 2024 | main27765 | Stable | Upgraded the org.json.json library from v20090211 to v20240303, which is fully backward-compatible. | |
May 2024 | 437patches27307 | Latest | Fixed authentication issues with the Salesforce Subscriber Snap in the Ultra Pipeline to ensure the Snap reauthenticates and reconnects as expected. | |
May 2024 | main26341 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
February 2024 | 436patches25626 | Latest | Enhanced the Salesforce Bulk Create, Bulk Delete, Bulk Query, Bulk Update, and Salesforce Bulk Upsert Snaps to include the complete error details under the original object that contains the copies of the failed input records. | |
February 2024 | 436patches25192 | Latest | 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:
| |
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 |
| |
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 |
| |
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 |
| |
February 2023 | main19844 | Stable | Upgraded with the latest SnapLogic Platform release. | |
November 2022 | main18944 | Stable | Upgraded with the latest SnapLogic Platform release. | |
October 2022 | 430patches18769 | Latest |
| |
September 2022 | 430patches18125 | Latest | The Salesforce Bulk Create, Salesforce Bulk Delete, and Salesforce Bulk Update Snaps are now working as expected without displaying the error | |
September 2022 | 430patches18036 | Latest | The Salesforce Read Snap now correctly parses the 2-byte UTF-8 characters in Windows OS in the PK chunking mode. | |
August 2022 | main17386 | Stable |
| |
4.29 Patch | 429patches16708 | Latest |
| |
4.29 | main15993 | Stable | 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:
| |
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:
| |
4.27 | main12833 | Stable |
| |
4.26 Patch | 426patches12054 | Latest | 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 |
| |
4.24 Patch | 424patches9024 | Latest |
| |
4.24 Patch | 424paches8569 | Latest | Fixes an issue in Salesforce Bulk Upsert, Salesforce Bulk Update, and Salesforce Bulk Create Snaps that fail to process Related object and Related external ID values by modifying the input schema that formats the CSV data. Potential Breaking Change 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. | |
4.23 Patch | 423patches7888 | Latest |
| |
4.23 | main7430 | Stable | 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. | |
4.20 | snapsmrc535 | Stable | Added the Salesforce Bulk Query Snap, which enables you to perform bulk SOQL queries on Salesforce. | |
4.19 | snaprsmrc528 | Stable |
| |
4.18 Patch | salesforce7832 | Latest | 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 |
| |
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 |
| |
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 |
| |
4.11 Patch | salesforce4299 | Latest |
| |
4.11 | snapsmrc465 | Stable | Polling timeout property's default value increased to 3000 from 300 for Salesforce Lookup, Salesforce Poller, Salesforce Read, and Salesforce SOQL Snaps. | |
4.10 Patch | salesforce4005 | Latest | Salesforce Poller Snap: Includes the success field in the output. | |
4.10 | snapsmrc414 | Stable | Upgraded with the latest SnapLogic Platform release. | |
4.9.0 Patch | salesforce3218 | Latest | Fixed the error in PK Chunking when a downstream Snap is blocking the pipeline | |
4.9.0 Patch | salesforce3247 | Latest | Addressed an issue withSalesforce Poller Snap causing JSON Formatter to throw ConcurrentModificationException. | |
4.9.0 Patch | salesforce3225 | Latest | Addressed a null pointer exception in the Salesforce Update Snap. This exception was present in both salesforce3082 and salesforce3122. | |
4.9 | snapsmrc405 | Stable | Updated the Salesforce Create, Batch Create, Delete, Poller, Update and Upsert Snaps with Pass through property. | |
4.8.0 Patch | salesforce2884 | Latest |
| |
4.8 | snapsmrc398 | Stable |
| |
4.7.0 Patch | salesforce2284 | Latest | Added log to troubleshoot a deploy issue. | |
4.7.0 Patch | salesforce2255 | Latest | Addressed SFDC SOQL Snap routing to the error view & validate PK Chunking record numbers. | |
4.7.0 Patch | salesforce2244 | Latest | Addressed possible leak with threads waiting to download PK Chunking responses. | |
4.7.0 Patch | salesforce2218 | Latest | SFDC SOQL Snap route to the error view & validate PK Chuning record numbers. | |
4.7.0 Patch | salesforce2209 | Latest | SOQL Snap now correctly routes to the error view & validates PK Chunking record numbers. | |
4.7 | snapsmrc382 | Stable |
| |
4.6.0 Patch | salesforce1931 | Latest |
| |
4.6 | snapsmrc362 | Stable |
| |
4.5.1 | salesforce1633 | Stable |
| |
4.5 | snapsmrc344 | NA | Latest |
|
4.4.1 | Stable |
| ||
4.4 | Stable | Resolved an issue with Salesforce Query returning inconsistent result sets. | ||
4.3.2 | Stable |
| ||
4.3 | NA |
| ||
4.22 | NA |
| ||
| ||||
| ||||
| ||||
| ||||
|
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.