TestRail

Key Features and Benefits

• Synchronize testing artifacts across the testing lifecycle from TestRail to your tool of choice, improving team collaboration

• Support cross-tool traceability and reporting, removing the need for manual processes and spreadsheets

• Maintain traceability of requirements and tests across multiple systems and departments

• Allows for automatic test results reporting during test execution from QA to development

• System Engineers and Project Managers can view testing status in the best of breed tools of their choice

• Greater range of options and workload distribution for QA teams

Common Integration Patterns

• Providing Testers with Early Visibility into Requirements

• Aligning Testing Teams across Testing Tools

Demo Videos

Minimal User Permissions & Hub User

We recommend that you create a new user within your external tool, to be used only for your Hub integration. This is the user information you will enter when setting up your repository connection within Planview Hub. By creating a new user, you will ensure that the correct permissions are granted, and allow for traceability of the modifications that are made by the synchronization. 

In general, your user account should have sufficient permissions to create, read, and update artifacts in your repository. However, depending on the use case, your user may need different permissions. For example, if you are only interested in flowing data out of your repository, your user may not need to have full CRUD access, as the 'create' and 'update' permissions may not be needed.

Your user should have a secure password or token. Please be aware that Hub will not allow you to save a repository connection utilizing a weak password/token, such as 'tasktop.'

See instructions here to learn how to create a custom user in TestRail.

Minimal user permissions can be configured in TestRail under Administration → Users & Roles → Roles.

List of minimal user permissions:

• Add/Edit privileges for the following:
  • Attachments
  • Cases & Sections
  • Runs & Plans
  • Suites
  • Test Results

Note: If using the Person Reconciliation feature, administrator privileges of the authenticated user are required.

Connecting to the TestRail Repository

Standard Authentication

Required Fields: 

• Location/Connection URL 
  • Example Format: https://example.testrail.io
• Username
• Password

Optional Fields:

• Throttling Settings: This field indicates the number of API calls that can be made per minute. See details here.
  • Note: This field should only be set under the guidance of customer care as the ideal value is highly dependent on each customer's unique environment. 
• Connection Security: If checked, insecure connections to this repository will be allowed. See details here.

OAuth 2.0 Client Credentials Proxy Authentication 

This authentication method enables secure, token-based access via a proxy, using client credentials. Refer here for full details. 

Note: TestRail does not currently support OAuth 2.0 Client Credentials authentication. As a result, the TestRail connector does not allow connecting directly with the TestRail repository using the OAuth 2.0 Client Credentials authentication method. 

Learn more about how to set up your repository in Planview Hub here. 

Rich Text

Markdown rich text elements are supported in general, but tables are not supported.

Person Reconciliation

For person reconciliation, the following fields are available:

Person ID can be found by navigating in the TestRail UI to Administration → Users and Roles then hovering over or selecting the user name you want the ID for. The number in the last segment of the URL is the Person ID.

Learn more about how to configure person reconciliation in Planview Hub here.

Special Features Supported

Supported Work Items

Learn about the difference between containers and work items in Planview Hub here. 

Supported Containers

Learn more about containment in Planview Hub here.