LOCATE
                                                        This help page is for Studio. This information is also available for Desktop Studio.
| 
                                                                         
                                                                              | 
                                                                    
                                                                         Searches a string for a character or block of text.  | 
                                                                
Supported Script Types
| 
                                                                         
                                                                              | 
                                                                    
                                                                         
                                                                              | 
                                                                    
                                                                         
                                                                              | 
                                                                    
                                                                         
                                                                              | 
                                                                    
                                                                         
                                                                              | 
                                                                    
                                                                         
                                                                              | 
                                                                    
                                                                         
                                                                              | 
                                                                    
                                                                         
                                                                              | 
                                                                
| 
                                                                         Generic  | 
                                                                    Chat | Phone | Voicemail | Work Item | SMS | Digital | 
Input Properties
These properties define data that the action uses when executing.
| 
                                                                     Property  | 
                                                                
                                                                     Description  | 
                                                            
|---|---|
| 
                                                                     Add Caption  | 
                                                                
                                                                     Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon.  | 
                                                            
| 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 ( { } ). | 
| String To Find | The string to look for. Use of variable substitution is common. | 
| Variable | The name of the variable that you want to hold the value. | 
| Case Sensitive | 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. | 
| 
                                                                     Found  | 
                                                                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.