# mulesoft RPA Recorder - Full Documentation --- product: RPA Recorder version: 6.5 --- # Documents > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Recorder creates three document types at the end of a recording session: - BPMN - PDF - XES RPA Recorder stores all created documents in the directory you specify in the [settings](https://docs.mulesoft.com/rpa-recorder/6.5/user-interface#settings). RPA Recorder groups recordings by date and tags them with the timestamp of the recording session. ## BPMN The BPMN is a graphical representation of a business process model. It is a crucial element of an automation project in the Mulesoft RPA platform. It also includes the recorded documentation, which can be viewed in RPA Manager. You can open BPMN with any workflow and decision automation platform that supports the BPMN v2.0 standard, specified by the Object Management Group. ## PDF The created PDF is an additional documentation of a recording and contains the following information: - Recording time - Process name (if opened from a web client, otherwise default name **New Process** is assigned) - BPMN graphic - A table with the following information: - Element name: Start Event, Activity (Service Task), End Event - Application window title - Action type: System, mouse, keyboard, clipboard, window state, variable, comment, screenshot - Screenshots: Either screenshots taken on mouse clicks or manual screenshots - Info: Detailed information based upon the action type The table in the PDF displays a gray background row whenever a new activity is created. Subsequent rows have a white background to indicate that the sub-elements are part of this activity. ## XES XES is the standard format for process mining. You can open the created XES file with any process mining tool that supports the XES 1.0 format. XES is used for further process mining purposes. ## Logs RPA Recorder creates and stores multiple log files in the **Logs** subdirectory, within the directory you define in the [settings](https://docs.mulesoft.com/rpa-recorder/6.5/user-interface#settings). If the RPA Recorder directory does not exist, it is automatically created together with a log file. The log file contains valuable information about the recording, but also warnings and errors that may have happened. If any unexpected behavior arises, you can provide feedback to MuleSoft by sending the log file. == See Also - [User Interface](https://docs.mulesoft.com/rpa-recorder/6.5/user-interface#settings) --- product: RPA Recorder version: 6.6 is-latest-version: true --- # Documents > For the full documentation index, see: https://docs.mulesoft.com/llms.txt RPA Recorder creates three document types at the end of a recording session: - BPMN - PDF - XES RPA Recorder stores all created documents in the directory you specify in the [settings](https://docs.mulesoft.com/rpa-recorder/latest/user-interface#settings). RPA Recorder groups recordings by date and tags them with the timestamp of the recording session. ## BPMN The BPMN is a graphical representation of a business process model. It is a crucial element of an automation project in the Mulesoft RPA platform. It also includes the recorded documentation, which can be viewed in RPA Manager. You can open BPMN with any workflow and decision automation platform that supports the BPMN v2.0 standard, specified by the Object Management Group. ## PDF The created PDF is an additional documentation of a recording and contains the following information: - Recording time - Process name (if opened from a web client, otherwise default name **New Process** is assigned) - BPMN graphic - A table with the following information: - Element name: Start Event, Activity (Service Task), End Event - Application window title - Action type: System, mouse, keyboard, clipboard, window state, variable, comment, screenshot - Screenshots: Either screenshots taken on mouse clicks or manual screenshots - Info: Detailed information based upon the action type The table in the PDF displays a gray background row whenever a new activity is created. Subsequent rows have a white background to indicate that the sub-elements are part of this activity. ## XES XES is the standard format for process mining. You can open the created XES file with any process mining tool that supports the XES 1.0 format. XES is used for further process mining purposes. ## Logs RPA Recorder creates and stores multiple log files in the **Logs** subdirectory, within the directory you define in the [settings](https://docs.mulesoft.com/rpa-recorder/latest/user-interface#settings). If the RPA Recorder directory does not exist, it is automatically created together with a log file. The log file contains valuable information about the recording, but also warnings and errors that may have happened. If any unexpected behavior arises, you can provide feedback to MuleSoft by sending the log file. == See Also - [User Interface](https://docs.mulesoft.com/rpa-recorder/latest/user-interface#settings) --- product: RPA Recorder version: 6.5 --- # Hardware and Software Requirements > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Before using RPA Recorder, ensure that your environment meets the minimum hardware and software requirements. ## Hardware Requirements
MinimumRecommended

