Documentation

Looking for something in particular?

Provar Manager - JIRA Plugin - Setup and User Guide

Pre-requisites:

  • JIRA instance with access to create & manage API Keys
  • Provar Manager installation with Release Management Permissions, Provar Manager Setup permissions, and Test Management Permissions
  • Provar Manager 3.15.0+
    • 3.15.0+ is required for JIRA 0.7.0+

Introduction

This guide will walk you through the installation, setup, and usage of the JIRA plugin. This plugin is required to let Provar Manager access your JIRA instance.

Once set up, you will be able to perform the following tasks:

  1. Import JIRA Projects into Provar Manager.
  2. Import Issues into Provar Manager.
  3. Relating Test Cases to JIRA User Stories.
  4. Create Bugs in JIRA from Provar Manager. 
  5. Syncing Issues between Provar Manager & JIRA.

Target Audience

This document is aimed at Testers & Developers utilizing Provar Manager & JIRA as a part of their Development Workflows.

JIRA Plugin

Installation

Firstly, you need to install an extension package for the Jira Integration. All Provar Manager extensions can be installed from the Plugin Marketplace.

Navigate to the Provar Manager Setup > Plugins > Jira Plugin to install the package.

Once it’s installed you will be able to see it under Setup > Installed Packages.

Granting Access

At this point, you don’t have to assign any licenses but you do have to assign permission sets to grant users access to it. 

  1. Click Permission sets. 
  2. Find the permission set named Provar Manager – JIRA plugin and click on it.
  3. Click Manage Assignments.
  4. Select the checkbox next to the name you want to assign permissions.
  5. Click Add Assignments. This will grant permission to use the integration.

Once permissions are granted, you will be able to see the Provar Manager – JIRA Plugin app in the App Launcher. This new app contains the JIRA Integration Settings tab.

Connecting to JIRA

The next step is to link Provar Manager to your instance of JIRA by following these steps:

  1. Click Setup > Named Credentials.
  2. Click New Named Credentials.
  3. Enter the details in the fields as given below.
    1. In the Label field, enter the label whatever you want to put as a label.
    2. In the Name field, enter the name.
    3. In the URL field, enter the URL that you use to access JIRA. Ensure it is a secure URL. Do not add a “/” at the end.
  4. In the Authentication section:
    1. In the Identity Type field, select Named Principal.
    2. In the Authentication Protocol field, select Password Authentication.
    3. In the Username field, enter your username.
    4. In the Password field, enter the API token (see Generating an API token below).
  5. In the Callout Options section:
    1. Select Generate Authorization Header checkbox. 
  6. Click Save. 
  7. Note down the label you used (e.g. JIRA)

Generating an API Token

  1. Open your JIRA workspace.
  2. On the top-right, click on your profile icon and click Account Settings. 
  3. On the left-hand side of the screen, click Security.
  4. In the API token section, click Create and Manage API tokens.
  5. On the next screen, click Create API token to create a new API token.
  6. Store this API token securely because it will be the last time you see it in JIRA.
  7. Use the API token as the password in the Password field back in the Named Credential creation form.

For more information on how to create and manage your Jira API Tokens, visit their support page here: Manage API tokens for your Atlassian account | Atlassian Support

Configuring the Integration

