Make OKR data available in JQL through Jira issue properties

Owned by Annu
Last updated: Jul 23, 2024
4 min read

Background

At times, as a Jira user, one may want to search for Jira issues that are associated with UpRaise objectives as KR or with KRs as KR actions. Or easily see a consolidated list of linked Jira tickets (as a KR or a KR action) through Jira’s native JQL search.

To support this feature we have introduced a new family of issue properties with the property key - UpraiseOKR. Whenever a Jira ticket is linked to an objective (as a KR) or to a KR (as a KR action), system will store relevant information of the parent objective/KR against the corresponding issue property for that Jira ticket.

You can now enable this feature on your UpRaise instance. Read Make OKR data available in JQL through issue properties. This configuration can be enabled only by UpRaise admins.

Issue properties

Below are the issue properties that are introduced under the property key - UpraiseOKR. In the table below, you can refer to the JQL syntax and how to use each property.

Please notice in all the syntaxes and examples we have used issue.property[upraiseokr].<property1> AND issue.property[upraiseokr].<property2>.

Property

Use of the property

Syntax

linkType

  • This property is used to define the type of linkange Jira issue has in UpRaise, whether it is linked as KR or KR action

  • If a issue is linked as both KR to objective A and as a KR Action to KR A, then both the values will be stored against this property

  • issue.property[upraiseokr].linkType~'KR'

  • issue.property[upraiseokr].linkType~'KRAction'

parentObjId

  • This property helps you retrieve Jira issues linked as KR of KRA with specified objective id

  • If an issue is linked to multiple objectives, mulptiple IDs will be in comma-separated format

  • issue.property[upraiseokr].parentObjId~<'objective id'>

  • issue.property[upraiseokr].parentObjId~<'objective id1, Objective id 2'>

 

parentObjTitle

  • Use this property when you wish retrieve issues under specific objective title

  • If an issue is linked to multiple objectives, their titles can be stored in comma-separated format

  • issue.property[upraiseokr].parentObjTitle~<'objective Title'>

  • issue.property[upraiseokr].parentObjTitle~<'Title1, title2'>

parentObjOwner

  • To specify name of the owner of the parent objective when the issue is linked as KR

    • You need to specify display name of the Jira user

  • If an issue is linked to multiple objectives, their values will be stored in comma separated way

  • issue.property[upraiseokr].parentObjOwner~<'owner name'>

  • issue.property[upraiseokr].parentObjOwner~<'name1, name2'>

parentKRId

  • Id of the parent KR when the issue is linked as KR action

  • If an issue is linked to multiple KRs, their values will be stored in comma separated way

  • issue.property[upraiseokr].parentKRId~<'KR id'>

  • issue.property[upraiseokr].parentKRId~<'KR id1, KR id2'>

parentKRTitle

  • To specify title of the parent KR when the issue is linked as KR action

  • If an issue is linked to multiple KRs, their values will be stored in comma separated way

  • issue.property[upraiseokr].parentKRTitle~<'KR Title'>

  • issue.property[upraiseokr].parentKRTitle~<'KR Title1, KR Title2'>

parentKROwner

  • To specify name of the owner of the parent KR when you want to retrieve issues is linked as KR action under specific KR owner’s KRs

    • Use the display name of Jira user

  • If an issue is linked to multiple KRs, their values will be stored in comma separated way

  • issue.property[upraiseokr].parentKROwner~<'KR owner name'>

  • issue.property[upraiseokr].parentKROwner~<'KR owner name1,KR owner name2'>

objCycleTitle

  • To specify Objective Cycle Title in which the parent objective, parent KR, KR owner, etc might be included

  • If an issue is linked to multiple objectives/KRs from different cycles, their values will be stored in comma separated way

  • issue.property[upraiseokr].objCycleTitle~<'Obj cycle name'>

  • issue.property[upraiseokr].objCycleTitle~<'Obj cycle name1,KObj cycle name2'>

Use cases and examples

Here are some use cases and examples to show how each of the issue properties will be used in the JQL search. Please note the examples are just for your reference, you can try any JQLs as you use in Jira. However, it is important to understand and properly specify UpRaise issue properties to get the required results.

