Tools: Axosoft REST API

Defect plugins can be used to implement a deeper bug tracker integration and TestRail comes with a ready-to-use Axosoft defect plugin.

The Axosoft defect plugin discussed in this article uses Axosoft's REST API, which we recommend for Axosoft v13 or later (including OnTime Now). If you are using (Axosoft) OnTime v12 or earlier, please use our OnTime SOAP defect plugin instead.

To configure the defect plugin, select Administration > Integration and select Axosoft_v17_REST in the Defect Plugin dropdown list. 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.

You might need to activate the API in Axosoft first. To do this:

  • Select Tools > System Settings > Axosoft API Settings in Axosoft
  • Enable the API on that page
  • Generate API keys on that page

The required client ID as well as the client secret needed to configure the integration are also listed on that page.

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 Axosoft without leaving TestRail. Once the test result was added, hovering the mouse cursor over an defect ID will open a window with useful information and status details about the defect in Axosoft.

Please note: Axosoft no longer supports the creation of defects since all Work Items now correspond to Features on their platform.

If you still wish to use the plugin to push features into Axosoft, we recommend implementing an additonal workflow step called "bug", "defect" or whichever naming convention works for your team. The workflow step should have the Work Item Type set to “Bug (Issue)” and, under the Allowed Next Steps settings for the new Workflow Step, check all the allowed Next Steps for bugs/defects (or create new ones as desired).

The next time you attempt to push a Work Item to Axosoft, remember to set the Workflow Step dropdown field to the step created above. Implementing this workaround means you can continue to use the defect plugin to create Work Items of type Bug (Issue) in Axosoft.

Customizations

The Axosoft defect plugin was built to work with a standard Axosoft configuration. TestRail allows you to customize the integration to work with your own custom fields among other things. Please see the following articles for details on how to customize the integration: