Search

Adding the Search action A feature that supplies the instructions in a botflow. to a botflow A file that stores the actions and variables designed to automate tasks. selects a list from a target An element within an application Nintex RPA interacts with, such as a button, text field, or checkbox. and searches the list for a list item, folder, or Reckon APS software column.

There are two Selector Tool Feature used to target web browser or desktop applications components for botflow interaction. settings available for the Search action:

Setting Description Use
None Default setting for the Selector tool.
  • Targeting lists.
  • Targeting columns in Reckon APS software.
UIA Targeting Override Setting with UIA Targeting Override selected under the Tools menu on the Menu Bar. Targeting folders.

Microsoft UI Automation is an accessibility framework for Microsoft Windows and is available on all operating systems supporting Windows Presentation Foundation (WPF). The Nintex RPA Selector Tool also supports Windows applications based on Extensible Application Markup Language (XAML), Silverlight, and Windows Forms (WINFORM).

The differences between the Selector Tool with and without the UIA Targeting Override option selected are:

  • Not Selected: The highlighted area around the targeted element encompasses a number of list items, which is useful for targeting lists, such as a list of fonts in Notepad.

  • Selected: The highlighted area around the targeted element may be smaller and more focused on a specific item, which is useful for targeting a specific folder in a list of folders, such as a list of folders in Windows File Explorer.

Using the Search action, you can search a list for a specific list item which then returns a true or false value for if the item exists in the list. For example, you can drag the Selector Tool onto the list of fonts in Notepad and search for the font, Tahoma.

Using the Search action when targeting Reckon APS software, you can target a column in a multi-column document to search for a specific column status. For example, you can drag the Selector Tool onto a list of columns in Reckon APS software to search for a column with a Closed status.

Using the Search action with UIA Targeting Override selected, you can search a list of folders for a specific folder and then expand that folder with a double-click. For example, you can drag the Selector Tool in UIA Targeting Override onto the Windows (C) folder in Windows File Explorer and search for the Users folder.

Add a Search action to a botflow

To add a Search action to a botflow:

  1. Drag the Selector Tool () onto the target application to display the Target Preview. A preview image displays visually confirming what you targeted.
  2. Select Search from the Data actions list. The Action Builder window for Search displays.
  3. Set the Search Options/Settings:

    • Text: Type a search term in the field or use the Expression Builder () to build the action settings using variables or other token values.
    • Start at: Select the search starting point from the drop-down list.
      • First item: Starts the search from the first item in a list.
      • Current item: Starts the search from the currently selected item in a list.
    • Column (only for Reckon APS): If the target has more than one column, the Column field and drop-down list display so that you can select a column to search.
    • Ignore case: Ignores the search term letter case.
    • Ignore surrounding spaces: Ignores any beginning or ending spaces surrounding the search term.
    • Partial match: Returns partial matches based on the search term.
    • Use wildcards: Allows for the use of wild card characters, such as an asterisk (*) or question mark (?), in the search term.
    • Selection (only for Reckon APS): If the target has more than one column, the Selection field and drop-down list display so that you can select a column to search.
    • Interaction: Select the required interaction from the drop-down list:
      • None (available for both UIA Targeting Override and for Reckon APS): Has no interaction. This is useful if you want to search for an item and verify whether or not the item was found.
      • Click: Clicks the search results.
      • Double Click: Double-clicks the search results.
      • Get Value (available for both UIA Targeting Override and for Reckon APS): Retrieves a column value, such as a status. This is useful when the status of a Reckon APS column is needed.
    • Save to: Type a location to save the search results or use the Expression Builder () to build the action settings using variables or other token values.

      • Note: If the Search action fails and the Save to field is blank, the botflow stops.  If you saved the search results in a field or variable, that field or variable is updated with a False value and the botflow continues running.

  4. If needed, adjust the Rules to modify how Nintex RPA finds the application target.
  5. If needed, adjust the Timing Settings to fine tune how the action runs.
  6. View the action Details.
  7. If needed, adjust the Run Switch to add the action without running it.
  8. Optionally, add an action Note.
  9. Click OK to add the Search action to the botflow.

