Versions Compared

Key

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

On In this Pagearticle

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

Snap type:

Read

Description:

This Snap provides the ability

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.
Image Added

Prerequisites

:

[

None

]

.

Support and limitations

:

Works in Ultra Pipelines.

Account: 

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.

Views:
Input

This Snap has at most one input view.

Output

This Snap has exactly one output view.

ErrorThis Snap has at most one error view and produces zero or more documents in the view.

Settings

Label

Required.

Limitations and Known Issues

None.

Snap Views

View TypeView FormatNumber of ViewsExamples of Upstream and Downstream SnapDescription
InputDocument
  • Min: 0
  • Max: 1
  • JSON Formatter
  • Mapper
SOSL statement.
OutputDocument
  • Min: 1
  • Max: 1
  • Mapper
  • Copy
  • File Writer
Salesforce records in Salesforce Object Search Language (SOSL).
Error

Document

  • Min: 1

  • Max: 1

N/A

The error view contains error, reason, resolution and stack trace. For more information, see Handling Errors with an Error Pipeline

Snap Settings

Required.A version

If selected, the input document will be passed through to the output view under the key 'original'.

If is not selectednameAnaplan Read
FieldField TypeDescription

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 ValueSalesforce Lookup
ExampleSalesforce Lookup

Service version

*


String/Expression/Suggestion

Specify the version number associated with the Salesforce service that you want to connect to.


Example

Alternatively, click the Suggestion Image Addedicon to view the list of versions associated with your account and select a version.

Default Value: 34.0

Default value

Example: 34.0

SOSL statement*

String/Expression

Required.

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]
ExampleFIND {map*} IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead


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. 


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 "original" key in the output document.

Default valueValue: 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 valueValue: 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 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.

Example: JSON

Default valueValue: XML  

Multiexcerpt include macro


Example: JSON

Snap Execution

pageDropdown list
Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

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:


Excerpt Include
Salesforce Snap Pack
Salesforce Snap Pack
nopaneltrue