UiPath Task Capture

The Task Capture Guide


Installation & License

There are different ways to get the installer file:

  • Fill in the form from the dedicated page and get the download link sent to you by email.
  • In case you already use Automation Hub, download Task Capture from the following locations:
    • Idea Score page displayed after submitting the idea;
    • Documentation page of the idea Automation Profile
For details please check the Receiving the Installer file page from the User Guide.

The available license types are different, depending on the way Task Capture is launched:

  • Launched as a desktop tool:
    • Continue Free
    • Activate Stand-Alone License
  • Launched from Automation Hub
  • Launched from UiPath Task Mining
  • Launched from Test Manager
For details please check the Licensing page from the User Guide.

Yes, the offline activation is available only for Stand-Alone licenses. For the Community Edition, an Internet connection is required. To activate the Stand-Alone licenses access File > License Details and follow the information from the Licensing page from the User Guide.

Please note that the enterprise key is given only to users who previously received access to the Enterprise Edition of Task Capture. For detialds check the Licensing page - Activate Stand-Alone License section from the User Guide.

If you lost the enterprise key or if it does not work and you want to make sure you have the correct one please contact your sales representative.

Yes. To install Task Capture you have two installer file types available. For each of them the silent installation procedure is different as detailled below:
  • .msi installer
    To silently install the tool we recommend using the .msi installer. Please check the Installing Task Capture page and the Command-line parameters page for the step by step information.
  • .exe installer
    To run the silent installation for the .exe installer add the /S parameter to the installation command. This is how the command line should look like: './task-capture-installer.exe /S'.
    keep in mind that, through the .exe installer, Task Capture is installed per-user. This signifies that, for the license to be activated, you need to perform at least one installation to have a license file located at {task capture folder}/UiPath Task Capture/License/license.lic. Only after this, you can copy this file to all the instances from your network.

No admin rights are required to install the .exe version of Task Capture. For the .msi version, admin rights are required.

There are 2 options to use Task Capture on remote environments:

  1. Install Task Capture on Windows:
    Task Capture recognizes Citrix just as a separate application, so it captures the full screenshots without determining the selector elements or other metadata.
    Note: Passing selectors from Citrix to Windows doesn't work thus, exporting to a XAML file will generate activities with the same selector: the window of the remote session.

  2. Install Task Capture in a Citrix environment:
    Since the remote environment is just another instance of a Windows environment Task Capture is able to capture screenshots and detect selector for the applications running in the same environment.
    Note: Please check the Software Requirements page to find out more about Citrix compatible versions for Task Capture installation.


During the recording Task Capture stores all the data related current process document in %appdata% folder. Screenshots are saved in the Temp folder and the current process .ssp file in the Backup folder.

Backup saving is done for each minute when the recording is turned on. In case of a critical intermediate crash, you should be able to see the Unsaved files section.

The screenshots that have been captured are also located in %appdata%/Task Capture/Temp.
We recommend sorting the folders based on the Date. Keep in mind that folders older than 3 days are automatically erased.

Please check the Best Practices page for more insights on how to enhance the recording process.

  • Task Capture uses WinAPI for its recorder functionality.
  • To track mouse and keyboard actions it subscribes to low-level hooks via the SetWindowsHookEx method.
  • To resolve key-strokes, it maps key codes to the current keyboard layout.
  • Screenshots are captured using the CreateDIBSection function.
  • To identify the clicked element it used UIAutomation and MSAA technologies.

Screenshots are automatically captured for each of the following actions:

  • mouse clicks: left button, right button, mouse scroller, double clicks
  • hotkeys: Ctrl, Alt, and Win + key
  • pressed keys: Enter, Esc, Tab, BackSpace

As only default clicks and default type methods are captured if your robot uses SimulateClick, SimulateType, or SendWindowMessages, these won’t be captured. So using Task Capture to create PDDs for already automated processes may not capture the entire workflow.

All the keyboard inputs are processed in the same way so sensitive data can't be automatically recognized nor blurred/removed. Sensitive data can be manually removed from the PDD file.
For detailed information check out the Can I blur/remove sensitive data from the workflow diagram? section from this FAQ.

Sensitive information can be manually removed from the following places:

  • Action Description field of every action
  • This contains the recorded keyboard inputs (passwords, logins, etc.).
  • {actionDescription} variable from the Word template file
  • Note that removing this variable impacts the entire process by removing the description of each of the steps captured.
    Details are available in the Editing a Template section from the User Guide.

    Details about how Task Capture handles sensitive information are available in the Security Information page from the User Guide.

Usually, the applications that can’t be captured are running with Admin rights. Task Capture is unable to capture these apps unless you run it as an Admin.

Please make sure to run the app both apps with the Admin rights.

There are many ways to improve different parts of your diagram as well as the capturing process. Please check the Best Practices page for details.

Export to Word

Yes, you can use a custom template but keep in mind that it needs to contain the specific placeholders, so the captured data can be properly listed during the exporting process.
For step by step instructions access the Creating your own Word Template page from the User Guide.

Placeholders are the strings that are used in the Word template for filling in the data from the captured process.

For instance, the {TITLE} placeholder in the exported PDD document will be replaced with the actual Title of the document. For more information see Managing Word Templates.

The list containing all the placeholders defined within Task Capture is available in the Creating your own Word Template page from the User Guide.

