Test Management for Jira plugin

The Test Management for Jira plugin provides Jira users with test coverage and status information directly on native Jira epics, stories, issues, or custom types.

Overview

The Test Management for Jira plugin allows Jira users to continue planning and working in Jira, with immediate visibility into the quality processes being managed in OpenText Application Quality Management. This plugin helps Jira users understand test coverage and pass/fail status, while providing QA with full visibility and alignment to the development process being managed in Jira.

For details about the system requirements about this plugin, see the Support Matrix.

Back to top

Install

To install the Test Management for Jira plugin:

  1. Prerequisite: Add test coverages for your requirements.

    For details, see Create requirement coverage.

  2. Go to the Atlassian Marketplace. In the Search for apps field, search for the plug-in with the keyword "ALM – Test Management for Jira".

  3. Click the Test Management for Jira card (for the on-premises plugin) or Test Management for Jira Cloud card (for the cloud plugin). Click Get it now to download the plugin.

  4. Sign in to Jira as a project administrator. In the masthead, click Administration > Manage apps > Upload apps > Choose File.

  5. Select the JAR file you download and click Upload.

  6. Click Close.

    You can find ALM CONFIGURATION SECTION on the left pane of the page.

Back to top

Configure

Complete the following tasks to set up the plugin.

Add a custom field to store requirement ID

Add a custom field to store the ID of the requirement that is mapped to the Jira issue.

For Jira on-premises

To add a custom field in Jira on-premises:

  1. Sign in to Jira as a project administrator. Go to Administration > Issues, and click Custom fields.

  2. Click Add custom field.

  3. In the Select a field type window, click Advanced, select ALM Requirement Id Custom Field, and click Next.

  4. Enter the name and description for the custom field, and click Next.

  5. Configure the context for the custom field and click Create.

  6. After you create the custom field, you’ll be moved to the Screens page. Select which screen the custom field should be displayed on, and click Update.
For Jira Cloud

To add a custom field for a company-managed projects:

  1. Sign in to Jira as a project administrator.
  2. In the top right corner of the page, click Settings > Issues.
  3. In the left pane of the Issue types page, under Fields, click Custom fields.
  4. In the Custom fields page, click Create custom field.
  5. In the Select a Field Type dialog box, select Short text (plain text only) as field type and click Next.
  6. Configure the attributes of your custom field and click Create.
  7. Select the screens associated with your custom field and click Update.

To add a custom field for a team-managed projects:

  1. Sign in to Jira as a project administrator.

  2. From the Projects menu, select your project.

  3. Click the issue where you want to add the custom field.

  4. In the bottom right corner of the page, click Configure fields .

  5. In the right pane of the issue details page, under the Create a Field section, click Short text.

  6. Enter the field name and click Save changes.

Add a server configuration

You can add multiple server configurations in the Jira plugin.

To add a server configuration:

  1. Sign in to JIRA as a project administrator.

  2. For Jira on-premises, do the following:

    1. Click Administration > Manage apps.

    2. In the ALM Configuration section, click Configuration, and in the ALM Servers section, click Add an ALM server.

  3. For Jira Cloud, do the following:

    1. In the top right corner of the page, click Settings > Apps.

    2. In the left pane of the page, click ALM Settings.

    3. In the ALM Settings page, under the ALM Servers section, click Add an ALM server.

  1. Configure the attributes of your server, and click Create.

    Field Description
    Name Enter the name for the server configuration.
    ALM Server

    Enter the address for the server.

    For Jira Cloud: You can also enter an on-premises server that is accessible by Jira Cloud. Only secure protocol is supported. For example, https://<server>:<port_number>/qcbin.

    Client ID

    API Key Secret

    Enter the Client ID and API key secret of your API key.

    For information about managing API keys, see API key management.

  2. Click Test connection to test the connection with your server.

  3. Click Create.

  4. If you want to use proxy, click the Proxy Settings button.

Add entity mappings

After adding a server configuration, you can add entity mappings between requirements and Jira issues.

To add an entity mapping:

  1. Sign in to Jira as a project administrator.

  2. For Jira on-premises, do the following:

    1. Click Administration > Manage apps.

    2. In the ALM Configuration section, click Configuration, and in the Entity Mappings section, click Add a mapping.

  3. For Jira Cloud, do the following:

    1. In the top right corner of the page, click Settings > Apps.

    2. In the left pane of the page, click ALM Settings.

    3. In the ALM Settings page, under the Entity Mappings section, click Add a mapping.

  4. Enter the following information, and click Create.

    Field Description
    ALM Server Select the server configuration you added.
    Domain Select the domain where the project you want to map is located.
    Project Select the project to map.
    Jira Custom Field

    Required if you use Jira Cloud.

    Select the custom field you created in Add a custom field to store requirement ID.
    Jira Project Keys Select the Jira project where the Jira issue types you want to map is located.
    Jira Issue Types

    Select the Jira issue types to map.

    The issue types of the selected Jira project that have been mapped with projects are not available for selection.

Back to top

Synchronize

Data between the two sides can be synchronized using Connect or manually.

Synchronize with Connect

If you use Connect to synchronize data, the value of the custom filed that stores the mapped requirement ID can be set automatically.

To synchronize with Connect, add a mapping between the Req ID field and the custom field you added in Jira.
Synchronize manually

You can manually enter the value for the custom field to synchronize data.

To edit the value for the custom field:

  1. Sign in to Jira. From the Projects menu, select your Jira project and Jira issue.

  2. Click Edit and find the custom field. Filled the field with the requirement ID that covers the quality of the Jira issue you selected.

  3. Click Update.

Back to top

Test Coverage widget summary

After you complete configuring the plugin, the Test Coverage widget is added to issue details. The data in this widget is refreshed when you refresh the issue details page.

The widget shows the number of tests related to the entity, and the test status of the last runs of these tests.

You can do the following to drill down to the details:

Action Details
View requirement details

To view the requirement details, click the requirement ID.
View details of tests of a specific status

To view the details of tests of a specific status, click the number for the status.

Click a test ID to drill down to the related test plan.
View details of all tests

To view the details of all the tests, click the View <number> linked ALM tests detail link.

Click a test ID to drill down to the related test plan in OpenText Application Quality Management.
Configure test fields

You can customize which test fields are displayed when viewing a test list.

To configure test fields:

  1. From the widget, click the Configure test fields link.

  2. In the Configure Test Fields dialog box, select a test field for each column.

    • Test Field 1 represents the first column, Test Field 2 represents the second column, and so on.

    • Test Field 1 always shows Test ID. It cannot be edited.

Back to top

FAQ

Q: Does the Jira Cloud plugin support both OpenText Application Quality Management on-premises and SaaS?

A: Yes, the Jira Cloud plugin supports both on-premises and SaaS. If you use this plugin on an on-premises server, make sure the server is accessible by Jira Cloud and the server uses secure protocol.

Back to top