---
schema_version: "1"
id: 7692b47034714eafaf037889e008fababd33febed06a60c74dd30266c18045bd
title: User Interface
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/rpa-recorder/6.5/user-interface.md
canonical_url: https://docs.mulesoft.com/rpa-recorder/6.5/user-interface
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 73ab138e897bea59589bacc813f9f82e51122d81eb618304d9625f9b3d64dfe7
description: MuleSoft Documentation Site
release: "6.5"
latest: false
---
---
product: RPA Recorder
version: 6.5
---

# User Interface

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

Following are the descriptions of every section and element in the RPA Recorder UI.

## Home

The Home section contains the main controls of RPA recorder. If RPA recorder is started from RPA
Manager, the existing BPMN of the process also shows here.

![RPA Recorder Home screen](/mulesoft/current/en-us/rpa-recorder/6.5/_images/rpa-recorder-home.png)

## Recording

The **Recording Toolbar** appears on the screen when RPA Recorder starts recording a process and
contains the following buttons:

<table><colgroup><col> <col> <col> <col></colgroup><thead><tr><th>Icon</th><th>Name</th><th>Description</th><th>Hot Key</th></tr></thead><tbody><tr><td><p><span><img src="https://docs.mulesoft.com/rpa-recorder/6.5/_images/start-recording-icon.png" alt="Start Recording icon" width="20%" height="20%"></span></p></td><td><p>Start Recording</p></td><td><p>Starts a new recording session.</p></td><td><p><code>F8</code></p></td></tr><tr><td><p><span><img src="https://docs.mulesoft.com/rpa-recorder/6.5/_images/pause-recording-icon.png" alt="Pause Recording icon" width="20%" height="20%"></span></p></td><td><p>Pause Recording</p></td><td><p>Pauses the current recording session.</p></td><td><p><code>F8</code></p></td></tr><tr><td><p><span><img src="https://docs.mulesoft.com/rpa-recorder/6.5/_images/finish-recording-icon.png" alt="Start Recording icon" width="20%" height="20%"></span></p></td><td><p>Finish Recording Session</p></td><td><p>Finishes the current recording session and triggers the generation of <a href="https://docs.mulesoft.com/rpa-recorder/6.5/documents">Documents</a>.</p></td><td><p> — </p></td></tr><tr><td><p><span><img src="https://docs.mulesoft.com/rpa-recorder/6.5/_images/take-screenshot-icon.png" alt="Take Screenshot icon" width="20%" height="20%"></span></p></td><td><p>Take Screenshot</p></td><td><p>Opens the <a href="#define-screenshot">Define Screenshot</a> dialog.</p></td><td><p><code>F9</code></p></td></tr><tr><td><p><span><img src="https://docs.mulesoft.com/rpa-recorder/6.5/_images/image-based-mouse-clicks-icon-light.png" alt="Image-Based Mouse Clicks icon" width="20%" height="20%"></span></p></td><td><p>Image-based mouse clicks</p></td><td><p>Adds the <a href="#image-based-mouse-clicks">Image-Based Mouse Clicks</a> to the current recording.</p></td><td><p><code>F3</code></p></td></tr><tr><td><p><span><img src="https://docs.mulesoft.com/rpa-recorder/6.5/_images/add-comment-icon.png" alt="Add Comment icon" width="20%" height="20%"></span></p></td><td><p>Add Comment</p></td><td><p>Opens the <a href="#add-comment">Add Comment</a> dialog.</p></td><td><p><code>F11</code></p></td></tr><tr><td><p><span><img src="https://docs.mulesoft.com/rpa-recorder/6.5/_images/add-activity-icon.png" alt="Add Activity icon" width="20%" height="20%"></span></p></td><td><p>Add Activity</p></td><td><p>Opens the <a href="#add-activity">Add Activity</a> dialog.</p></td><td><p><code>F12</code></p></td></tr></tbody></table>

## Toast Notifications While Recording

When a recording state changes, a toast notification appears indicating current state. The
notification stays for two seconds and disappears automatically.

## Image-Based Mouse Clicks

Use image-based mouse clicks at any point during a recording session to record mouse clicks on a UI
element that otherwise cannot be recorded properly. This feature guides you through the capture of
image and mouse clicks. An image on the screen and mouse clicks must be captured, and the mouse
clicks are recorded relative to the captured image.

The feature also checks your display settings automatically while recording to ensure the feature
records correctly.

