Locate

This help page is for Desktop Studio. This information is also available for CXone Studio.

Searches a string for a character of block of text.

Supported Script Types

The icon for a Generic script type - a rectangle with < and > symbols inside it.

The icon for the Email script type - a large @ symbol in a diamond.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

The icon for the Digital script type - a computer monitor with a smartphone next to it.

Generic

Email Chat Phone Voicemail Work Item SMS Digital

Input Properties

These properties define data that the action uses when executing.

Property

Description

String The string you want to insert, search, or parse. This property supports variable substitution. If this value is a variable, rather than the literal string value, use curly brackets {}.
StringtoFind The string to look for. Use of variable substitution is common.
Variable The name of the variable that you want to hold the value.
CaseSensitive The value for this property is either true or false. True requires the StringtoFind text exactly as it is contained in String, including the same character case.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition

Description

Default

Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.

OnFound

Path taken if the String to Find is located.

Tips & Tricks

If the string being searched for is found, the branch condition, Found, will be triggered, however, the variable will also receive a value greater than zero. This provides two possible methods for detecting the text.