search() Function
This function may not be compatible with all features of Appian. For details, see the Feature Compatibility section below.

Function

search( search_text, within_text, start_num )

Searches the text for a particular substring, returning the positional index of the first character of the first match.

See also: find()

Parameters

Keyword Type Description

search_text

Text

The text that will be searched for.

within_text

Text

The text within which the search text will be searched for.

start_num

Number

The positional index of the first character of the substring to be returned.

Returns

Number

Usage considerations

Using the search_text parameter

The search_text parameter does not support wildcard characters.

Using the within_text parameter

The first character of the entire within_text value is considered to have an index = 1.

Examples

search("to","boston",1) returns 4

Feature compatibility

The table below lists this function's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Custom Record Field Expressions Compatible
Open in Github Built: Wed, Aug 10, 2022 (11:20:24 PM)

On This Page

FEEDBACK