Jira Defect Integration

Jira is crucial for testers and developers to collaborate. When used for Defect Management, testers and developers log issue types, often of type “bug” in Jira. Whether you use Jira Cloud, Jira Data Center, or Jira Server, you can integrate Functionize with your Jira projects. To do this, set up the integration to map your custom Jira Issue Type for defects to the appropriate project. This is a many to many relationship where you can submit defects from Functionize to multiple Jira Projects or Issue Types. After you execute Functionize tests, dig into any potential failures. Then, directly submit defects from Functionize directly into Jira.

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 Integrations tab.
    Screen_Shot_2021-07-08_at_10.39.18_AM.png
  2. On the left, select Jira from the Defect Management section.
  3. In the main panel, provide credentials for the connection. Select Cloud or Server/Data Center.
  4. Enter the URL for your Jira instance, your Jira username, and your 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
    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.
    Screen_Shot_2021-07-06_at_3.50.51_PM.png

Map Projects

  1. Once you've established the connection, scroll down to the Project Mappings section.
  2. Select the Functionize and Jira projects you wish to link together. This allows you to submit defects (into the Jira project) from the test results (from the Functionize project).
  3. Defect Type: Select the Issue Type you wish to create into Jira. This can be a Bug, a Defect, or whatever Issue Type (including custom issue types) your teams use to represent issues that need to be resolved.
  4. Details: Select the Jira text area field that you would like to auto-populate using Functionize data. We suggest adding a Functionize Data custom field to Jira Defects to keep the data well-structured.
  5. Fields: Select the Fields to be displayed when creating Jira Defects from Functionize. 
    Screen_Shot_2021-07-08_at_1.28.53_PM.png
  6. Click Submit to save your connection 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 test helps to provide developers with more information. 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 test step that represents the failure or area of concern. Hover over the left side of that step.
  3. Click on the Bug icon with the plus sign.Screen_Shot_2021-07-08_at_1.22.59_PM.png
  4. Enter the relevant details for the Defect, then click CreateBy default, the Details 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.Screen_Shot_2021-07-08_at_1.23.24_PM.png
  5. Click Continue on the "Defect Created Successfully" modal to be returned to the Test Detail screen. You will notice two Bug icons alerting you that one or more defects have been made from this test. The icon at the top of the screen will display the total number of bugs filed for the entire test. All test steps from which defects have been filed will also display a Bug icon with the number of defects filed for that step. Screen_Shot_2021-07-08_at_1.25.21_PM.png
  6. Clicking the Bug icon in the test step will display the connected bugs created for that step. Clicking the bug icon in the header will display all bugs connected to the test.Screen_Shot_2021-07-08_at_1.26.28_PM.png

Create a Defect in Slider view

  1. Click the View Results button in the Test Detail screen.Screen_Shot_2021-07-08_at_3.59.59_PM.png
  2. Slider View will open and the Bug icon will display on any step with a filed defect.Screen_Shot_2021-07-08_at_3.12.01_PM.png
  3. Click the Gear icon and select Create Defect. The defect creation modal will open. Fill out the relevant details, click Create, click Continue on the "Defect Created Successfully" modal.
    Screen_Shot_2021-07-08_at_3.44.54_PM.png
  4. This will bring you back to the Test Detail screen where you will see the updated number next to the Bug icon in the header and the additional Bug icon on the specific test step.Screen_Shot_2021-07-08_at_3.53.57_PM.png

Filtering Tests

  1. You can also see which tests have defects filed directly from the Project 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.
    Screen_Shot_2021-07-08_at_6.14.31_PM.png
  2. As in the Test Detail view, clicking on the Bug icon will display the defects filed.Screen_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" menu with the Jira icon.Screen_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 Defect display, either from the test step or the test details header.
    Screen_Shot_2021-07-08_at_1.25.48_PM.png
  2. Jira will open and the ticket can be edited as usual.Screen_Shot_2021-07-08_at_1.28.14_PM.png