Dual-core 2 GHz CPU (MMX/SSE compatible)

Dual-core 3 GHz CPU (MMX/SSE compatible)

8 GB of RAM

16 GB of RAM

5 GB of disk space

10 GB (SSD) of disk space

## Software Requirements
SoftwareRequired version

Microsoft .NET Framework

4.8

Operating System

Any of the following:

  • Windows 10 (64 bit)

    • Professional

    • Professional for Workstations

    • Enterprise

      No support for Enterprise multi-session (Windows 10 Enterprise for Virtual Desktops).

    • Enterprise LTSC

  • Windows 11

    • Professional

    • Professional for Workstations

    • Enterprise

      No support for Enterprise multi-session (Windows 11 Enterprise for Virtual Desktops).

  • Windows Server 2019

  • Windows Server 2022

### Recommended System Settings - Display resolution: Full HD 1080p (1920 × 1080) or higher ### File System Permission Requirements RPA Recorder needs full write access to folders that are critical to its functioning. To avoid issues during the setup process and subsequent RPA Recorder executions, ensure that: - You install RPA Recorder as an administrator If you don’t run the setup file as an administrator, the installation process might not finish successfully. If this happens, ensure you reinstall RPA Recorder by running the setup file as an administrator. - RPA Recorder has full write access to the following folders and any subfolders and files inside them: - `C:\Program Files\MuleSoft\RPARecorder` - `C:\RPARecorder` - Your environment is not blocking the execution of any RPA process The operating system can block the execution of certain files. Ensure that all executable (`.exe`) files inside the RPA Recorder home directory and its subfolders are allowed to run. ## Compatibility
ApplicationVersion

RPA Builder

6.4.0 and later

RPA Bot

1.4.0 and later

## See Also - [Install and Start RPA Recorder](https://docs.mulesoft.com/rpa-recorder/6.5/getting-started) --- product: RPA Recorder version: 6.6 is-latest-version: true --- # Hardware and Software Requirements > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Before using RPA Recorder, ensure that your environment meets the minimum hardware and software requirements. ## Hardware Requirements
MinimumRecommended

Dual-core 2 GHz CPU (MMX/SSE compatible)

Dual-core 3 GHz CPU (MMX/SSE compatible)

8 GB of RAM

16 GB of RAM

5 GB of disk space

10 GB (SSD) of disk space

## Software Requirements
SoftwareRequired version

Microsoft .NET Framework

4.8

Operating System

Any of the following:

  • Windows 10 (64 bit)

    • Professional

    • Professional for Workstations

    • Enterprise

      No support for Enterprise multi-session (Windows 10 Enterprise for Virtual Desktops).

    • Enterprise LTSC

  • Windows 11

    • Professional

    • Professional for Workstations

    • Enterprise

      No support for Enterprise multi-session (Windows 11 Enterprise for Virtual Desktops).

  • Windows Server 2019

  • Windows Server 2022

### Recommended System Settings - Display resolution: Full HD 1080p (1920 × 1080) or higher ### File System Permission Requirements RPA Recorder needs full write access to folders that are critical to its functioning. To avoid issues during the setup process and subsequent RPA Recorder executions, ensure that: - You install RPA Recorder as an administrator If you don’t run the setup file as an administrator, the installation process might not finish successfully. If this happens, ensure you reinstall RPA Recorder by running the setup file as an administrator. - RPA Recorder has full write access to the following folders and any subfolders and files inside them: - `C:\Program Files\MuleSoft\RPARecorder` - `C:\RPARecorder` - Your environment is not blocking the execution of any RPA process The operating system can block the execution of certain files. Ensure that all executable (`.exe`) files inside the RPA Recorder home directory and its subfolders are allowed to run. ## Compatibility
ApplicationVersion

