Confluence integration

Owned by Derya Özdemir
Last updated: Mar 05, 2024 by Derya Özdemir
5 min read

This page is about OKR for Jira Cloud. Using Data Center? Click here.

This document explains how to display your OKR data directly within Confluence pages using 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. This allows you to share progress, collaborate with colleagues, and create reports without leaving your familiar Confluence environment.

Benefits of Displaying OKR Data in Confluence:

  • Improved Collaboration: Share OKR status with teammates directly in Confluence, fostering communication and alignment.

  • Streamlined Reporting: Generate reports directly on Confluence pages, eliminating the need for separate documents.

  • Centralized Information: Keep all project-related information, including OKRs, accessible in one place.

Prerequisites

  • You need to have a Confluence instance.

  • You must have permission to manage settings in your Confluence.

  • OKR for Jira and OKR for Confluence should be installed in your Jira instance.

Installation

Step 1: Download the app

  1. Visit the OKR for Confluence marketplace page and click Get it now.

  2. Wait for the app installation notification.

Step 2: Establish a connection with your Jira instance

  1. In Confluence, go to Settings > OKR for Jira connection (Atlassian Marketplace section).

  2. Verify the correct Jira instance and click Link.

    927e6601-8a48-4d0f-b9ed-d6eaaadd5aa9.png

  3. A new tab with your Jira instance will open. Approve the connection in your Jira instance.

    74db9b0d-f2a3-4890-b2d6-457ad38562ef.png

  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 Steps 3 and 4.

Using macros on Confluence

Macro 1: OKR Live View

This macro enables you to showcase your live OKR for Jira data on a Confluence page, making it easy to share with your colleagues and create action lists, plans, etc.

Adding the macro:

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

  2. There are two ways to add the OKR widget to your page:

    • Click the + icon in the top page menu and then search for the OKR live view macro.

    • Type in “/okr” on your Confluence page and the widget should be suggested as an item to add.

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

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

  5. Click Insert to add the macro to your page.

Your widget will look like this after saving the Confluence page:

The view setup will not be directly editable, but you can go back to the edit mode by clicking the pencil icon. You can also select the widget’s width in one of the three options available below the widget.

The OKR data displayed on the widget is synchronized with your data in the OKR for Jira app.

Macro 2: OKR Report

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

Adding the macro:

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

  2. There are two ways to add the OKR widget to your page:

    • Click the + icon in the top page menu and then search for the OKR report macro.

    • Type in “/okr” on your Confluence page and the widget should be suggested as an item to add.

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

  4. Select a period from which you’d like to display the data. This period will not be editable after saving the widget, but the data will be filterable, so ensure that you can search for the right OKRs before saving the configuration.
    You can also view the date and time for when your report is created. Currently, we only allow the generation of reports using current data.

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

  6. Click Insert to add the macro to your page.

Your widget will look like this:

The view setup will not be directly editable, but you can go back to the edit mode by clicking the pencil icon. You can also select the widget’s width in one of the three options available below the widget.

We hope this documentation helps you effectively utilize our OKR for Confluence app to keep your team aligned and informed! For more information, please refer to our documentation or contact our support team.