Integrate With Zephyr for JIRA

As a user of Zephyr for JIRA, you want to use ARD to import Zephyr Test Issues as a stored path, or import Zephyr test steps as blocks. ARD supports integration with Zephyr for JIRA Cloud through ZAPI.
ard30
As a user of Zephyr for JIRA, you want to use
Agile Requirements Designer
to import Zephyr Test Issues as a stored path, or import Zephyr test steps as blocks.
Agile Requirements Designer
supports integration with Zephyr for JIRA Cloud through ZAPI.
ZAPI is an add-on to Zephyr for JIRA that lets
Agile Requirements Designer
access testing data programmatically through RESTful APIs. If you are logged in to the JIRA connector, but not to ZAPI,
Agile Requirements Designer
displays Zephyr issues as JIRA issues, and you do not see test details.
This article covers the following procedures:
Requirements
You need a JIRA server with the Zephyr plug-in installed.
  1. Open the JIRA web interface and log in.
  2. Select
    Jira settings, Apps, Manage Apps
    .
  3. Verify that you have the following plug-ins installed:
    • ZAPI For Cloud
    • Zephyr for JIRA Cloud
Zephyr support is a beta feature. Enable the feature to test it, then send us your feedback on the community forum! For more information, see Enable Standard Settings and Advanced Features.
Generate Access Keys
Before you log on for the first time, generate keys that allow the
Agile Requirements Designer
desktop application to connect to JIRA through ZAPI.
  1. Open the JIRA web interface and log in.
  2. Select 
    Jira settings, Apps.
  3. Under
    ZEPHYR for Jira Cloud
    , select
    ZAPI
    .
  4. Select
    Create System Key
    .
  5. Enter any name for the key and select
    Submit
    .
    The key is generated and added to the list.
  6. Copy your
    Access Key
    and
    Secret Key
    .
Have your keys ready when you configure the Zephyr for JIRA Connector.
Connect to Zephyr for JIRA
  1. Open the
    Agile Requirements Designer
    desktop application.
  2. Go to the
    Toolbox Dock
    , select
    Connectors
    , and select
    Atlassian JIRA
    .
  3. Enter the JIRA instance
    URL
    , your JIRA
    Username
    , and
    Password
    .
    Example:
    http://localhost:8095
  4. Enable the
    Use ZAPI
    checkbox.
  5. Enter the
    Access Key
    and
    Secret Key
    that you previously generated through the JIRA web interface.
  6. Click
    Login
    .
Configure Zephyr for JIRA Connector
The user interfaces to configure and use the import and export operations are the same for all lifecycle tool integrations. For more information, see Configure Lifecycle Tool Integration.
Minimal Example:
  1. Click
    General Config, Jira
    .
  2. Right click
    Issue: Test
    and select
    Set to Default
    .
  3. Open the
    Issue: Test,
    Path
    tab and define the required
    Reporter
    field.
  4. Right click
    Test Step
    and select
    Set to Default
    .
    The required JIRA field is prepopulated.
Import Zephyr Test Issues
Drag Zephyr test cases from the JIRA connector, and drop them onto the canvas to import them.
  • The importer populates the Path name with the test name.
  • The importer populates the Block name with the step name, and the Block Expected Result with the expected result.
  • TBD: import Test Data
Connect to JIRA and browse JIRA Issues and Zephyr Test Issues in the JIRA Connector.
  • Expand the node to view test steps in the JIRA Connector.
  • Hover the mouse pointer over a test step to quickly view test results.
  • Right-click the Zephyr Test Issue in the JIRA Connector to open it in the JIRA web interface.