This example shows how to add a Search action to a botflow using Windows Notepad:

  1. Open Windows Notepad and Nintex RPA.
  2. Click Format in the Notepad menu and select Font from the menu drop-down list.
  3. Drag the Selector tool () onto the Font list.
  4. Select Search from the Data actions list.
  5. Type "Tahoma" in the Text field.
  6. Adjust the Run Switch to Don't Run.
  7. Click OK to add the Search action to the botflow.
  8. Click Play () to run the botflow. The Search action finds the "Tahoma" font in the Font list.

This example shows how to add a Search action to a botflow using Windows File Explorer:

  1. Open Windows File Explorer and Nintex RPA.
  2. Select UIA Targeting Override from the Tools menu.
  3. Drag the Selector tool () onto the Windows (C) folder in Windows File Explorer.
  4. Select Search from the Data actions list.
  5. Type "Users" in the Text field.
  6. Select Double Click from the Interaction drop-down list.
  7. Set the Timing to Wait forever.
  8. Adjust the Run Switch to Don't Run.
  9. Click OK to add the Search action to the botflow.
  10. With the Windows (C) folder selected and expanded in Windows Explorer, click Play () to run the botflow. The Search action finds and expands the Users folder in the Windows (C) folder.

Search action field and button descriptions

 

Field or button Description
Selector Tool

The Selector Tool allows you to choose the target element the botflow interacts with, such as a button, text field or check box.

Ensure your machine's Windows Settings (Start Menu > Settings) are set as follows when using the Selector Tool:

  • Windows Display Scale and layout set to 100% (Settings->System->Display).
  • Windows Display Make text bigger set to 100% (Settings->Ease of Access->Display).

You can use the Selector tool to do things such as:

  • Click a button in an application.
  • Send information to a web page or Windows application.
  • Copy information from a web or Windows application.

Drag the Selector tool from the Task Pane Area to create and manage actions within a specific task. onto the desired application target An element within an application Nintex RPA interacts with, such as a button, text field, or checkbox. and choose the appropriate action from the Build Pane Area to add new actions and edit existing actions..

Selector Tool
Selector Tool in UIA Targeting Override

The Selector Tool with UIA Targeting Override enabled allows you to choose the target element the botflow interacts with, such as a Windows File Explorer folder.

Ensure your machine's Windows Settings (Start Menu > Settings) are set as follows when using the Selector Tool:

  • Windows Display Scale and layout set to 100% (Settings->System->Display).
  • Windows Display Make text bigger set to 100% (Settings->Ease of Access->Display).

If you are not getting the desired results when using the Selector Tool to target a Windows application, select the UIA Targeting Override setting available under the Tools menu on the Menu Bar.

This setting uses Microsoft's User Interface Automation (UIA) and may provide better Nintex RPA support for your targeting requirements.

Selector Tool

Using the Selector Tool in UIA mode provides support for targeting nested directories in certain Windows applications.

Drag the Selector tool from the Task Pane Area to create and manage actions within a specific task. onto the desired application target An element within an application Nintex RPA interacts with, such as a button, text field, or checkbox. and choose the appropriate action from the Build Pane Area to add new actions and edit existing actions..

Selector Tool
Build Pane

The Build Pane displays after you select a targeted element in a Windows application.

The Build Pane lets you:

Selected target elements display in the Build Pane with a list of actions supported by the targeted item. The Build Pane also displays how long the item has been targeted.
Recent Target

The most recent target may be accessed by clicking the Recent Target button to the right of the Selector
Tool.

This is useful when creating Microsoft Excel, Emulator, and Web table targets allowing you to create new actions with existing targets.
Field or button Description
Search Options/Settings