The next step is to configure the plugin to use the named credential you just created.

  1. Open the Provar Manager – JIRA app from the App Launcher.
  2. Click on the JIRA Integration Settings tab.
  1. In the Named Credentials field, enter the named credential’s name (not the label).
    1. In the JIRA Endpoint field, enter the endpoint or the URL that you use to access JIRA (e.g. https://mycompany.atlassian.net). Do not add a “/” at the end.
    2. If you want, you can enable the Enable JIRA Issue Sync switch to keep local copies of user stories synced with JIRA.
    3. (Optional) Additionally, you can enable Bi-directional sync for Jira issues. This will allow you to push updates back into Jira from changes made in Provar Manager.
    4. In the field How often should JIRA issues be synced, select an option based on how frequently you want the JIRA issues to be synced:
    5. Click Save Connection Details
  2. In the Import Issues Link Types, you can decide which Issue Link Types to map into Provar Manager.
  3. Lastly, you can decide which fields you’d like to create mappings for. This will allow you to map JIRA Issue fields to Provar Manager Issue fields for syncing and reporting purposes.
  4. Click Save.

Adding the JIRA Issue Sync Information Component to the Page

To add the JIRA Issue Sync Information component to the Issues tab, please follow the steps given below:

  1. Select any issue, from the list of Issues in the Projects tab.
  2. Click Settings on the top-right and click Edit Page.
  3. Under Components, drag and drop the JIRA Issue Sync Information component onto the page.
  4. Click Save.
  5. Click Activate or Activation in the top right if this window does appear.
  6. Under App Default, click Assign as App Default.
  7. In the App Name field, select the Provar Manager applications as shown below and click Next. Leave the Form Factor defaults then click Next again.
  8. A Review Assignments screen is displayed and click Save.

Adding the JIRA Bug Component to the Page

To add the JIRA Bug component to the Defects tab, please follow the steps below:

  1. Open the Defects tab in the Provar Manager Test Management app and select any defect.
  2. Click Settings on the top-right and click Edit Page.
  3. Under Components, drag and drop the JIRA Bug Information component onto the page.
  1. Click Save.
  2. Click Activate or Activation in the top right if the screen does not appear.
  3. Under App Default, click Assign as App Default.
  4. In the App Name field, select the Provar Manager applications as shown below and click Next.
  5. Leave the Form Factor as default and click Next.
  6. A Review Assignments screen is displayed and click Save.

Using the Plugin

In this section, we will show you how you can use the JIRA plugin in Provar Manager.

Here are some of the activities you can perform thanks to the plugin:

  • Import Projects into Provar Manager
  • Import Issues into Provar Manager
  • Relating Test Cases to JIRA User Stories
  • Create Bugs in JIRA from Provar Manager 
  • Syncing Issues between Provar Manager & JIRA

Importing Projects

To import Projects into Provar Manager follow these instructions:

  1. Open either the Provar Manager – JIRA app or the Provar Manager Release Management app.
  2. Click the Projects tab.
  3. Click Import.
    1. If you have the Azure DevOps plugin installed as well, you have to select Jira from the Select a Release Management Tool screen first.
  4. You will see a list of all the projects in your JIRA instance that you have access to.
  1. Select any project (click ‘+’)
  2. Click Import. You will see a message Projects Imported successfully.
  3. Click Finish. You will find your selected projects in the Projects tab.

Importing Issues

Open the previously created Project record and you’ll see all the Issue Types the project has (e.g. Task, Story, Epic, Bug, Sub task) but no Issues on the Related Tab.

You can import Issues using these instructions:

  1. Click Import.
  1. Depending on what you want to test, select the user stories you want to import (click ‘+’).
    Note: Epics are imported automatically.
  2. Click Import.
    1. You can either Import All issues at once or cherry-pick them then click Import.
  3. Refresh the page and you will see all the issues and related epics as well.
  4. By clicking on an Epic record you will be able to see all the child issues.

Relating Test Cases to JIRA Issues

Note: Make sure you have imported the Project, Issues, and Issue Link Types beforehand.

One of the advantages of integrating Provar Manager with JIRA is that you can now create and relate test cases to user stories.

If you open an Issue record you will see on the left-hand side all the information about the issue; the name, the description, the status, its external key & URL, and what sort of issue type it is (e.g. Epic).

On the top right side, you can see information related to the sync status. We will cover syncing in more detail in the Syncing Issues between Provar Manager & JIRA section.

You can relate your test cases to your JIRA issues by clicking New in the Test Cases related list.

Sending Defects to JIRA

You have the option of sending defects to JIRA as issues (e.g. Bugs) from the Defect record itself by following these steps:

  1. Open a Defect record from any Provar Manager app.
    1. The Defects tab is enabled by default in the Provar Test Management app.
  2. On the JIRA Bug component, click Link to JIRA.

Note: This component must be added to the layout first by the end user, please refer to the Adding the JIRA Bug Component to the Page section for more.

  1. In the Parent issue field, select the imported user story it is related to.
  2. In the Issue Type field, select the type of issue (e.g. Bug)
  3. In the Issue Link Type field, select the relationship between the defect and the user story.
  4. Once you have selected the options in all the fields, click Create JIRA Issue.
  5. If successful, the messages JIRA Issue created and JIRA Link Issue created are displayed.

In JIRA, you will find that a JIRA issue was created and related to the selected user story.

Syncing Issues between Provar Manager & JIRA

Provar Manager Issues can be synced back into or from JIRA. Once the sync has been enabled from the JIRA Integration Settings page, issues imported from JIRA will be synced based on the selected frequency. 

Note: If the bi-directional sync has been enabled, the sync still occurs, but changes made in Provar Manager will now be reflected back into JIRA, such as updating the description or status fields. However, Provar Manager will not overwrite any changes made in JIRA, as we prefer to maintain JIRA changes over Provar Manager changes.

  1. Fields that are synced depend on Field Mappings you create in the JIRA Integration Settings page.
    1. By default, Summary, Description, and Status fields are synced.
  2. Additional field mappings can be added and will allow for bi-directional syncing between Provar Manager Issues and JIRA items.
  3. You can force the sync to occur at any time by navigating to an imported Issue record.
  1. From here, click the Sync button on the JIRA Issue Sync Information component, wherever you have added it in the layout as before.
  2. If bi-directional sync is enabled this will attempt to push changes made in Provar Manager to JIRA as well as import changes made in JIRA to Provar Manager.

Feedback

Was this article helpful for you?
Documentation library

Trying to raise a case with our support team?

Log into the Success Portal

We use cookies to better understand how our website is used so we can tailor content for you. For more information about the different cookies we use please take a look at our Privacy Policy.

Scroll to Top