Tools: Manuscript

This topic explains how to integrate TestRail with FogCreek Manuscript. There are currently three ways to integrate TestRail with Manuscript, namely:

You don't have to use all listed integration options and you can mix and match the integration with other tools. Configuring the integration usually only takes a few minutes and this guide explains how to configure the integration and how it works.

Defect URLs

The defect URLs are used to let TestRail know how to access your Manuscript instance. Once the URLs have been configured, a new Add link appears next to the Defects field in the Add Test Result dialog. This link allows you to jump to Manuscript' New Case form to report a new bug. Additionally, entered case IDs are linked to your Manuscript instance to make it easier to track the status of your cases.

To configure Manuscript' URLs in TestRail, select Administration > Integration. You can alternatively enter separate bug tracker URLs for each project under Administration > Projects. Use the following example URLs to configure the addresses:

Manuscript installation
Defect View Url: https://your-server/f/cases/%id%
Defect Add Url:  http://your-server/f/cases/new

Manuscript on demand
Defect View Url: https://your-name/f/cases/%id%
Defect Add Url:  https://your-name/f/cases/new

Defect plugins

Defect plugins can be used to implement a deeper bug tracker integration and TestRail comes with a ready-to-use Manuscript defect plugin. To configure the defect plugin, select Administration > Integration and select FogBugz in the Defect Plugin dropdown list (Fogbugz is the legacy name for Manuscript). The next step is to configure all the necessary connection settings in the Configuration field. Project specific plugins and configuration settings can optionally be specified under Administration > Projects.

When the defect plugin has been configured, a new Push link is shown next to the Defects field in the Add Test Result dialog. Clicking the link will open a popup dialog that enables you to push a bug report to Manuscript without leaving TestRail. Once the test result was added, hovering the mouse cursor over an case ID will open a window with useful information and status details about the case in Manuscript.

Customizations

The Manuscript defect plugin was built to work with a standard Manuscript configuration. TestRail allows you to customize the integration to work with your own custom fields or to map users between TestRail and Manuscript. Please see the following articles for details on how to customize the integration:

Reference URLs

The reference URLs are used to link test cases to cases stored in Manuscript via the References field. Once the URLs have been configured, case IDs entered in the References field are linked to your Manuscript instance to make it easier to jump to related issues, feature specifications or requirements.

To configure Manuscript' URLs for the References field, select Administration > Integration. You can alternatively enter separate reference URLs for each project under Administration > Projects. Use the following example URLs to integrate TestRail with Manuscript:

Manuscript installation
Reference View Url: https://your-server/f/cases/%id%
Reference Add Url:  https://your-server/f/cases/new
Manuscript on demand
Reference View Url: https://your-name/f/cases/%id%
Reference Add Url:  https://your-name/f/cases/new