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.
   
   
6. Pick Jira from the list of integrations.
   

   

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. 
   
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.
    
13. Copy the token.
    
14. Paste it into the WorkBoard Jira Connector login pop-up.
    
15. Select Sign in.
16. Once logged in you will be able to pull data from Jira using one of two methods. Choose how you want to get issue completion data from Jira
    Query Builder: The query builder provides search and filter fields to select Project, Issue Type, and Statuses to filter down to.
    
    JQL: For more advanced filtering options use the Advanced JQL field. JQL stands for Jira Query Language and is a special syntax that allows you to define a subset of content. 
    
    For an easy way to create JQL go to Jira and navigate to the advanced issue search. From this screen select Switch to Basic. For more information on JQL see Atlassian’s documentation on JQL.
    1. Once on the basic issue search you can use the jira UI to add any custom filters you need. 
    2. Select Switch to JQL and the JQL will be created for you. 
    3. Copy and paste this JQL into the JQL field in WorkBoard. 
       

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.

1. 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.

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

How Should Progress Be Calculated

When selecting how progress should be calculated there are two options: issue count and story points. Selecting issue count will return a direct count of all issues to be included. Selecting story points will use the Story Points field in Jira and return a sum of all story points from issues included in your query or JQL. Any null values will be counted as zero. 

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.

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.