Add Issues Manually
Note: An administrator within your organization, needs to configure the JIRA integration before it can be used.
If you know which issues you'd like to link to your key result, you can manually add them:
Create objective → Enter key result → Integrations → JIRA
This will trigger a pop-up modal where you can perform a basic search that will go through your JIRA instance to locate issues that match the search term(s). Alternatively, you can use the advanced search option:
Select the check boxes next the issues that you'd like to add and click "Save". Lastly, set the target metric and click "Submit" on the key result itself. As you complete work in JIRA, the key result's progress will update automatically.
Note: Your JIRA permissions flow over to Betterworks meaning that if you don't have the ability to view an issue in your organization's JIRA instance, you won't be able to view in from the Betterworks integration.
Add Issues Using JQL
Often when you setup your objectives and key results, not all of the issues in JIRA have been established (i.e. "Fix all bugs related to 'x' feature by the end of the quarter"). To account for this, you can switch from basic search to the advanced search option and use a JQL query. Be sure to select "Automatically connect all issues matching the query to the key result":
If you're well versed in JQL, that's great! Feel free to search directly in Betterworks like you would in JIRA using JQL. If you could use a bit more practice on JQL, no problem. Any basic search in JIRA can be converted to a JQL by clicking "Advanced Search" within JIRA. You can then copy this string and paste it into our search bar as a JQL query. We've also included some sample JQL queries that you can leverage when creating your key results:
- Sample JQL for "Work assigned to me"
assignee=”[name]" AND updated>[quarter_beg] AND labels=OKR
- Sample JQL for "Epics for my team"
issuetype=Epic and project in ([project_team_name]) AND "Planned \"Done\" Date”>[quarter_beg] AND "Planned \"Done\" Date”<[quarter_end]
- Sample JQL for "Epics for my initiatives"
issuetype=Epic AND Initiative in ([initiative_name]) AND "Planned \"Done\" Date”>[quarter_beg] AND "Planned \"Done\" Date”<[quarter_end]
- Sample JQL for "Epics I have written"
issuetype=Epic AND reporter=”[name]" AND "Planned \"Done\" Date”>[quarter_beg] AND "Planned \"Done\" Date”<[quarter_end]
For a more in depth review of JQL, see JIRA's website.
My JIRA integrated key result isn't updating; how do I get it to work?
There are few items to immediately check:
- Has the associated key result's due date already passed. JIRA-integrated key results don't update after the due date. You will need to manually sync the key result by clicking additional actions and then sync.
- Loop in a member of your team who has access to the JIRA user account so they can see if the credentials are up-to-date.
- Does your JIRA issue still exist?
- Is your JQL string is complete and correct?
Can I update a JIRA ticket from Betterworks?
Not at this time. The JIRA integration can only pull information from JIRA. Users are not able to push data back to JIRA.
Can I use the JIRA integration for a select group of users?
No. When the JIRA integration is activated, all users will have the opportunity to link JIRA issues in Betterworks.
Can I see the full details of a JIRA ticket through Betterworks?
No. We only access three standard items via the JIRA integration: issue ID, issue title and issue resolution (issue open/closed). Additionally, our integration is able to pull data from any custom fields you've set up in order to more accurately inform progress on the integrated key results.
Note: Users can not see any other ticket data (such as description) from within Betterworks.
Can SSO be used to enable the Jira Integration?
Not at this time. It's not possible to use SSO to enable the Jira integration. We recommend either using a non-SSO account or looking into an official JIRA sanctioned way of managing this.