On In this Pagearticle
Table of Contents | ||||
---|---|---|---|---|
|
Snap type:
Read
Description:
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.
Prerequisites
:[None
].
Support and limitations
:Works in Ultra Pipelines.
This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Salesforce Account for information on setting up this type of account.
Input | This Snap has at most one input view. |
---|---|
Output | This Snap has exactly one output view. |
Error | This Snap has at most one error view and produces zero or more documents in the view. |
Settings
Label
Limitations and Known Issues
None.
Snap Views
View Type | View Format | Number of Views | Examples of Upstream and Downstream Snap | Description |
---|---|---|---|---|
Input | Document |
|
| SOSL statement. |
Output | Document |
|
| Salesforce records in Salesforce Object Search Language (SOSL). |
Error | Document |
| N/A | 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 | Required.A version * | String/Expression/Suggestion | Specify the version number associated with the Salesforce service that you want to connect to. Example Alternatively, click the Suggestion icon to view the list of versions associated with your account and select a version. Example: 34.0 | |||||||
SOSL statement* | String/Expression | Enables you to specify the following for source objects:
Default Value: [None] 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 | nameSelect the content type for Bulk API: JSON or XML.
Default valueValue: XML | ||||||||
Multiexcerpt include macro |
| |||||||||
Snap Execution | page | Anaplan ReadDropdown list |
|
Example
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:
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|