Documenting Mode

Please note: We will shut down the Helpdesk soon. Please update your releases to Hyland RPA 22.2. To view the latest documentation for Hyland RPA 22.2 release visit Hyland Docs.

When starting a new project, you are redirected to the documenting mode in order to start tracking your process steps in a live environment (You can also access the documenting mode from the editing mode).

Documenting mode contains an action bar attached to the upper right corner as well as an action list with your documented process steps.

Action bar

In Frictionless mode, the action bar is displayed collapsed by default. To expand the action bar and access the action type toggles, click the arrow button on the right.


In Impermeable mode, the action bar is always expanded.



  1. Handle: By dragging the handle of the action bar, you can rearrange the position of the Hyland RPA Analyst (former AM Muse). This will be helpful when the bar is hiding any elements you need.
  2. Start/Pause: Here you can start and pause live tracking of any elements, buttons, text fields, etc. that you are currently interacting with. It is easy to recognize that the Smart Indicator is running as all of the elements you hover above with your mouse are marked with colored rectangles.
  3. Done: Click Done ✔ and you will be redirected to editing mode so that you can adapt your documented steps and actions.
  4. AUTO. This text indicates that Hyland RPA Analyst runs in frictionless mode.
    The AUTO toggle switches for a few seconds to display the performed action.
  5. Action Type Toggles: These toggles have two primary purposes, and you can only have one toggle active at a time. Whenever you activate another toggle, the first toggle will be automatically deactivated.

A. The first purpose of an action toggle is to determine the type of action to create for a yet to be defined live-system interaction. When no action is in focus in the lower action list, the active action toggle indicates the type of action to be created during the next element interaction.

B. The second purpose of an action toggle is to change the action type for an existing action present in the lower action list. To change the action, click in the action bar, then edit the action type.

There are five action toggles that are available:

  • Left-click, used whenever a left-click takes place in the system.
  • Double-click, to be used whenever a double left click takes place in the system.
  • Right-click, used whenever a right-click takes place in the system.
  • Write text, used when you type in or write text at a certain location.
  • Read-out text, used whenever you are copying or reading, comparing, or checking the text to make a conclusion or insert the text somewhere else.

The following table displays the differences between Frictionless and Impermeable mode:




Keys and Hotkeys are recorded



Click actions are detected automatically



Click actions are executed



Write actions are detected automatically



Get Text actions are recorded automatically



Please note! It is vital to not just capture the concrete manual interactions like pressing a button on the mouse or the keyboard, but also to mark text or information that you read or draw conclusions.


Action list


Generally, the action list displays all the actions that are/were located in the current window. When cleared and filled with new actions, do not worry, the items in the list have not been deleted! The Hyland RPA Analyst simply detected a window change and took a screenshot to locate new actions on the new screen.

  1. Window Title: Once you indicate your first element on the screen, the Hyland RPA Analyst automatically detects its corresponding application and window. Here, the window title is displayed but you can also simply adapt and edit it. You can also expand and collapse the action list by clicking on the triangle/arrow button next to the window button.
  2. Add new window button: If the window change criteria do not meet your requirements at one point and you want to trigger a manual window change yourself, just click this button and the action list will be cleared. Afterward, the next action will be automatically placed on a new window. This is especially helpful while documenting e.g. terminal applications.
  3. Action: Each tracked action is displayed in the list with an icon indicative of its action type and a description that is also subject to change – you can simply click on the description to edit. The hints offer you indications of how to start and what to fill in. Clicking on the three dots gives you the ability to delete an action or change all action properties in a separate popup. You can change the type of an action as mentioned above: focus the action by clicking on it and indicate the intended action type in the action bar toggles.
  4. Send Key/Hotkey Button: The last point of the action list is the button that allows you to add keys or hotkeys. These are not visible on screen as elements, so you cannot click on them, which is why you always have the opportunity to add them to your process at this point. Clicking on the button expands a small menu where you can choose between a key and hotkey to add. Afterward, these will be added to the list just as any other action before, meaning you can edit their description and properties. Window change criteria are also applied to key actions. New windows, therefore, can also be triggered by key actions if enough pixels or the window title changed. After inserting a key action, their Property Pop-up will be opened automatically.

Please note: The window change criteria for key actions are applied to the window your mouse is on. Therefore you should make sure that you press the Add key button on the right screen - you might have to move the Hyland RPA Analyst to do so.

Was this article helpful?
0 out of 0 found this helpful