Configuring the Search Objects activity

You must create an SForce Object Search Language (SOSL) query to configure the Search Objects activity.

About this task

The following sections discuss the steps to configure the Search Objects activity, create an SOSL query, and provide SOSL syntax rules for App Connect.

To configure the Search Objects activity complete the following steps:

Procedure

  1. In the Checklist, select Configure. The Specify Query window opens.
  2. Create an SOSL query in the Specify Query window.
  3. Optional: You can specify dynamic parameters in the search clause of the SOSL statement. You can then map these parameters dynamically as the input parameters for the activity, which allows the activity to dynamically control the query based upon the input to the orchestration. Use a ($) dollar sign to denote a parameter and follow it with the parameter name.
  4. Click the Validate icon Validate query, to validate the query. If the query is invalid, the Validation Feedback icon Validate Feedback icon shows in the lower left corner of the Specify Query window. For invalid queries:
    • Click the Validation Feedback icon in the lower left corner of the Specify Query window for a list of validation errors.
    • Use the Refresh icon to refresh meta data and revalidate the SOSL statement.

Creating SOSL queries

About this task

When creating a SForce Object Search Language (SOSL) query, you can use dynamic parameters in the WHERE clause of the SOSL statement. Studio can then dynamically map these parameters as the input parameters for the activity. This allows for dynamic control of the query based upon input to the orchestration.

The SForce Object Search Language does not define a syntax for parameterized queries; however, App Connect does enforce a few proprietary SOSL syntax rules. You can use parameters in either simple expressions or set expressions.

SOSL syntax rules for App Connect

About this task

  • Use a ($) dollar sign to denote a parameter. After the ($) dollar sign, specify a string of alphanumeric characters. The first character must be a letter [a-zA-Z], optionally followed by one or more letters [a-zA-Z], digits [0-9], or ( _ ) underscores.
    Note: Parameter names are case-sensitive; therefore, the parameters $a and $A are considered to be different parameters.
    The following table contains examples of valid and invalid parameter declarations:
    Parameter Valid or Invalid
    $AnAccount valid
    $a123_456 valid
    $123a invalid
    $_id invalid
  • You must declare parameters in the Search Query portion of the SOSL statement. Curly braces ( { } ) demarcate the Search Query portion of the SOSL statement.
    Important: Do not use double-quotes ( " " ) to enclose parameters. If you enclose parameters in double-quotes, the activity treats the parameter as a string search literal.
  • The parameter type is always xsd:string. During substitution, the activity escapes any parameter that you declare using a reserved character. Reserved characters include the following characters:
    Reserved Characters Description
    & ampersand
    * asterisk
    \ back slash
    [ ] box brackets
    : colon
    , comma
    { } curly braces
    " double quote
    ! exclamation mark
    - minus sign
    + plus sign
    ' single quote
    ~ tilda
    ^ up arrow
    | vertical bar
  • Parameters can appear more than once in a given SOQL statement. However, even though the parameter appears more than once in the SOQL statement, it only appears once in the input parameter map. The activity substitutes the same value for all locations where the parameter is used at runtime.



Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


https://www.ibm.com/support/knowledgecenter/en/SS3LC4_7.5.3/com.ibm.wci.doc/Configuring_the_Search_Objects_Activity.html