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

Test Manager API Integration


Test Manager Software Development Kit (SDK) provides Test Manager integration with your development tools. Through this type of integration, you can synchronize artefacts (requirements, stories, defects) and bring UiPath automation capabilities.

The following architecture diagram describes the integration capabilities with UiPath components and 3rd party tools. For more information, see Application Lifecycle Management Integration Patterns.

Integration Scenarios

You can understand how the integration works based on the following typical scenarios:

  • Synchronizing External Requirements
  • Creating Defects in External Tools
  • Assigning Automation to External Test Cases
  • Fetching Results into External Tools

Synchronizing External Requirements

The main purpose of synchronizing artefacts such as requirements is to assign test cases to them. This shows the requirements that have been covered through the test cases. To achieve this, you need to synchronize all the requirements from your external tool to Test Manager. To take this action in Test Manager, see Requirements.

When you synchronize external requirements to Test Manager, consider the following:

  • The external tool is primarily used in the testing process. Externally synchronized requirements show up as read-only in Test Manager.
  • The requirements in Test Manager are updated using the external tool.
  • Deleting all artefacts and any related records in Test Manager through a cascading delete is possible but not considered good practice.
  • Requirements description might use Markdown for formatting purposes.

Creating Defects in External Tools

Test Manager provides a webhook that is invoked when you create a defect from a test case log (see Test Results). You can configure an integration for your Test Manager project to receive test case log information required for defect creation (e.g. Jira Server). You can quickly access the tool where the defects are created by navigating to Test Results > Test Case Key > Defect.

Assigning Automation to External Test Cases

To enable automation capabilities through Studio, you need to synchronize your test cases to Test Manager.

When you assign automation to external test cases consider the following:

  • The external tool stores the mapping information between external test cases and corresponding artefacts in Test Manager.
  • You can assign automation after the test case has been synchronized with Test Manager.
  • Displaying automation information in the external tools reveals that the automation has been assigned. This is considered good practice.

Fetching Results into External Tools

To retrieve results, you need to query TestExecution objects through Test Manager REST API. The TestExecution object is composed of results generated during test set execution. TestExecution holds a reference to TestCaseLogs objects that represent the test case results.

You need to poll the results at regular intervals. Consider retrieving new results every 20 seconds or more.

Setting Up Integrations

You need to set up your integration as an individual service. There are no restrictions in regards to the technology used by your external tool, as long as it can consume RESTful web services.

In the following diagram, you can see an example of how the artefact synchronization works from your external tools to Test Manager.

Note: Based on your external tool capabilities, the intermediate integration service might not be needed.

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.