Subscribe

UiPath Task Capture

The Task Capture Guide

Capturing Settings

Capturing Settings

In Capturing tab from the Settings menu, there are multiple features that can be configured as follows:

  • Capturing hotkeys - This provides you with the ability to specify the hotkeys you want to use in order to ‘Pause/Resume’ or ‘Stop’ capturing process.

To change the value of hotkey click the input field and press the key combination you want to use.

If you would like to clear one value for the hotkey, the clear icon should be pressed.

📘

You cannot set the same key for both processes as this will return an error informing you that one of the hotkeys is already used. The hotkey should not contain just one of the Alt, Ctrl, Shift or Window keys. It can be a combination like Alt + C, Ctrl + P, etc.

After setting a custom hotkey, you can always revert to the default settings using the Restore Defaults option found on the lower right side of the screen.

Choosing the capturing mode

There are 2 options of capturing mode available:

  • Detailed - in this mode Task Capture automatically generates a screenshot for every action you perform - either it is a mouse click, double click, keyboard input or the hotkey. We recommend using this mode if your goal is to create a detailed automation skeleton for further automation in Studio.
  • High level - in this mode Task Capture automatically generates screenshots only for particular events instead of every action performed. We recommend using this mode if your goal is to create a clear and informative Process Definition Document focused on the specific key actions instead of every action performed.
    When choosing this mode, two other options become available:

Capture on mouse click only

When using this mode screenshots are generated for every mouse click. If you wish not to capture a specific mouse click, you can do this by setting the Do not capture when a predefined key is pressed feature.
Selecting this feature will let you select one of the keys available in the dropdown menu.

Capture with keyboard only

Choosing the keyboard only option allows you to configure the keys or keys combination you want to be used as capturing triggers. You can add new ones or delete the current ones.
Changing the current key can be done by pressing the available box element and pressing the desired key or key combination.
Adding a new hotkey can be done by pressing the + sign next to the box element.
Removing a hotkey can be done by pressing the - sign next to the box element.

📘

A maximum number of 5 hotkeys can be added.

During the capturing Task Capture gathers metadata about the actions you perform. The metadata includes the keyboard inputs and text under the clicked area which is recognized by in-built OCR. By default, this data is automatically passed into the Action Description field. You can disable this functionality by clicking the checkbox:

  • for Detailed mode - Place keyboard inputs and text under cursor in Action description
  • for High level mode:
    • Capture on mouse click only - Place keyboard inputs and text under cursor in Action description
    • Capture with keyboard only - Place keyboard inputs in Action description

The active capturing settings will also be displayed in the capturing panel before starting the capturing process.

  • When Detailed mode is selected the following message will be displayed:
    • Screenshots are automatically captured for each mouse click and keyboard input
  • When High level mode is selected the following message will be displayed:
    • Screenshots are automatically captured for specified hotkeys
    • Screenshots are automatically captured for each mouse click

Updated 9 months ago


Capturing Settings


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.