Mouse Sequence

The Record Mouse tool creates a Mouse Sequence that records your mouse activity as actions A feature that supplies the instructions in a botflow. and then adds the Mouse Sequence to a botflow A file that stores the actions and variables designed to automate tasks..

Using the Record Mouse tool to create a Mouse Sequence, you can record the following mouse actions:

Some examples of using the Mouse Sequence action are:

  • Automate multiple mouse clicks to perform a task, such as the clicks needed to select the content in a spreadsheet.
  • Expand a web page menu to select the required menu option.

  • Retrieve data from a system needed to interact with the botflow that retrieved the data from that system.

  • To add click actions to botflows using interactions such as If clauses.

Recommended browser and system settings

For best results when using the Mouse Recorder to add a Mouse Sequence action to a botflow, be sure to set your:

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

Add a Mouse Sequence action to a botflow

This example provides the steps necessary to add a Mouse Sequence to a botflow.

To add a Mouse Sequence to a botflow:

  1. Click on Tools in the Menu Bar Provides a variety of menus allowing you to use the commands in Nintex RPA. and select Record Mouse.

    2. The Recorder window displays.

  2. Use your mouse to perform mouse actions:
    • Click: Adds a Click action to the Mouse Sequence action.
    • Right-click: Add as Right Click action to the Mouse Sequence action.
    • Hover: Adds a Hover Mouse action to the Mouse Sequence action.

      • Note: The Stop Mouse to record hover message applies to the Hover mouse action.

  3. Click Stop on the Recorder window to complete the recording when all required mouse actions have been recorded.

    4. Click Pause to temporarily pause the recording and click Resume to continue with the recording.

    Click Cancel to cancel the recording.

The Mouse Sequence is added to the botflow and can be further adjusted.

Adjusting a Mouse Sequence action in a botflow

After the Mouse Sequence is added to the botflow it can be further adjusted.

To adjust a Mouse Sequence in a botflow:

  1. Navigate to the Mouse Sequence on the Build Pane.
  2. Click the Mouse Sequence edit (pencil) icon.

    3. The recorded Mouse Sequence displays.

  3. Select the required recorded mouse action:

    4. Tip: Click Test to test the recorded Mouse Sequence.

  4. If needed, adjust the Rule settings to modify how Nintex RPA finds the application target.
  5. If needed, adjust the Run Error Task settings and Timing settings to fine tune how the action runs.
  6. View the action Details settings.
  7. Optionally, add an action note.
  8. Click OK to save the Click, Right Click, or Hover Mouse action changes to the Mouse Sequence.
  9. Click Return to Task when all adjustments are complete to return to the botflow.
Field or button Description
Mouse Sequence options/settings Click

The Bypass the mouse for a faster click option increases the speed of your botflow if supported by the target application.

Note: Nintex RPA uses your mouse to click a target. Enabling the Bypass the mouse for a faster click option clicks the target without using the mouse. Applications responding to changes submitted by an actual mouse click will not support the Bypass the mouse for a faster click option. Perform the Click action in the botflow to confirm the expected actions are made by the Click action. Clicks resulting in a pop-up window are not supported.

If the selected target is a check box, you will have the option of choosing how the check box is checked.

  • Click to Check: Checks the check box if it is unchecked.
  • Click to Uncheck: Unchecks the checkbox if it is checked.
  • Click to Toggle: Checks the checkbox if it is unchecked or unchecks the checkbox if it is checked.

Hover Mouse

  • Hover (secs): Enter the time in seconds to hover the mouse over the target or use the Expression Builder to build the action settings using variables or other token values.
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.
Run error task
  1. Click Run error task.
  2. Open the On Error drop-down list and select the required setting:
    • Run error task: A botflow containing an error task automatically runs the error task in the event of an error. If the botflow does not contain an error task, the botflow stops in the event of an error.
    • Stop on error: The botflow stops in the event of an error.
    • Ignore errors: The action is skipped in the event of an error and the botflow attempts to execute the next action
  1. Click X to close the drop-down and save the setting.
Note

(Optional) Type a Note to document any special instructions or functionality.    
OK/Cancel Click OK to save the action or click Cancel to discard the action or any changes.