This feature will result in _Search Pattern_ and _Mouse Action_ action steps when the workflow is
generated in RPA Builder from the recording.

When using this feature:

- The Recording Toolbar is inactive.

- Keyboard events are not recorded.

### Recommended Display Settings

Apply the following recommended display settings to capture image-based mouse clicks:

- Single monitor.

  Although the image-based mouse clicks feature supports multiple monitors, the capturing is limited
  to the primary display for Bot tasks and the web page for Web tasks.

- Display scaling of 100%. If the scaling is different, then there is a risk that the captured image
  will not be found by the workflow generated in RPA Builder from the recording.

To check your display settings before recording, go to **Windows Settings > Display**. If your
**Scale and layout** or **Multiple displays** settings are different than what’s recommended when
recording, a warning message shows each time you record an image-based mouse click, and you must
confirm the message. If you change your Windows Settings, restart RPA Recorder to apply the changes.

### Using Image-Based Mouse Clicks

To capture image-based mouse clicks:

1.  Start a normal recording process.

2.  While recording, press **F3** to start recording image-based mouse clicks, or press the
    **Image-Based Mouse Clicks** icon on the Recording Toolbar. You can set the initial screen
    freeze delay from the toolbar by clicking the arrow next to the **Image-Based Mouse Clicks**
    icon.

3.  Capture an image by selecting it on the screen, and then accept or retake the image with or
    without setting a capture delay. Then, set a mouse click, which the Recorder marks with a red
    dot. Record additional mouse clicks, such as double-mouse clicks, if desired.

4.  Click **Finish**. This generates all relevant data for RPA Builder to create the _Search
    Pattern_ and _Mouse Action_ action steps for the recording.

The process documentation and PDF generated by the Recorder include the recording data. Once you
finish using image-based mouse clicks, you can continue with the normal recording process.

When recording image-based mouse clicks in a Web Task:

- Scrolling or zooming in the displayed web page or moving or resizing the browser window results in
  inaccurate relative clicks in the recording.

- Navigating to a different web page when capturing image-based mouse clicks, such as by clicking a
  link, can cause inaccuracies in the recording of the subsequent relative mouse clicks.

- The attribute selection panel is not enabled and cannot be expanded or collapsed. Once image-based
  mouse clicks recording is finished, the panel can be opened.

- The browser window cannot be minimized, and the address bar and buttons are not enabled in the
  browser window.

## Define Screenshot

Before you take a screenshot manually, the screen automatically freezes. You can select a method for
taking manual screenshots:

1.  Press `F9` while recording to open the Define Screenshot window.  
    ![Define Screenshot window](/mulesoft/current/en-us/rpa-recorder/6.5/_images/define-screenshot-window.png)

2.  Select a freezing delay (in seconds), or no delay, from the dropdown menu.  
    ![Select freezing delay](/mulesoft/current/en-us/rpa-recorder/6.5/_images/select-freeze-delay.png)

> [!NOTE] The timer delay mechanism takes effect regardless of the chosen screenshot method.

## Add Comment

You can add a comment as part of the recording to enrich the documentation with insight about a
specific step.

![Add Comment window](/mulesoft/current/en-us/rpa-recorder/6.5/_images/add-comment.png)

> [!NOTE] Pause the recording before adding a comment. If you open the Add Comment window while the
> recording is running, it pauses automatically.

## Add Activity

You can manually add an activity as part of the BPMN recording. Enter a name for the activity and
select its type.

![Add Activity window](/mulesoft/current/en-us/rpa-recorder/6.5/_images/add-activity.png)

Possible activity types are:

- Web Task

- Bot Task

- User Task

When you create a Web Task, you can choose to continue using the session of the last closed Web
Task.

For User Tasks, RPA Recorder does not save documentation. You must enter a description.

To continue recording, add a Bot Task.

> [!NOTE] Pause the recording before adding an activity or changing the creation mode of the
> activities. If you open the pop-up using the respective hot key while the recording is running,
> the recording automatically pauses.

## Web Recording Browser

Use the Web Recording Browser to record website navigation actions. It behaves as a regular web
browser and enables you to:

- Automatically identify elements of a website with which you interact and determine their XPath and
  attributes.

- Save your attribute selection of a web element to reuse it when recording the same web elements on
  a website.

- Record mouse hover positioning during web navigation.

> [!NOTE] Japanese keyboard input during Web recording is fully supported.