RPA Builder

6.6.0 and later

RPA Bot

1.4.0 and later

## See Also - [Install and Start RPA Recorder](https://docs.mulesoft.com/rpa-recorder/latest/getting-started) --- product: RPA Recorder version: 6.5 --- # Installing and Starting RPA Recorder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt You can install RPA Recorder by manually downloading and running the installer or by starting the recorder from RPA Manager, which provides a link to download and install RPA Recorder. ## Install RPA Recorder Download the latest RPA Recorder installer from the **Home** page of RPA Manager. Optionally, you can install RPA Recorder from the message prompt that shows in RPA Manager when you start the recording function. ![Download RPA Recorder message](/mulesoft/current/en-us/rpa-recorder/6.5/_images/download-rpa-recorder-message.png) > [!NOTE] Enable pop-ups from RPA Manager before downloading RPA Recorder. ## Start RPA Recorder You can start RPA Recorder as a _standalone_ application or from _RPA Manager_. - **Standalone** Start RPA Recorder by opening the application from the **Start** menu or by opening the application’s executable file. When you start RPA Recorder as a standalone application: - RPA Recorder does not request RPA Manager credentials to start recordings. - You cannot upload recordings to RPA Manager, you can only save them locally. - **RPA Manager** To start RPA Recorder, click the **Record BPMN** icon (![Record BPMN icon](/mulesoft/current/en-us/rpa-recorder/6.5/_images/record-bpmn-icon.png)) in RPA Manager. When you start RPA Recorder from RPA Manager: - RPA Recorder requires RPA Manager credentials to log in and start recordings. - You can upload recordings to RPA Manager. ### Log in to RPA Recorder with Anypoint If your organization supports Anypoint Identity Access Management (IAM), then follow these steps to log in: 1. Click Record BPMN (![Record BPMN icon](/mulesoft/current/en-us/rpa-recorder/6.5/_images/record-bpmn-icon.png)) in RPA Manage to open RPA Recorder. 2. Provide your MuleSoft Anypoint login credentials for user authentication. ![RPA Recorder Anypoint Login Screen](/mulesoft/current/en-us/rpa-recorder/6.5/_images/anypoint-login.png) To log out of RPA Recorder, click the **Logout** icon (![Logout icon](/mulesoft/current/en-us/rpa-recorder/6.5/_images/logout-icon.png)). ### Connect to Anypoint Platform Using an External Identity Provider To connect to Anypoint using Single Sign On (SSO) credentials from an external identity provider: 1. In the Anypoint login screen, click **Use custom domain**. 2. Specify your organization domain and click **Continue**. 3. Specify **Username** and **Password** and click **Sign In**. ### Log in to RPA Recorder (Legacy) If your organization does not support Anypoint IAM, then follow these steps to log in: 1. Click Record BPMN (![Record BPMN icon](/mulesoft/current/en-us/rpa-recorder/6.5/_images/record-bpmn-icon.png)) in RPA Manage to open RPA Recorder. 2. Provide your login credentials for user authentication. ![RPA Recorder Legacy Login Screen](/mulesoft/current/en-us/rpa-recorder/6.5/_images/rpa-recorder-login.png) To log out of RPA Recorder, click the **Logout** icon (![Logout icon](/mulesoft/current/en-us/rpa-recorder/6.5/_images/logout-icon.png)). ## Considerations for Process Recording Consider the following scenarios when recording processes with RPA Recorder to ensure the captured events are as accurate and robust as possible. - **Recording applications started as an administrator** - To capture a process where you need to run an application as an administrator, you must run RPA Recorder as an administrator. Otherwise, RPA Recorder cannot capture the events from the application. - Because you cannot start RPA Recorder as an administrator from RPA Manager, this process works only when you start RPA Recorder in standalone mode by right-clicking the executable file or the shortcut and selecting **Run as Administrator**. - **Record processes using a single screen** - If your setup uses multiple monitors, use only the screen where RPA Recorder shows the **Recording Toolbar** to capture the entire process. - To prevent issues during the recording, avoid opening applications on a different screen or moving windows between screens. - **Do not change system settings during a recording** - To prevent inaccuracies in the captured events, do not change any system settings (specially display settings such as screen resolution or scaling) while recording a process. ## See Also - [User Interface](https://docs.mulesoft.com/rpa-recorder/6.5/user-interface#settings) --- product: RPA Recorder version: 6.6 is-latest-version: true --- # Installing and Starting RPA Recorder > For the full documentation index, see: https://docs.mulesoft.com/llms.txt You can install RPA Recorder by manually downloading and running the installer or by starting the recorder from RPA Manager, which provides a link to download and install RPA Recorder. ## Install RPA Recorder Download the latest RPA Recorder installer from the **Home** page of RPA Manager. Optionally, you can install RPA Recorder from the message prompt that shows in RPA Manager when you start the recording function. ![Download RPA Recorder message](/mulesoft/current/en-us/rpa-recorder/latest/_images/download-rpa-recorder-message.png) > [!NOTE] Enable pop-ups from RPA Manager before downloading RPA Recorder. ## Start RPA Recorder You can start RPA Recorder as a _standalone_ application, from _RPA Manager_ or _RPA Builder_. ### Standalone Start RPA Recorder by opening the application from the **Start** menu or by opening the application’s executable file. When you start RPA Recorder as a standalone application: - RPA Recorder does not request RPA Manager credentials to start recordings. - You cannot upload recordings to RPA Manager, you can only save them locally. ### RPA Manager To start RPA Recorder, click the **Record BPMN** icon (![Record BPMN icon](/mulesoft/current/en-us/rpa-recorder/latest/_images/record-bpmn-icon.png)) in RPA Manager. When you start RPA Recorder from RPA Manager: - RPA Recorder requires RPA Manager credentials to log in and start recordings. - You can upload recordings to RPA Manager. - You can update to the latest RPA Recorder version by clicking **Update Available** on the RPA Recorder home page. The option shows automatically when you log in if RPA Recorder detects that a later version is available. ![Update to latest RPA Recorder version](/mulesoft/current/en-us/rpa-recorder/latest/_images/update-available.png) ### RPA Builder To start RPA Recorder, click **Record** from the [Workbench Toolbar](https://docs.mulesoft.com/rpa-builder/latest/workbench-toolbar-overview) or double-click the name of an [App Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-app-automation-app-session) or [Web Session](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation) in the Activity Workflow. When you start RPA Recorder from RPA Builder: - RPA Recorder does not request RPA Manager credentials to start recordings. - RPA Builder automatically generates the workflow or single App or Web Session. ## Log in to RPA Recorder When you start RPA Recorder from RPA Manager, you are requested for either Anypoint or RPA Manager login credentials, depending on the status of your organization. If you don’t see the login screen, ensure RPA Recorder is [installed](#install) in your computer. ### Log in With Anypoint Platform Credentials (IAM) If your organization supports Anypoint Identity Access Management, provide your MuleSoft Anypoint login credentials for user authentication. ![RPA Recorder Anypoint Login Screen](/mulesoft/current/en-us/rpa-recorder/latest/_images/anypoint-login-general.png) #### Connect to Anypoint Platform Using an External Identity Provider To connect to Anypoint using Single Sign On (SSO) credentials from an external identity provider: 1. In the Anypoint login screen, click **Use custom domain**. 2. Specify your organization domain and click **Continue**. 3. Specify **Username** and **Password** and click **Sign In**. ### Log in With RPA Manager Credentials (Legacy) If your organization does not support Anypoint IAM, provide your RPA Manager login credentials for user authentication. ![RPA Recorder Legacy Login Screen](/mulesoft/current/en-us/rpa-recorder/latest/_images/rpa-recorder-login.png) ### Log out from RPA Recorder To log out of RPA Recorder, click the **Logout** icon (![Logout icon](/mulesoft/current/en-us/rpa-recorder/latest/_images/logout-icon.png)). ## Considerations for Process Recording Consider the following scenarios when recording processes with RPA Recorder to ensure the captured events are as accurate and robust as possible. - **Recording applications started as an administrator** - To capture a process where you need to run an application as an administrator, you must run RPA Recorder as an administrator. Otherwise, RPA Recorder cannot capture the events from the application. - Because you cannot start RPA Recorder as an administrator from RPA Manager, this process works only when you start RPA Recorder in standalone mode by right-clicking the executable file or the shortcut and selecting **Run as Administrator**. - **Record processes using a single screen** - If your setup uses multiple monitors, use only the screen where RPA Recorder shows the **Recording Toolbar** to capture the entire process. - To prevent issues during the recording, avoid opening applications on a different screen or moving windows between screens. - **Do not change system settings during a recording** - To prevent inaccuracies in the captured events, do not change any system settings (specially display settings such as screen resolution or scaling) while recording a process. ## See Also - [User Interface](https://docs.mulesoft.com/rpa-recorder/latest/user-interface#settings) - [**Record** option in RPA Builder](https://docs.mulesoft.com/rpa-builder/latest/workbench-toolbar-overview) - [App Session in RPA Builder](https://docs.mulesoft.com/rpa-builder/latest/toolbox-app-automation-app-session) - [Web Session in RPA Builder](https://docs.mulesoft.com/rpa-builder/latest/toolbox-web-automation) --- product: RPA Recorder version: 6.5 --- # Process Recording Editor > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you start the recorder from RPA Manager, you can view the current process BPMN and all new recorded BPMNs by selecting them from the drop-down menu. To open the Process Recording Editor, select a process and click **Edit, Merge and Upload Recordings** (![Edit, Merge and Upload Recordings button](/mulesoft/current/en-us/rpa-recorder/6.5/_images/edit-process-button.png)). ![RPA Recorder Home screen](/mulesoft/current/en-us/rpa-recorder/6.5/_images/rpa-recorder-home.png) ## Process Recording Editor Panels The Process Recording Editor consists of two main panels: - **Automation** This panel provides a fully integrated BPMN modeler to edit the BPMN of the recording. The previously selected Recording session is automatically loaded into the modeler to start editing. - **Documentation** This panel shows the recorded documentation of each activity. Select an element in the **Automation** panel to view its recorded documentation. The Documentation panel provides a fully integrated text editor. To edit the documentation of any activity, click **Edit**. After editing the documentation, click **Save** to apply the changes. ![Process Recording Editor Panels](/mulesoft/current/en-us/rpa-recorder/6.5/_images/recorder-editor-panels.png) ## Load BPMNs for Edit and Merge To load additional BPMNs into the BPMN modeler: 1. Click **Load File** (![Load File button](/mulesoft/current/en-us/rpa-recorder/6.5/_images/load-file-button.png)). 2. Select the BPMN or BPMNs you want to add and click **Open**. All recordings are stored in a separate folder per process and recording date. 3. A dialog asks if you want to merge the selected BPMN into the present BPMN in the modeler, or if you want to create a new BPMN with the selected one. ![Merge or create new BPMN dialog box](/mulesoft/current/en-us/rpa-recorder/6.5/_images/merge-or-create-bpmn.png) 4. To merge the selected BPMN into the existing BPMN, click **Yes** . After the import, you can edit and rearrange the new BPMN via drag and drop. ## Save Edited BPMNs To save the edited and merged BPMN locally: 1. Click **Save** (![Save changes button](/mulesoft/current/en-us/rpa-recorder/6.5/_images/save-icon.png)). 2. Select a directory in the **Save As** dialog and specify a file name if different from the auto-generated file name. 3. Click **Save**. ## Upload BPMN to RPA Manager After merging and editing the BPMN and documentation, click the **Upload to RPA Manager** icon (![Upload to RPA Manager icon](/mulesoft/current/en-us/rpa-recorder/6.5/_images/upload-to-server-icon.png)) to upload the new process BMPN. A message opens confirming that the upload is completed. To close the Process Recording Editor and RPA Recorder, click **Close** (![Close icon](/mulesoft/current/en-us/rpa-recorder/6.5/_images/close-icon.png)) in the top right corner. ## See Also - [User Interface](https://docs.mulesoft.com/rpa-recorder/6.5/user-interface) --- product: RPA Recorder version: 6.6 is-latest-version: true --- # Process Recording Editor > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you start the recorder from RPA Manager, you can view the current process BPMN and all new recorded BPMNs by selecting them from the drop-down menu. To open the Process Recording Editor, select a process and click **Edit, Merge and Upload Recordings** (![Edit, Merge and Upload Recordings button](/mulesoft/current/en-us/rpa-recorder/latest/_images/edit-process-button.png)). ![RPA Recorder Home screen](/mulesoft/current/en-us/rpa-recorder/latest/_images/rpa-recorder-home.png) ## Process Recording Editor Panels The Process Recording Editor consists of two main panels: - **Automation** This panel provides a fully integrated BPMN modeler to edit the BPMN of the recording. The previously selected Recording session is automatically loaded into the modeler to start editing. - **Documentation** This panel shows the recorded documentation of each activity. Select an element in the **Automation** panel to view its recorded documentation and show the **Edit** option. The Documentation panel provides a fully integrated text editor. To edit the documentation of any activity, click **Edit**. After editing the documentation, click **Done** to apply the changes. ![Process Recording Editor Panels](/mulesoft/current/en-us/rpa-recorder/latest/_images/recorder-editor-panels.png) ## Load BPMNs for Edit and Merge To load additional BPMNs into the BPMN modeler: 1. Click **Load File** (![Load File button](/mulesoft/current/en-us/rpa-recorder/latest/_images/load-file-button.png)). 2. Select the BPMN or BPMNs you want to add and click **Open**. All recordings are stored in a separate folder per process and recording date. 3. A dialog asks if you want to merge the selected BPMN into the present BPMN in the modeler, or if you want to create a new BPMN with the selected one. ![Merge or create new BPMN dialog box](/mulesoft/current/en-us/rpa-recorder/latest/_images/merge-or-create-bpmn.png) 4. To merge the selected BPMN into the existing BPMN, click **Yes** . After the import, you can edit and rearrange the new BPMN via drag and drop. ## Save Edited BPMNs To save the edited and merged BPMN locally: 1. Click **Save** (![Save changes button](/mulesoft/current/en-us/rpa-recorder/latest/_images/save-icon.png)). 2. Select a directory in the **Save As** dialog and specify a file name if different from the auto-generated file name. 3. Click **Save**. ## Upload BPMN to RPA Manager After merging and editing the BPMN and documentation, click the **Upload to RPA Manager** icon (![Upload to RPA Manager icon](/mulesoft/current/en-us/rpa-recorder/latest/_images/upload-to-server-icon.png)) to upload the new process BMPN. A message opens confirming that the upload is completed. To close the Process Recording Editor and RPA Recorder, click **Close** (![Close icon](/mulesoft/current/en-us/rpa-recorder/latest/_images/close-icon.png)). ## See Also - [User Interface](https://docs.mulesoft.com/rpa-recorder/latest/user-interface) --- product: RPA Recorder version: 6.5 --- # RPA Recorder Overview > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use RPA Recorder to record business processes. RPA Recorder enables you to: - Record actions like mouse clicks, keyboard inputs on your system or on a web browser, and used applications - Add comments and variable information during the recording - Take screenshots automatically per mouse click, or manually at any time You can start RPA Recorder either directly from RPA Manager in the design phase, or as a standalone tool without server connection. - If started from RPA Manager, RPA Recorder automatically uploads the recorded BPMN process model with the documentation into the server and creates a local PDF with the same information after the recording is finished. - If used without server connection, RPA Recorder creates the BPMN and stores it locally. In either case, RPA Recorder also creates an XES file for further processing in process mining tools. ## See Also - [Hardware and Software Requirements](https://docs.mulesoft.com/rpa-recorder/6.5/hardware-software-requirements) --- product: RPA Recorder version: 6.6 is-latest-version: true --- # RPA Recorder Overview > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Use RPA Recorder to record business processes. RPA Recorder enables you to: - Record actions like mouse clicks, keyboard inputs on your system or on a web browser, and used applications - Add comments and variable information during the recording - Take screenshots automatically per mouse click, or manually at any time You can start RPA Recorder directly from RPA Manager in the design phase, as a standalone tool without server connection, or from RPA Builder. - If started from RPA Manager, RPA Recorder automatically uploads the recorded BPMN process model with the documentation into the server and creates a local PDF with the same information after the recording is finished. - If used without server connection, RPA Recorder creates the BPMN and stores it locally. - If started from RPA Builder, the workflow or its part is generated automatically. RPA Builder creates a local PDF with the same information after the recording is finished. With all start methods, RPA Recorder also creates an XES file for further processing in process mining tools. ## See Also - [Hardware and Software Requirements](https://docs.mulesoft.com/rpa-recorder/latest/hardware-software-requirements) --- 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:
IconNameDescriptionHot Key