To share a Word template with other colleagues export it by accessing Export & Publish > Word Document > Template View.
The exported file format is .ssword.
Share it with your colleagues who have to import it into their list of Task Capture templates.
For step by step information please access the Exporting a Template and Importing a template sections from the User Guide.

Yes, the PDD exports are expected to be easely converted and work into Google Docs but there were some minor formatting issues.

Yes, you can do this while installing Task Capture through the .msi installer file. Set up the customized PDD template using the custom parameters available on the Command Line Parameters page.

We also recommend you check the examples section available on the above-mentioned page.

The image size can be altered when the PDD is generated.
To improve the image quality we suggest you increase the images size.
Keep in mind that, by doing this, the total file size will be increased as well.

Export to UiPath Studio

The following Action Metadatais stored in the XAML file:

  1. Action Type:
    • Click
    • Double Click
    • Type Into
    • Send Hotkey
  2. Element Selector
Additional metadata for each action type:

  • for Click activity - Mouse Button
  • for Type Into – Input Text
  • for Send Hotkey - Input Key

This is an issue caused most likely by UiPath Studio that we are aware of and working on solving. As this is not caused by the XAML file we recommend you first to store the exported XAML files in the folder created for the UiPath project and then open it in Studio.

Export to Automation Hub

No, to export documentation to Automation Hub you need to have Task Capture 20.4 version. To find out the version you are running, click File. The Task Capture version is displayed on the lower left-hand side of the screen.

If you have an older version, upgrade it by following one of the methods described in the Receiving the Installer File page from the User Guide.

We provide each organization with 1 license key for Task Capture activation, which can be used for as many users as the company needs still the license key is not displayed anywhere in Automation Hub as it is the company's responsibility and choice to share the key among its employees.

  1. Open Automation Hub.
  2. Access one of the locations where Task Capture is available:
    • The page displayed after an Employee-driven idea was submitted
    • The Documentation module under the Automation Profile page
  3. Click Create New Process Document with Task Capture.
  4. Task Capture is launched. Document your process.
  5. Click Export & Publish > Automation Hub.
For step by step information, access the Automation Hub section from the User Guide.

No, if the document was captured by simply opening Task Captured and using the capturing options you cannot use the Automation Hub option from Export & Publish.

The captured process can be uploaded as a regular document in Automation Hub.

For more details check out the Documentation section from the Automation Hub User Guide.

Yes, the maximum file size is 200 MB.

By default, documents captured using the Create New Process Document with Task Capture option from Automation Hub will have the same name as the idea from where the tool was launched.

To change the title of the Process Document click the Edit icon displayed as a pencil. This is available on the upper part of the screen in the middle of the application top panel. Once the Rename Process Document pop-up is displayed type in the new name for your process and click Submit.

Application Generic Questions

The log file is frequently requested during the troubleshooting process. To retrieve it simply access Task Capture -> Help -> Open Logs Folder.

You can also find the file by accessing the following location on your PC: %appdata%/TaskCapture/Logs.

The support policy for Task Capture depends on the version. To find out more please check the Product Lifecycle Policy page.

Task Capture uses Tesseract for OCR.

Depending on the installation type Task Capture saves its files in different folders. Please check the table available on the Installation page for details about each scenario.

Known Issues and Errors

Most likely, something blocks the files to be overwritten. One possibility is that the file of the previous version installed under the old app name - Explorer Expert, blocks the writing of new files. To resolve this issue follow the below steps:

  1. Restart your PC.
  2. Try to install the app again.
  3. If the issue is not solved, uninstall the previous version of Task Capture (or Explorer Expert).
  4. Make sure that all the folders are removed. Check all the below locations:
    • %appdata%/Explorer Expert
    • %appdata%/Task Capture
    • %localappdata%/Programs/explorer-expert
    • %localappdata%/Programs/task-capture
  5. Try to install the app again.
  6. If the issue is not solved, remove Task Capture/Explorer Expert data from Windows Registry by following the instructions below:
    • Press the Windows + R hotkeys from your keyboard.
    • The Run pop-up is displayed.Type regedit click OK.
    • Open HKCU\Software\Microsoft\Windows\CurrentVersion\Uninstall\ directory.
    • Search for the guid (global unique identifier) record containing task-capture or explorer-expert in its properties.
    • Delete that record.
  7. Try to install the app again.

Japanese text is translated from previously typed Latin symbols. Task Capture captures text only when the user interacts with the keyboard, but it's not subscribed to how the text is post-processed. This can cause for captured symbols to be displayed as Latin symbols and not Japanese.

If you are running the Task Capture 20.10.2 version, please note that this is an error we are aware of and are trying to fix.

To bypass it, please upgrade your Task Capture version to 20.10.3 or higher.

Some users noticed that capturing more than ~100 actions is causing the diagram to not display them even though actions were registered. As a workaround, users can open the .ssp file in Task Capture v20.10.5 and if it's corrupted, a pop-up will show offering to recover the document.

If Task Capture is activated but you decided to use another activation option, the license plan is not updated as expected. For example, when you sign-in using the Cloud account with Enterprise license to the Community activated Task Capture, you see that the license plan displayed in the tool is still Community. Another inconsistency is with the activation from integration scenarios - Automation Hub and Test Manager. These are the knowns issues and we are working on fixing them.
For a temporary workaround please use the steps in how to force a license update.

Updated 5 months ago


Suggested Edits are limited on API Reference Pages

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