Key Results from Jira Cloud

Overview

The Jira data connector for WorkBoard allows the user to pull progress based on “Done” user stories within specified projects. Stories and status can also be specified by JQL. Key Result in WorkBoard will be updated on the next data pull specified by the update cadence, or can be done in real time. 

Requirements

  • The IT admin for your organization may need to approve the connector for the first time if the App is configured to require approval.

Frequently Asked Questions

What if I have an on premise instance of Jira?

We suggest you use the WorkBoard Plugin for Jira. It is possible to pull data from your Jira instance using the Jira Cloud connector in WorkBoard, but only if your organization allows that data to be exposed outside your firewall or exposed to the internet. 

Create a Key Result from Jira

  1. Hover over your Objective and click the Kebab.
  2. Select Edit Settings.
  3. Select Add another Key Result.
  4. Select Advanced Options.
  5. Choose Pull data from external applications.
    Screen_Shot_2021-10-20_at_3.11.09_PM.png
  6. Pick Jira from the list of integrations.

    2021-11-10_11-02-25.png

  7. Log in to Jira by adding the URL for your Jira domain and username.
    Note: To complete the setup flow, you will need to enter or generate and enter an API token. 
    2021-11-10_11-07-49.png
  8. You can login to Jira to create a token by selecting Generate API token.
  9. Login to Jira with your password.
  10. You'll be taken to the API Tokens section of your Jira Account.
  11. Select Create API Token at the top of the page.
  12. Enter a name and select Create.
    2021-11-10_11-21-13.png
  13. Copy the token.
    2021-11-10_11-23-13.png
  14. Paste it into the WorkBoard Jira Connector login pop-up.
    2021-11-10_11-10-30.png
  15. Select Connect.
  16. Choose how you want to get issue completion data from Jira
    • Percentage of completed issues within specific projectsIf you select this option, then pick from the available projects and select Save.

    • Advanced JQL Query - If you choose this option, then write a custom query for all of the issues you'd like to count, and of which, what count as completed, and then select Save.

Basic Percentage of Complete Issues

Select one or more projects and automatically pull completion of Jira issues to calculate your key result progress. If you would like, you can also select to pull only issues from active sprints in your projects. Your result will automatically update every 6 hours.

Advanced JQL Query

Using the advanced JQL Query option, you can define a query to dynamically pull any set of issues from JIRA, and define which subset of those issues are considered done in your particular workflow.

In the first field, you should pull all issues that the team needs to complete that you would like to track.

ex. Project = K2-Web AND sprint = 42

The second field should be a subset of the first set and represent the specific issues that you consider completed in the larger set.

ex. Project = K2-Web AND sprint = 42 AND Resolution = Done

Force a Sync on a Single Jira Key Result:

  1. Select Key Result to go to the Key Results Details page.
  2. Choose the Kebab menu in the upper right-hand corner.
  3. Select Sync Integration Data.

mceclip0.png

Force a Sync for All Key Result Integrations:

  1. From the My Objectives Page, select the Kebab icon in the upper right-hand corner.
  2. Select Sync Integration Data.
Was this article helpful?
2 out of 3 found this helpful
Have more questions? Submit a request