Test Suite
Banner background image
Test Suite User Guide
Last updated Feb 28, 2024

Getting Started

In this section, you can build your testing portfolio and learn how to manage test cases and test sets in Test Manager, and document test cases through Task Capture:

Integrating With Orchestrator

To start using your Test Manager, the first thing you need to do is to assign an Orchestrator instance to it.

Important: To correctly sync results between Orchestrator and Test Manager, make sure the folder from which you are executing tests is available for the admin user. For more information, see Roles.

After you associate an Orchestrator instance, the execution results are fetched automatically in Test Manager.

Integrating With Studio

To complete the integration with Studio, you need to configure the Test Manager Settings.

  • You need a Studio license. For more information, see About Licensing.
  • If Studio is not yet activated or connected to your Orchestrator instance, see Activate Studio.
  1. Open Studio and then start a new project or open a recent one.
  2. In the Design ribbon, navigate to Test Manager > Test Manager Settings.
  3. Go to Test Manager Configuration and enter your Test Manager URL.

  4. Click Connect and log in using your Test Manager credentials. If you don't have the necessary rights to log in, see Troubleshooting.
  5. Select your Default Project from the dropdown list.

  6. Click OK to save changes.

Creating a Project

The test project is composed of artifacts (e.g. requirements, test cases, test sets) that are targeted towards a joint testing goal. You can create an unlimited number of test projects.


  • Projects are visible only to project creators and Administrators. To enable access to other users to your project, see Managing users and groups.
  • You can create an unlimited number of test projects.

Who can create projects

Any user role can create a project, while only Administrators/Project Owners can edit or delete projects.

For more information see User and Group Access Management.

Create Project

  1. Log in to Test Manager.
  2. In the Home page click Create new project.

  3. Configure your test project:
    • Name - Enter a name for your project.
    • Prefix - Enter a short identifier for your project. Choose 3-5 characters that are prepended to all artefact IDs within your project. The prefix cannot be changed later.
    • Description (Optional): Enter a description for your project.

  4. Click Create. Your project is saved and you are redirected to the project dashboard.
    • You can mark your project as Favorite to have it at hand on the Favorite projects page.
    • To edit a project, right-click the vertical ellipsis and select Edit on the project you want to update. You can change all project details except for the prefix.

Document Test Cases With Task Capture

UiPath Task Capture is a process discovery tool that helps you document your test cases to avoid manually downloading the images and typing titles for each of the included actions.

Working in the background, the tool captures the performed steps, takes screenshots with every mouse click, and collects smart data about the process statistics (execution time, number of steps, text entries, etc.). You can edit and annotate each screenshot and add information for each step.

Based on the captured data, UiPath Task Capture builds a comprehensive Process Definition Document (PDD) in a .ssp, .docx and .jpg (diagram image) format that can be easily uploaded to Test Manager.

For more information, see Task Capture Introduction.

Document With Task Capture

To document test cases with Task Capture, follow these steps:

  1. Open your project in Test Manager.
  2. Open a test case in Test Manager. If you do not have a test case yet, see Create Test Cases.
  3. Open the Manual Steps tab.
  4. Click Document with Task Capture.

    If you already have Task Capture installed, skip the following note.


    Click Download and select the Task Capture version that you want to download. For more information, see Task Capture Installation.

    If requested, grant permission to your browser to open an external application.

  5. Choose whether to build a diagram or capture a process.
  6. When you complete documenting your test case in Task Capture, publish the workflow to Test Manager.

    The workflow will be attached to your test case in the Manual Steps tab.

Working With Task Capture

You can view your Task Capture files published to Test Manager and create manual steps from a recording.

Viewing diagram file

To view the action sequence diagram, open a test case in the Test Cases page, navigate to the Manual Steps tab, and click View Diagram to download the file.

For more information, on diagrams, see Build diagram.

Viewing recording file

To view the Process Definition Document (PDD) as a Word exported file open a test case in the Test Cases page, navigate to the Manual Steps tab, and click Open recording to download the file.

For more information on recordings, see Details about the PDD.

Creating steps from recording

When you use the Document with Task Capture feature, you can also add any recorded steps as manual steps to a test case.

  • You need to have a documented test cases with Task Capture.
  • For each step in the recording, a manual step is added to the test case, using the step title and description from the PDD file. In contrast, if the step titles are empty, the manual step title is set to Unnamed.
  • Any new steps that you create from a recording are added to any preexisting steps.
  1. Open a test case on the Test Cases page.
  2. Navigate to the Manual Steps tab.
  3. Click Create steps from recording and then confirm your action when prompted.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.