Display OKR data in Confluence

Why should I display OKR data in Confluence?

Macros added to your Confluence pages will allow you to share OKR status with coworkers with whom you work within Confluence and create OKR reports on Confluence pages.

How can I display my OKR data on a Confluence page?

You can display OKR data on a Confluence page by installing our OKR for Confluence app. It’s a free add-on that will allow you to add widgets with your OKR data to any Confluence page connected to your instance.

Downloading the app

1. Go to our marketplace page

2. Click on the Get it now button
   
   

   Open

   

3. Wait until you get a notification that the app is installed.
   
   

Establishing a connection with your Jira instance

1. Go to Settings → OKR for Jira connection (Atlassian Marketplace section) in your Confluence (you need to have permission to manage settings in your Confluence)
   
   

   Open

   

2. Check if the right Jira instance is prefilled on the page (the instance where you have the OKR app installed). Click on the “Link” button.

    

3. A new tab with your Jira instance will open. Click on the “Approve” button to establish the connection.
   
   

    

4. A new tab with your Confluence will open. It will inform you if the connection is established correctly.
   
   

   
   
   

5. You can now close the tabs opened in step 3&4.

Macro 1: OKR live view

This macro allows you to display your live OKR for Jira data on a Confluence page in order to share them with your coworkers, and create action lists, plans, etc.

1. Open any Confluence page on the instance on which you’ve created the connection.

2. There are 2 ways to add the OKR widget to your page:
   - by clicking on the “+” icon in the top page menu and then searching for the OKR live view macro
   
   

   
   - by typing in “/okr” on your Confluence page - the widget should be suggested as an item to add
   
   

3. After choosing the OKR live view widget, a setup dialog will appear. At this stage, you can customize the view in any way you like. Set up the columns' width order, choose which columns should be visible, and how the view should be filtered and sorted. It works in exactly the same way you’re used to in our Jira app.

4. When it’s all configured, click the “Insert” button. After inserting the widget the view setup will not be directly editable, but you could go back to the edit mode anytime by clicking on the pencil icon. You can also choose the widget’s width in one of the 3 options available below the widget.

5. Your widget will look like this after saving the Confluence page

Macro 2: OKR report

This macro allows you to display frozen OKR for Jira data from a current date&time only. The data displayed will not be updated after adding the macro to the page.

1. Open any Confluence page on the instance on which you’ve created the connection.
   
   

2. There are 2 ways to add the OKR widget to your page:
   - by clicking on the “+” icon in the top page menu and then searching for the OKR report macro
   
   

   - by typing in “/okr” on your Confluence page - the widget should be suggested as an item to add
   
   

3. After choosing the OKR report macro, a setup dialog will appear.
   
   

   
   You can choose a period from which you’d like to display the data. This period will not be editable after saving the widget, however, the data will be filtrable, so make sure you’re able to search for the right OKRs before saving the configuration.

   
   You can also see the date & time for which your report is created. As of now, we allow generating such reports with current data only.
   
   At this stage, you can also customize the view in any way you like. Set up the columns' width order, choose which columns should be visible, and how the view should be filtered and sorted. It works in exactly the same way you’re used to in our Jira app and it will be editable after you save the macro in the edit mode.
   
   

4. When it’s all configured, click the “Insert” button. After inserting the widget the view setup will not be directly editable, but you could go back to the edit mode anytime by clicking on the pencil icon. You can also choose the widget’s width in one of the 3 options available below the widget.