---
schema_version: "1"
id: ece50fe6090294cf2ed2efdf2e520f60d19589bc131752208c8010dbb7ee0c35
title: Mouse Actions
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/rpa-builder/6.6/toolbox-control-mouse-actions.md
canonical_url: https://docs.mulesoft.com/rpa-builder/6.6/toolbox-control-mouse-actions
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 85db19e2cf9ab83a9c57aee9994f922a73ee4138ecfce2d5638d706a93462feb
description: MuleSoft Documentation Site
release: "6.6"
latest: false
---
---
product: RPA Builder
version: 6.6
---

# Mouse Actions

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

The _Mouse Actions_ Action Step emulates mouse moves and clicks. Keyboard inputs can be used to
modify the mouse clicks.

You can capture mouse actions directly or create and/or edit them in the wizard. The speed of mouse
actions can also be defined.

Mouse moves can be created relative to a specific coordinate. This coordinate may be determined by a
previous _Action Step_ such as a image or text search, for example.

## Properties

**Miscellaneous**

**Relative To** (default: 0.0) Anchor point relative to which the mouse action is to be performed.
If no _Pin_ variable has been assigned, this is the top-left corner of the screen. This anchor point
can also be set as a placeholder ([Inbound Variables](#inbound-variables)).

Please note that the _Action Step_ that returns the coordinates must occur within the same
_Transaction_ in order to appear here as a possible _Pin_ variable.

**Mouse Click Timing**

**Mouse Click Down Delay** (ms, default: 200) Duration in milliseconds for which a mouse button is
held down.

**Mouse Click Up Delay** (ms, default: 10) Pause between two mouse clicks in milliseconds.

**Mouse speed** (0–100, default: 4) The mouse must be moved to perform a click. This setting is used
to set the speed of this move. High values produce a slower movement. The value 0 disables the
movement, meaning that the mouse jumps instantaneously.

## Inbound Variables

The property _Relative To_ can be linked to a _Pin_ variable of the type _Coordinate_. The mouse
action is then performed relative to this coordinate rather than the top-left corner of the screen.

## Outbound Variables

The _Group_ block possesses no outbound variables.

## Wizard

**Click position** Pair of X and Y pixel coordinates where the mouse action is to be performed.

**Mouse Action**The specific mouse action that is to be performed:

- **None** Mouse to hover over an element. No mouse button is pressed; the mouse stays still.

To capture a hover action, you must initially perform a mouse click at the relevant position. You
can then change this in the _Mouse Action Edit Window_ from _Left_ to _None_ under _Mouse Action_
(one of the properties).

- **Left** The left mouse button gets pressed.

- **Middle** The middle mouse button gets pressed.

- **Right** The right mouse button gets pressed.

- **LeftUp** (in the case of drag and drop) The left mouse button is released following a drag
  operation (moving the mouse with the button held down).

- **LeftDown** (in the case of drag and drop) The left mouse button is held down during a drag
  operation (moving the mouse with the button held down).

- **RightUp** The right mouse button is released following a drag operation (moving the mouse with
  the button held down).

- **RightDown** The right mouse button is held down during a drag operation (moving the mouse with
  the button held down).

- **WheelUp** The mouse wheel scrolls forwards/up.

- **WheelDown** The mouse wheel scrolls backwards/down.

**Click Count** (0-99) The number of clicks within the mouse action.

When capturing a double-click, please make sure that the mouse doesn’t slip during the process.

Check how the operation has been captured in the wizard. If _LeftDown_ and _LeftUp_ have been saved
there because the coordinates differ, please correct this as follows:

1.  Remove one line from the incorrectly captured double-click.

2.  Set the _Mouse Action_ property to _Left_ and _Counts_ to _2_.

**Modifier** Mouse actions can be modified by combinations of keys. This makes it possible, for
example, to mark related or individual elements using the mouse.

**Initial Action Delay \[ms\]** (default: 500 ms) You can enter a delay of between 0 and
999999999 ms between the cursor movement and the start of the actual mouse action. This would be
necessary, for example, if a clickable element only becomes visible when the mouse pointer is
hovered over it. Select the checkbox next to _Enable initial action delay_ to enable this.

**Enable initial action delay** enables the _Initial Action Delay_ property to be used.

_Other wizard functionality_

**Move mouse action up/down** moves the selected mouse action up or down in the table. The ID of the
action remains unchanged. Mouse actions are performed in the order in which they appear in the
table, regardless of their ID.

**Add mouse action** It is possible to add a mouse action that you configure solely using the wizard
rather than actually capturing it.

**Hide this window when capturing** (default: enabled) If this option is enabled, the _Mouse Action
Wizard_ window is hidden while mouse actions are captured.

**Hide main window when capturing** (default: enabled) If this option is enabled, the RPA Builder
window is hidden while mouse actions are captured.

**Relative To** (default: none) The position where the mouse action is to be performed can be
defined based on a previously executed Action Step (see also
[Inbound Variables](#inbound-variables)).

**Mouse click timing** (see [Properties](#properties)).

## Creating Mouse Actions Relative to an Anchor Point

If the coordinate relative to which the mouse action is to be performed is not yet known at the time
of designing the mouse action, a notification will appear. Click OK to confirm.

Then click the mouse to set an anchor point at the position where you expect the coordinate to be
and which the mouse action relates to.

Then capture the other mouse actions that relate to this.

At runtime, the anchor point will be replaced with the actual coordinate that is calculated at the
time.