Issue property

Use Cases

Sample JQL

linkType

  • Use case 1 -

    • Search for all the issues from UP project added as KR to any objective in UpRaise

  • project = "UP" AND issue.property[upraiseokr].linkType~'KR'

 

  • Use case 2 -

    • Search for all the issues from UP project added as KR actions to any KR in UpRaise

  • project = "UP" AND issue.property[upraiseokr].linkType~'KRAction'

parentObjId

  • Use case 1-

    • Search for issues from project UP added as KR with a specific objective id

 

  • project = "UP" AND issue.property[upraiseokr].linkType~'KR' AND issue.property[upraiseokr].parentObjId~ 'OBJ-155'

  • Use case 2-

    • Search for issues from project UP added as KR action within KR/s of a specific objective id

  • project = "UP" AND issue.property[upraiseokr].linkType~'KRAction' AND issue.property[upraiseokr].parentObjId~ 'OBJ-155'

parentObjTitle

  • Use case 1-

    • Search for issues from project UP added as KR with objective of given title

  • project = "UP" AND issue.property[upraiseokr].linkType~'KR' AND issue.property[upraiseokr].parentObjTitle~ 'Increase Number of Channel Partners From 10 to 50'

  • Use case 2-

    • Search for issues from project UP added as KR action within given title of the objective

  • project = "UP" AND issue.property[upraiseokr].linkType~'KRAction'AND issue.property[upraiseokr].parentObjTitle~ 'Increase Number of Channel Partners From 10 to 50'

parentObjOwner

  • Use case 1-

    • Search for issues from project UP added as KR within objective owned by specific user/s

  • project = "UP" AND issue.property[upraiseokr].linkType~'KR' AND issue.property[upraiseokr].parentObjOwner~ 'john Doe, Peter David'

  • Use case 2-

    • Search for issues from project UP added as KR action within objective owned by specific user/s

  • project = "UP" AND issue.property[upraiseokr].linkType~'KRAction' AND issue.property[upraiseokr].parentObjOwner~ 'john Doe, Peter David'

parentKRId

  • Use case 1 -

    • Search for issues from project UP added as KR action within given objective KR id

  • project = "UP" AND issue.property[upraiseokr].linkType~'KRAction' AND issue.property[upraiseokr].parentKRId~'KR-123,KR-678'

parentKRTitle

  • Use case 1 -

    • Search for issues from project UP added as KR action with given KR title

  • project = "UP" AND issue.property[upraiseokr].linkType~'KRAction' AND issue.property[upraiseokr].parentKRTitle~ 'Complete regression for all releases scheduled this month'

parentKROwner

  • Use case 1 -

    • Search for issues from project UP added as KR action for KR owned by specific user/s

  • project = "UP" AND issue.property[upraiseokr].linkType~'KRAction' AND issue.property[upraiseokr].parentKROwner~ 'John doe, Peter David'

objCycleTitle

  • Use case 1 -

    • Search for all issues from project UP added as KR within objective/s of objective cycle’s title

  • project = "UP" AND issue.property[upraiseokr].linkType~'KR' AND issue.property[upraiseokr].objCycleTitle~'Jan-Dec 2023'

  • Use case 2 -

    • Search for issues added as KR actions within given within objective cycle’s title and owned by specific user/s

  • project = "UP" AND issue.property[upraiseokr].linkType~'KR' AND issue.property[upraiseokr].objCycleTitle~'Jan-Dec 2023' AND issue.property[upraiseokr].parentObjOwner~ 'john Doe, Peter David'

  • Use case 3 -

    • Search for issues added as KR actions and KRs within specified objective ids & within given given objective cycle name

  • project = "UP" AND issue.property[upraiseokr].objCycleTitle~'Jan-Dec 2023' AND issue.property[upraiseokr].parentObjId~ 'OBJ-100, OBJ-103'

Please note, this feature is not applicable for Jira issue KRs (via JQL) as clicking on the Jira issue KRs (via JQL) title from UpRaise itself will direct you to the list of issues.