Jira Defect Integration

Functionize and Jira Defect Integration Overview

Jira is a vital tool for testers and developers to collaborate. In Defect Management, users often log issue types, typically labeled as a 'bug' in Jira. Whether you're using Jira Cloud, Jira Data Center, or Jira Server, you can integrate Functionize with your Jira projects.

Configure the integration to map your Jira Issue Type for defects to the corresponding Functionize project. This establishes a many-to-many relationship, allowing you to submit defects from Functionize to multiple Jira Projects or Issue Types.

After executing Functionize tests, investigate potential failures. Subsequently, submit defects directly from Functionize into Jira with links back to the test execution in Functionize for easy steps to recreate the defect.


Setup the Jira Integration

Establish Connection

Only Team Administrators may set up the Jira integration. Other users will not be able to access the Team tab.

  1. Open the Team page, and then click the Integration tab

  2. On the left panel, select Jira from the Defect Management section
  3. In the main panel, select Cloud or Server/Data Center
  4. Enter the URL for your Jira instance, the Jira Username, and the Jira API Token - not your password - these can be found in your Jira account by a Jira Admin by accessing Apps > Manage Apps > API Keys
    Note: For Jira API token assistance, read here: Manage API tokens for your Atlassian account

  5. Click Test Sign In, the status next to the button will update to "Connection established" with a green check mark

 Map Projects

  1. Once you've established the connection, scroll down to the Project Mappings section

  2. Select the Functionize and Jira projects to link together, this allows a user to submit Defects into the Jira project from the test results from a Functionize project
  3. Defect Type: Select the Jira Issue Type to be created in Jira when submitting from Functionize, this can be a Bug, a Defect, or whatever Issue Type, including custom issue types that your teams use to represent issues found during testing that need to be resolved
  4. Details: Select the Jira text area field that you would like to auto-populate using Functionize data that will include a link back to the Functionize test execution results
    Note: We suggest adding a Functionize Data custom field to Jira Defects to keep the data well-structured.
  5. Fields: Select the Jira Fields to be displayed when creating Jira Defects from Functionize
  6. Click Save Mapping to save your Jira to Functionize project mapping details
    Note: Multiple projects may be added, however each must be mapped individually.

Create a Defect in Test Detail view

After executing a test, review any failures or areas of concern. Creating a defect in Jira linked to that Functionize test helps to provide developers with more information, including steps to recreate the issue. This helps them understand what needs to be fixed, and helps you to keep track of bug resolution.

  1. To create a Defect, open a test case to the Test Details page
  2. Find the action that represents the failure or area of concern, click the Action to expand and show the Action Settings

  3. Click on the Create Defect button
  4. Select radio button to Create New Defect or Link Existing Defect and click Continue

  5. Enter the relevant details for the Defect, then click Create Defect, by default, the Description mapped field will contain Jira’s tabular format that includes details about the current test execution for links back to Functionize from the Jira Defect about to be created

  6. The Test Detail page will display the Defect bug icon in the header, click the button to see a list of Defects linked to this test

  7. The Defect bug icon will also display at the right end of the action banner, click the icon to see a list of Defects linked to this action

  8. Click the Issue name to open Jira and view the Defect details, a New Defect button is also available to aid in filing multiple issues for a single action
    Note: The number on the bug icon corresponds to the number of Defects filed for the Test or Action.

 Create a Defect in Slider view

  1. Open the Slider View by clicking the View Results button at the top of the Test Detail page or click the View button to the right of the failed action

  2. Slider View will open

  3. Open the Actions menu on the failed Action and select Create Defect

  4. Select Create New Defect or Link Existing Defect and click Continue

  5. Enter the issue details, ensure all required fields are entered and click Create Defect

 Filtering Tests

  1. You can also see which tests have defects filed directly from the Test Listing page, this can be particularly useful to verify resolved defects on a regular basis to ensure that only tests that are failing are mapped to unresolved defects

  2. As in the Test Detail page, clicking on the bug icon will display the defects filedScreen_Shot_2021-07-08_at_6.15.39_PM.png

  3. You can also filter by the status of your Jira tickets by using the Defects filter drop-down with the Jira iconScreen_Shot_2021-07-08_at_6.28.46_PM.png

 View the Defect in Jira

  1. Click the link for the Jira issue in the Defects display, either from the test action or the test details header or test listing page

  2. Jira will open and the ticket can be edited as usual