Start Recording icon

Start Recording

Starts a new recording session.

F8

Pause Recording icon

Pause Recording

Pauses the current recording session.

F8

Start Recording icon

Finish Recording Session

Finishes the current recording session and triggers the generation of Documents.

 — 

Take Screenshot icon

Take Screenshot

Opens the Define Screenshot dialog.

F9

Image-Based Mouse Clicks icon

Image-based mouse clicks

Adds the Image-Based Mouse Clicks to the current recording.

F3

Add Comment icon

Add Comment

Opens the Add Comment dialog.

F11

Add Activity icon

Add Activity

Opens the Add Activity dialog.

F12

## 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) --- product: RPA Recorder version: 6.6 is-latest-version: true --- # 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/latest/_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:
IconNameDescriptionHot Key

Start Recording icon

Start Recording

Starts a new recording session.

F8

Pause Recording icon

Pause Recording

Pauses the current recording session.

F8

Start Recording icon

Finish Recording Session

Finishes the current recording session and triggers the generation of Documents.

 — 

Take Screenshot icon

Take Screenshot

Opens the Define Screenshot dialog.

F9

Image-Based Mouse Clicks icon

Image-based mouse clicks

Adds the Image-Based Mouse Clicks to the current recording.

F3

Add Comment icon

Add Comment

Opens the Add Comment dialog.

F11

Add Activity icon

Add Activity

Opens the Add Activity dialog.

F12

## 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/latest/_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/latest/_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/latest/_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/latest/_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/latest/_images/play-icon.png)). ![Web Recording Browser](/mulesoft/current/en-us/rpa-recorder/latest/_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/latest/_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/latest/_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/latest/_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/latest/_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. - **Enable element highlighting during Bot Task recordings.** Select this option to add a blue border around elements that are clicked while recording a Bot Task. - **Image quality**: Select the quality of the screenshots on every mouse click. Available options are: **JPEG (compressed)** and **PNG (lossless)**. - **Screenshot Settings** - **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/latest/_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/latest/_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/latest/process-rec-editor) - [Documents](https://docs.mulesoft.com/rpa-recorder/latest/documents)