You can integrate select TestRail dashboards and metrics directly in Confluence and other applications. Please see our dashboard integration overview page to learn more about the integration, available pages, and parameter reference. This page shows how to integrate the available dashboards in Confluence.
If you are using HTTPS for your Confluence instance, TestRail also needs to use HTTPS and the referenced URLs need to start with https://, otherwise browsers will not load the referenced frames.
Adding dashboards to Confluence Cloud
To integrate one of TestRail’s dashboards in Confluence, simply use Confluence’s 'Iframe' macro. The Iframe macro makes it easy to include external pages from TestRail and display the pages just like native statistics in Confluence. To add the macro in Confluence, simply select Add > Other macros > Formatting > Iframe .
We recommend the following options for the Iframe macro configuration for the best possible integration of the TestRail dashboard pages in Confluence.
| Option | Value |
|---|---|
| URL | Integration address (see below) |
| Width | 100% |
| Height | E.g. 1000 |
| Border | 0 |
Available integration pages
TestRail provides different pages to integrate metrics and dashboards into Confluence. Please refer to the dashboard reference page for additional parameters and options.
| Dashboard | URL |
|---|---|
| Main overview | https://example.testrail.com/index.php?/ext/common/dashboard |
| Project overview | https://example.testrail.com/index.php?/ext/common/projects/{project_id} |
Adding dashboards to Confluence Server
Confluence Server is unfortunately not including the above-mentioned Iframe macro to embed external pages easily, even though it would be the best and most secure way to include external resources and hopefully Atlassian is also adding this feature to Confluence Server. The often recommended workaround to use the HTML Include macro would not work, as it doesn’t use Iframes but server-side includes instead, which would not forward any authentication details to TestRail.
However, Confluence Server comes with an alternative HTML macro that allows you to include Iframes and other HTML snippets that can be enabled. You can learn more about enabling the HTML macro in the Confluence documentation on macros. Please note the security information on that page. You would be able to add the Iframe macro like display in the image below:
You can then use any of the above mentioned integration URLs to embed an iframe in Confluence with an iframe like the following example:
<iframe src=".." frameborder="0" width="100%" height="1000" scrolling="yes" seamless></iframe>