About
Requirements
Zephyr Enterprise Cloud (
*.yourzephyr.com
or *. zephyrdemo.com). Version 67.6 15 or later is required.Jira Cloud (
*.atlassian.net
), or Jira Server 78.0 or later.
Info |
---|
A beta version of this add-on supports Jira Server 7.0 and later. The add-on for Jira Server is available on the Atlassian marketplace. |
Installation
To install the add-on.0 - 9.10.1, Jira Data Center 8.0.0 - 9.10.1.
Feature Content is available for both Zephyr Enterprise SaaS and Zephyr Enterprise On-Premise.
Feature Content is only available for Jira Server (On-Premise).
Traceability is available for both Zephyr Enterprise SaaS and Enterprise Zephyr On-Premise.
Traceability is available for Jira Cloud and Server/Data Center instances.
Installation & Configuration
To install the plugin, you must be an administrator in Jira. You may find the plugin at The plugin is available on the Atlassian Marketplace here..
1. Install the plugin
Installation steps:
1. Click Apps > Find new apps in Jira:
2. On the subsequent page, type Type Zephyr Enterprise in the search box and press on the next page. Press Enter:
3. Click the found on Jira Integration: Zephyr Enterprise app:
4. Click Get app in the top-right corner of the subsequent next page: :
5. Click Get it now in the Add to Jira dialog:
6. A message informing Message that the add-on has been was added successfully will appear appears in the top-right corner of the Jira window:
Now you can configure Zephyr Enterprise instances.
Configuration2. Configure integration with Jira
To configure integration with Zephyr, you must be an administrator in both in Jira and in Zephyr. The configuration includes generating Generate an API token in Zephyr Enterprise and configuring . Use this token to configure the connection in Jira by using this token.
Generate an API Token in Zephyr
1. Log in to Zephyr Enterprise as a Test Manager.
2. Navigate to Administration > API Tokenand click .Click Create API Token:
3. Enter a name for your token and click . Click Create:
4. Copy the generated API token - you will need it to configure the connection in Jira:
Configure the connection in Jira
1. Log in to Jira as an administrator.
2. Navigate to Apps > Manage Apps:
3. Expand the Jira Integration: Zephyr Enterprise item and click Configure,or just . Click Configure. You can also click Zephyr Enterprise integration in the panel on the left:
4. In the subsequent next dialog, specify the following:
The configuration name (an arbitrary label).
The URL of your Zephyr Enterprise instance. Make sure to include
https://
at the beginning.The API token previously you generated in Zephyr.
Click Configure to save the information.
Note |
---|
When you specify Zephyr URL, make sure the address has no suffix after … |
Info |
---|
In the dialog , you can also:
|
If the connection with Jira is not set up properly, the sections display a warning:
Troubleshooting
If you use Jira Cloud and your ZEinstance is not hosted on SaaS, you may experience connection issues due to firewall, security groups, ACL, etc. In this case, make sure that the following IPs of ZE Jira Plugin service are whitelisted on your server that hosts Zephyr Enterprise:
3.132.191.177/32
3.14.98.222/32
Info |
---|
Note: When you use Jira Cloud, your Zephyr must be available over the Internet to create the connection. Jira Cloud is hosted by Atlassian on the public Internet and cannot access hosts located in private networks. |
Communication diagrams
The communication between Jira and Zephyr Enterprise (with regard to the ZE Jira Plugin) is HTTP/HTTPS on port 80/443.
You can find four possible configurations below:
Import Jira issues as requirements and map them to test cases
Both admins and non-admin users can import requirements to Zephyr and map them to test cases. To import requirements, follow the steps described in Importing Requirements. Below is a sample list of imported requirements:
Once donefinished, map the imported requirements to the test cases the links to which that you want to have be listed in your Jira issues. To learn how to do that, see Mapping Requirements to a Test Case. Below is a sample Check sample list of test cases with mapped requirements below:
Info |
---|
You can import a requirement to multiple Zephyr instances and map test cases to it in those instances, or import several requirements and map them to test cases. In either case, the Zephyr Enterprise section will contain contains links to all the mapped test cases. |
View test
casescase traceability in Jira
After configuring the integration, open a Jira issue whose requirements you mapped to Zephyr test cases and view the links in the Zephyr Enterprise section. Clicking the links will open the test cases in Zephyr:
The links are grouped by test cases. Each link includes the name of the project, as well as the names of the release, cycle and phase it belongs to. The section Once you configured the integration and mapped the requirements to test cases, you can view test case traceability in your Jira instance. To do that, open your Jira issue and scroll down to the Zephyr Enterprise - Traceability section to view all the traceability details:
The table shows the data related to the test case: project and release name, cycle, and phase. The section also shows the status of the last execution of each release, at that, the most recent execution is at the top of the list. Clicking the status will open the execution in Zephyr.. Click the status to open the execution in Zephyr.
Create BDD scenarios
If you installed the Jira Integration: Zephyr Enterprise app into a Jira Server/Data Center instance, you can create BDD scenarios. To do that, configure Jira integration:
Create a Jira issue to work with.
Import that Jira issue as a requirement in the release folder. Use Jira sync or Move the Imported folder to the release folder to any existing requirement in Zephyr Enterprise.
If you don’t have a folder in Zephyr’s Test Repository, create one. Otherwise, you will get an error in Jira when trying to create a scenario.
Go back to Jira and add the BDD_Feature label in the context fields of your Jira issue.
The scenario editor appears under Zephyr Enterprise – Feature Content. You can now create BDD scenarios:
If the Zephyr Enterprise section is not visible, you can open it by clicking click the ellipsis button at the top and selecting . Select Zephyr Enterprise from the dropdown:
Scenario Outline (Beta Feature)
Support for Scenario Outline - Make ZBot compatible with Scenario Outlines
You can create Scenario Outlines from Feature Editor and use ZBot for their execution.
The property checkSteps=true
in zbot.properties
is mandatory to allow the new behavior.
Find more details on ZBot in Zephyr Test Automation.
Info |
---|
Note: This feature is available from Zephyr Enterprise 7.13 release. |
Example:
Step 1: Create a new Scenario in Feature Editor.
Its name can be simply Scenario 1
. You can also use parametrized name e.g. Scenario <num1>
. This parameter should exist in the example table on the scenario outline.
Step 2: Add the content of the new scenario outline and save it.
Code Block |
---|
Given <num1> + <num2>
Then result equals <result>
Example:
|num1|num2|result|
| 1 | 2 | 3 |
| 2 | 2 | 4 |
|
Step 3: One test case per example row is created in Zephyr Enterprise.
In the previous example, two test cases are created:
Given 1 + 2
Then result equals 3Given 2 + 2
Then result equals 4
Step 4: The result file for ZBot should have all the example results matched to the test case.
See Also