Skip to main content
Logo
Docs
System Status
System Status
Submit a request Sign in
How can we help?
Popular:

Popular articles

  • Charts and dashboards
    Summary charts give you a way to see the status of various test activities in TestRail at a glanc...
  • Configuring custom fields
    TestRail’s custom fields feature allows you to add your own fields to TestRail’s user interface. ...
  • Integrate with Jira
    This topic explains how to configure the TestRail integration with Atlassian Jira to link Ji...
  • Overview and installation
    The TestRail CLI is a command line interface tool that allows you to effortlessly upload test aut...

User Guide

Getting started with TestRail

  • Introduction to TestRail
  • Usage tips & tricks
  • Projects and their types
  • Search
  • Editor formatting reference
  • Keyboard shortcuts & hotkeys
  • See all 8 articles

Test cases

  • Import test cases from CSV or Excel
  • Import test cases from XML
  • Behavior-Driven Development (BDD)
  • Managing (moving, copying, deleting and restoring) test cases
  • Separate test steps and test results
  • Shared steps

Test planning and execution

  • Creating new test plans and runs
  • Editing test results

Reporting and analysis

  • Charts and dashboards
  • Reports FAQs
  • Reports overview
  • General configurations for reports
  • Customizing charts
  • Print reports

Migration guide

  • Migration: Introduction
  • Migration: CSV & Excel
  • Migrate from Zephyr Squad
  • Migrate from Zephyr Scale
  • Migrate from qTest
  • Migrate from TestLink
  • See all 7 articles

Administration and customizations

  • Configuring custom fields
  • Adding users to your TestRail instance
  • Adding a custom logo to your TestRail instance
  • Managing attachments
  • Data management

Enterprise guide

  • Test parameterization, variables, and datasets
  • Test case versioning
  • Test case review & approvals
  • Project-level administration
  • Email customization
  • Configurable backup time & restoration
  • See all 7 articles

Server Guide

Installation

  • Installation requirements
  • Activating the background task
  • Upgrading TestRail
  • Downgrading TestRail
  • Enterprise Server Installation

Server Administration

  • Setting up a staging server
  • Creating a backup of your TestRail Server instance
  • Restoring a TestRail backup
  • Optimizing TestRail Server installations
  • Securing TestRail Server installations

Customizations and extensions

  • Languages: Translating TestRail’s user interface
  • Debugging custom scripts
  • Building a custom defect plugin
  • Customizing a defect plugin

Authentication

  • Authentication: Introduction
  • Authentication: Active Directory
  • Authentication: LDAP
  • Authentication: Implementing single sign-on with TestRail

Integrations

Requirements and defects integrations

  • Introduction to reference and defect integrations
  • Configuring reference integrations
  • Configuring defect integrations
  • Configuring user variables

Dashboards

  • Overview of dashboard integrations
  • Integrate with Confluence

Webhooks

  • Webhooks

Test Automation

TestRail CLI

  • Overview and installation
  • Automation workflows - Code-first
  • Automation workflows - Specification-first
  • JUnit to TestRail mapping
  • Usage examples
  • SauceLabs and saucectl reports
  • See all 8 articles

Automation frameworks integration

  • Integrating with Cypress
  • Integrating with Playwright
  • Integrating with JUnit5
  • Integrating with TestNG
  • Integrating with NUnit
  • Integrating with Pytest
  • See all 7 articles

CI/CD tools integration

  • Integrating with Jenkins (freestyle)
  • Integrating with Jenkins (pipeline)
  • Integrating with GitHub Actions
  • Integrating with GitLab CI/CD

UI scripts for test automation

  • UI scripts for test automation

API Manual

Getting started with TestRail API

  • Introduction to the TestRail API
  • Accessing the TestRail API
  • Binding Java
  • Binding PHP
  • Binding Python
  • Binding Ruby
  • See all 8 articles

API reference

  • Attachments
  • BDDs
  • Cases
  • Case Fields
  • Case Types
  • Configurations
  • See all 25 articles

Release Notes

Early Access release track

  • TestRail 7.8.0 Early Access (1141)
  • TestRail 7.8.0 Early Access (1059)
  • TestRail 7.8.0 Early Access (1116)

Default release track

  • TestRail 7.8.0 Default (1136)
  • TestRail 7.8.0 Default (1140)
  • TestRail 7.8.0 Default (1141)

Server releases

  • TestRail Server 7.5
Can't find what you're looking for?
Let us help you!
Submit a request

© 2023 Gurock Software GmbH

Privacy Policy Terms of Use Status Back to main site
https://support.gurock.com/hc/en-us/articles/7076810203028
//theme.zdassets.com/theme_assets/10428741/86e721ff98b7ab346365b58812d91aa28c82f7a3.svg
Getting Started
Basics for using TestRail
custom
https://support.gurock.com/hc/en-us/articles/7076865340564
//theme.zdassets.com/theme_assets/10428741/f2b8e3ad6731f9e977b0d7518b5c19974a892c02.svg
Guides
In-depth guides for everything TestRail
custom
https://support.gurock.com/hc/en-us/articles/7747333895700
//theme.zdassets.com/theme_assets/10428741/edb93545ba6b193aa59a4e47f0791ffa630b232e.svg
Integrations
Connect to other tools in your development pipeline
custom
https://support.gurock.com/hc/en-us/articles/7077083596436
//theme.zdassets.com/theme_assets/10428741/ec699718945f919765c2d516e642f01752db53fc.svg
API & Developers
Build custom integrations and workflows
new_request
/hc/en-us/requests/new
//theme.zdassets.com/theme_assets/10428741/2911f8b4355ab9dfc3777835888d498b554ab16c.svg
Submit a request
Contact our team for technical support or questions about your account
import, jira, customizations, api