Versions Compared

Old Version 34

changes.mady.by.user Lakshmi Manda

Saved on

compared with

New Version Current

changes.mady.by.user Lakshmi Manda

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

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.

Note

Multiexcerpt include macro
macro_uuid400ce58f-0da5-4a11-ae68-7d54283f17be
nameSalesforce objects limitation
templateDataeJyLjgUAARUAuQ==
pageSalesforce Batch Create
addpanelfalse


Prerequisites

None.

Support and limitations

Works in Ultra Pipelines.

Limitations and Known Issues

None.

Snap Views

TypeFormatNumber of ViewsExamples of Upstream and Downstream SnapDescription
InputDocument
  • Min: 0
  • Max: 1

  • JSON Parser

  • Mapper
SOSL statement.
OutputDocument
  • Min: 1
  • Max: 1
  • Mapper
  • Copy
  • JSON Formatter
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

Anaplan 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 Value: Salesforce Lookup
Example: 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.

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

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 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
Multiexcerpt include macro
nameSnap_Execution_Introduced
page

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:


Insert excerpt
Salesforce Snap Pack
Salesforce Snap Pack
nopaneltrue