Set the Search action options and settings:

  • Text: Type a search term in the field or use the Expression Builder () to build the action settings using variables or other token values.
  • Start at: Select the search starting point from the drop-down list.
    • First item: Starts the search from the first item in a list.
    • Current item: Starts the search from the currently selected item in a list.
  • Column (only for Reckon APS): If the target has more than one column, the Column field and drop-down list display so that you can select a column to search.
  • Ignore case: Ignores the search term letter case.
  • Ignore surrounding spaces: Ignores any beginning or ending spaces surrounding the search term.
  • Partial match: Returns partial matches based on the search term.
  • Use wildcards: Allows for the use of wild card characters, such as an asterisk (*) or question mark (?), in the search term.
  • Selection (only for Reckon APS): If the target has more than one column, the Selection field and drop-down list display so that you can select a column to search.
  • Interaction: Select the required interaction from the drop-down list:
    • None (available for both UIA Targeting Override and for Reckon APS): Has no interaction. This is useful if you want to search for an item and verify whether or not the item was found.
    • Click: Clicks the search results.
    • Double Click: Double-clicks the search results.
    • Get Value (available for both UIA Targeting Override and for Reckon APS): Retrieves a column value, such as a status. This is useful when the status of a Reckon APS column is needed.
  • Save to: Type a location to save the search results or use the Expression Builder () to build the action settings using variables or other token values.

    • Note: If the Search action fails and the Save to field is blank, the botflow stops.  If you saved the search results in a field or variable, that field or variable is updated with a False value and the botflow continues running.
Rules

Some actions have rules required to locate a target and vary based on the targeted application.

Rules of a targeted application element are configured and saved with the action. The rules are then used to locate the proper targeted element, such as an Microsoft Excel workbook.

To set the most common rules type:

  1. Click Rules from the Build Pane Area to add new actions and edit existing actions. or the Action Builder The Action Builder window provides access to the tools needed to create and modify Actions or instructions within a botflow. window.

    2. The Rules window displays the Rules available for the selected targeted application.

  2. Adjust the available rules as required.
  1. Click OK to save the Rules.
  • Some targets provide no rules.
  • Most targets provide at least the text of the target, such as 'Log in' for a log in screen action.
  • Some targets provide a name to identify the target (a unique developer-defined control name).
  • Some targets provide an ID (a unique identifier that locates an item based on how it appears in the target).
  • All targets use the following rules:
    • Ignore: Ignores the value of the selected rule.
    • Exact Match: Uses an exact match when considering the value of the rule.
    • Best Match: Uses a best match when considering the value of the rule and uses a variety of information to locate the target.
    • Left Match: Uses leading characters when considering the value of the rule based on a specified number of leading characters.
    • Right Match: Uses trailing characters when considering the value of the rule based on a specified number of trailing characters.
Preview All actions created using the Selector Tool include a Preview of the targeted element.
Details

When directed by Nintex Support, click Details from the Preview Panel of the Action Builder. If needed, Nintex Support will supply additional information.
Timing Settings

Some actions have timing settings and vary based on the targeted application. The timing settings of a targeted application element are configured and saved with the action. The timing settings are then used to control when the action starts.

  1. Click Wait up to 1 sec.
  1. Open the Time drop-down list and select the required setting:
    • Do not wait: Immediately attempts to execute the action and applies any error settings or rules.
    • Wait up to: Waits up to one (1) second to execute the action per any configured rules. The time specified is the wait time prior to continuing the botflow. In the event of an application being unavailable, the action adheres to the error settings. Time units include numeric settings for seconds, minutes, and hours.
    • Wait forever: Waits until the target application is in a ready state and applies any error settings or rules.
  1. Click X to close the drop-down list and save the setting.
Note

(Optional) Type a Note to document any special instructions or functionality.    
Run Switch

The Run Switch toggle controls how Nintex RPA runs an action when adding or editing an action in a botflow.

  • Run: To run the action automatically when you click OK, turn the toggle to Run.

  • Don't Run: If you do not want to run the action automatically when you click OK, turn the toggle to Don't Run.
OK/Cancel Click OK to save the action, or click Cancel to discard the action or any changes.