Manage Browse OKR page's on-screen filters via URL query parameters

 

Background

UpRaise retains the last visited OKR view and applied on-screen filters. However, if users want to share the Browse OKR URL link with others or save it as a Jira shortcut, it is not helpful behavior as the existing onscreen filters are applicable and that may not be useful for other users. This is where we brought up the possibility of querying the URL parameters.

Use cases based on the on-screen filters on browse OKRs page

Key points

  • Whenever you have edited the URL, make sure you refresh the URL to apply the changes.

  • The existing on-screen filters or any change in on-screen filter gets reflected in the URL.

On-screen filter

Sample URL Query and Syntax

Comments

Default OKR filters

  • You do not want any impact on on-screen filters & retain them as they are

  • you want to switch from one OKR view to another

 

 

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464

  • In the existing URL, change the view ID and refresh the page. System loads the view with exiting on-screen filters for the view of the given view ID.

Unit

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?unit=25,26

  • You need to add the unit ID in the URL to add a relevant unit/s as the filter value (25,26 here in sample URL )

  • If the unit feature is disabled, there will be a step-by-step check-

    • First system checks if the View ID is correct & is accessible to the given user

    • If view ID is correct, then system checks all the filters & their values from the query params one by one

    • Even if one or more (either labels or values) are incorrect, relevant error will be displayed.

Level

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?level=2,1

You need to add the objective level ID in the URL to add a relevant level/s as the filter value (2,1 here in sample URL )

Teams

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?team=1356,1411

Add team’s ID to the URL to add relevant team/s as filter values (here 1356,1411 in sample URL )

Team type

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?teamtype=12020,12021

Add team type’s ID to the URL to add relevant team type option/s as filter values (here 12020,12021 in sample URL )

Objective cycle

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?cycle=2766

Add the cycle ID/s to select specific cycle/s as the objective cycle filter’s value (here 2766 in the sample URL )

Owner

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?owner=7452

Add the user ID/s to select specific user/s as the user filter’s value (here 7452 in the sample URL )

Status

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?status=10,20

Add the objective status ID/s to select specific status/es as the filter’s value (here 10,20 in the sample URL )

Labels

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?label=11415,11416

Add the label ID/s to select specific label/s as the filter’s value (here 11415,11416 in the sample URL )

Objective start date from and to

 

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?startdate_from=2024-05-01&startdate_to=2024-06-11

  • Add the from and to dates to select specific duration of objectives start dates in the filter (here startdate_from=2024-05-01&startdate_to=2024-06-11in the sample URL )

  • The supported date formats are-

    • YYYY/MM/DD

    • YYYY-MM-DD

Objective due date from and to

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?duedate_from=2024-06-12&duedate_to=2024-06-18

Add the from and to dates to select specific duration of objectives end dates in the filter (here duedate_from=2024-06-12&duedate_to=2024-06-18 in the sample URL )

  • The supported date formats are-

    • YYYY/MM/DD

    • YYYY-MM-DD

Owner’s team/s

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?ownerteams=1356

Add owner’s team’s ID to the URL to add relevant team/s as filter values (here 1356 in sample URL )

Title

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?title=Achieve+a+CSAT+of+90%%2B+for+all+tier-1+tickets

Add relevant objective title to the URL as filter value (here Achieve+a+CSAT+of+90%%2B+for+all+tier-1+tickets in sample URL )

Objective alignment

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?alignment=1,2

Add ID of objective alignment type to the URL as filter values (here 1,2 in sample URL)

Filter Key Results strictly

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=UPES&project.id=10000#!/okrs/browse/view/12464?strict_filters=true

Add true or false based on whether the strict filtering should be applied or not

OKR Custom fields

Custom fields

 

There are 8 types of OKR custom fields and possible values to be added in URL as below -

  • Text field (single line) -

    • Syntax - custom_<fid>=<text>

    • Eg.- title=<text>

  • Text field (multiple line)

    • Syntax - custom_<fid>=<text>

    • Eg. title=<text>

  • Select list (single choice)

    • Syntax - custom_<fid>=<id1>

    • Eg. - team=<id1>

  • Select list (multiple choice)

    • Syntax - custom_<fid>=<id1>,<id2>

    • Eg. - team=<id1>,<id2>...

  • Date picker - From and to dates in the below formats -

    • YYYY/MM/DD

    • YYYY-MM-DD

  • Syntax -

    • custom_<fid>_from=<date>

    • Eg. startdate_from=<date>

    • custom<fid>_to=<date>

    • Eg. startdate_to=<date>

  • Numeric field -

  • Syntax -

    • custom_<fid>_min=<number>

    • custom_<fid>_max=<number>

  • User picker (single select) -

    • Syntax - custom_<fid>=<id1>

    • Eg. - owner=<id1>

  • User picker (multiple select) -

    • custom_<fid>=<id1>,<id2>

    • Eg. - owner=<id1>,<id2>

Based on custom fields values will differ as mentioned above.

Other options and errors

You want to reset the on-screen filters completely for the same view or a different view

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu#!/okrs/browse/view/6965?filtersreset

  • With this, you will be navigated to the selected view but on-screen filters will be reset (as if the ‘reset’ link was clicked on-screen)

  • However, the on-screen filters will continue to be available on the screen without any values in them

You want to apply multiple on-screen filters like teams, owner, manager, designation, etc. (check above list of filters for detailed explanations for each filter in default filter section)

<baseURL>/plugins/servlet/ac/amoeboids.people/people-menu?project.key=AA&project.id=10848&servicedesk.serviceDeskId=6#!/okrs/browse/view/972?level=2&status=&cycle=&owner=&title=&team=305

  • User will be navigated to the selected view based on given view ID

  • Given on-screen filters will be applied (only for filters that are passed onto the URL)

  • While no filter from the screen will be removed, new filters will be added if they were not visible on the screen before but their values were passed through the URL

    • If any existing on-screen filters had values, the values will be removed but the filters will remain visible on the screen.

View IDs (user id, label id, etc.) passed by the user is incorrect for a given user

 

Relevant error will be displayed to the user. There will be no impact on the on-screen filters.

Filter labels and/or values are incorrect in the query parameters

 

There will be a step-by-step check -

  • First system checks if the View ID is correct & is accessible to the given user

  • If view ID is correct, then system checks all the filters & their values from the query params one by one

  • Even if one or more (either labels or values) are incorrect, relevant error will be displayed.

On this page