Adding a Web Task opens the Web Recording Browser. When you add more than one Web Task, you can
select **Continue with already existing web session** to display the last loaded page from the
previous Web Task and continue from that point. Otherwise, you can enter a URL in the address bar of
the browser, and it loads this URL when you press **Enter** or click the **Go** button
(![Go button](/mulesoft/current/en-us/rpa-recorder/6.5/_images/play-icon.png)).

![Web Recording Browser](/mulesoft/current/en-us/rpa-recorder/6.5/_images/web-recording-browser-blank.png)

### Select Web Elements

When you hover the cursor over a web element, a blue border frames the element so that you know the
area is clickable. The border also indicates you can record a mouse click on the element. After an
interaction with an element (such as a mouse click or key press on the keyboard), the element’s
XPath and available attributes show on the Attribute Selection panel.

To record the mouse hover event on a framed element, press `F2`.

![Select Web Element](/mulesoft/current/en-us/rpa-recorder/6.5/_images/web-recording-select-element.png)

By default, the Attribute Selection panel is hidden. Click on the right border of the Web Recording
Browser to extend or collapse it.

### Save Web Element Attributes

The Attribute Selection panel shows the default extracted XPath and all the attributes of the
selected web element. Select one or more attributes by checking the box next to them. After you
select an attribute, RPA Recorder adds the attribute and its value to the extracted XPath.

![Add Attribute to XPath](/mulesoft/current/en-us/rpa-recorder/6.5/_images/add-attribute.png)

You can save your attribute selection for a web element to use it for future recorded events by
checking **Save selection**. If you select the saved element while recording the same website later
on, the saved attribute displays as already selected in the attribute selection panel and appears as
added to the extracted XPath. If you don’t want to use the saved attributes for a given web element,
click the **Default** button (![Default button](/mulesoft/current/en-us/rpa-recorder/6.5/_images/default-icon.png)) to revert back to the
default extracted XPath for that web element.

### Save Mouse Hover

You can record your mouse hover positioning while using the Web Recording Browser. This is
particularly useful for capturing navigation through drop down menus.

To capture a mouse hover action during web recording, press `F2` on a web element. This capture is
indicated by a blue flashing box around the selected web element.

## RPA Recorder Configuration

You can configure RPA Recorder and set preferences.

The configuration section is divided into the following sections:

- [Settings](#settings)

- [Hot Keys](#hot-keys)

- [Log files](#log-files)

### Settings

![60%](/mulesoft/current/en-us/rpa-recorder/6.5/_images/settings.png)

Use the following settings to configure RPA Recorder:

- **Directory**

  The local folder for storing documents (BPMN, PDF and XES) and application logs.

- **Create Process Documentation (PDF)**

  Select this option to save a process documentation file as a PDF after the recording session
  stops.

- **Create Process Mining files (XES)**

  Select this option to generate a XES process file after the recording session stops.

- **Generate debug file (contains recorded events, window handles and system data)**

  Select this option to generate a debug file after the recording session stops.

- **Screenshot Settings**

  - **Image quality**:

    Select the quality of the screenshots on every mouse click. Available options are: **JPEG
    (compressed)** and **PNG (lossless)**.

  - **Take screenshot automatically**

    Select this option to automatically take a screenshot on every mouse click.

  - **When recording Bot Tasks auto-capture screenshots of**:

    Select the area to capture when RPA Recorder takes screenshots. Available options are: **Active
    application only** and **Full screen**.

### Hot Keys

This section displays information about the specific hot keys that can be used, and their
description. Hot keys cannot be customized.

You can activate or deactivate the hot keys function by checking or unchecking the **Activate usage
of hot keys** box. If activated, the hot keys invoke the corresponding action. If deactivated, the
hot keys cannot control the recorder, and any hot key presses during a recording are recorded as
normal key strokes.

The hot keys function is activated by default.

![The Hot Keys configuration window](/mulesoft/current/en-us/rpa-recorder/6.5/_images/hotkeys.png)

### Log files

This section provides access to RPA Recorder log files and log directory.

Click **Open Log File** to open the latest log file. Click **Open Log Directory** to open the folder
containing all RPA Recorder logs in your local computer.

![Log Files Menu](/mulesoft/current/en-us/rpa-recorder/6.5/_images/log-files.png)

## About Screen

The about screen contains general information about RPA Recorder:

- Version number

- Copyright information

## See Also

- [Process Recording Editor](https://docs.mulesoft.com/rpa-recorder/6.5/process-rec-editor)

- [Documents](https://docs.mulesoft.com/rpa-recorder/6.5/documents)