Integrating Zephyr Squad with Zephyr Blueprints for Confluence

Zephyr Blueprints for Confluence can display real-time metrics from one or more instances of Zephyr Squad (formerly Zephyr for Jira). These metrics can be displayed in Dashboard Blueprints or in any page of Confluence via a customizable macro.

Requirements

Before configuring the integration, make sure the following requirements are met:

  • You are a Confluence Administrator and a Jira Administrator.
  • The Jira instance you are trying to integrate to can be accessed from this Confluence instance (open a new tab in your browser, type in the URL of that Jira and make sure it loads before continuing).
  • The Zephyr Squad installation on that Jira instance has not expired.

Integration

  1. As a Confluence Administrator, open Confluence administration and select General configuration.
  2. Scroll down till you find Zephyr Blueprints and select General Configuration.
  3. On the page that opens, select the Zephyr for Jira Test Metrics tab and click Set Connection.
  4. The Application Links section opens. This is where you will enter the URL of the Jira instance (in which Zephyr Squad is installed) that you want to integrate to.
  5. In the dialog that opens, select the I am an administrator on both instances check box and click Continue.
  6. You will be redirected to Jira.
  7. In Jira, enter your Jira admin credentials, confirm it, and click Continue.
  8. You will be redirected back to Confluence. At this point, you have successfully created an app link between Confluence and Jira.
  9. Click Edit next to the created app link.
  10. The OAuth authentication mechanism is already selected by default and is enabled. Click Close.
  11. Go back to the General Configuration under Zephyr Blueprints. You will see the following screen. This is where you have to authorize to make this operation work by logging into Jira.
  12. Click the link to log into Jira. In the message that appears, click Allow.

Zephyr Blueprints for and Zephyr Squad are are now integrated. You can confirm this by the presence of the version number (2.5.1 in this example).

You are now ready to use this integration via the Test Dashboard.

Disabling Test Metrics

By default, all test metrics from the integrated Zephyr Squad instance are available in Zephyr Blueprints for Confluence.

If you wish to disable certain metrics:

  1. Select your Jira server from the drop-down.
  2. Click Disable next to the metrics you want to disable.