Skip to main content
Language Selector

  1. Other Languages

    (machine translation)

Planview Customer Success Center

Accessing Planview OKR Data with OData

  1. Last updated
  2. Save as PDF

Overview

You can use OData as a data source for getting objective and key result (OKR) data from Planview OKRs, Planview Portfolios, and Planview AgilePlace to create reports with Microsoft Power BI. You can use the OKR OData service with Power BI by using one of the following methods:

  • With a Power BI report server: You can upload a Planview template with predefined dimensions, models, and relationships to the report service and build reports in Power BI Desktop. This method requires Planview Portfolios.
  • With the Power BI Service: You can use the Planview OKR connector, which uploads predefined dimensions you can use to build reports on the cloud-based Power BI service at powerbi.com. This method is best for AgilePlace customers that do not also have Planview Portfolios.

           

NOTE

Both methods require Planview Admin.

           

           

Setting Up the OKR OData Service for Use with a Power BI Report Server (PVCLOUD)

           

NOTE

There are two versions of Power BI Desktop—Power BI Desktop for Cloud and Power BI Desktop for Report Server. Both versions can be installed on the same report designer machine. The release schedule for these two products is different; Microsoft releases a new version of Power BI Desktop for Cloud every month and a new version for Report Server approximately every 4 months. To use the Planview OKR OData service with Planview Portfolios and the Power BI Report Server, use the September 2022 version of Power BI Desktop for Report Server, which you can download here.

           

To set up the OKR OData service for use with a Power BI report server:

  1. Download the OKR OData template file: OKR_OData_PBIRS_Template_V1.0.pbit
  2. In Power BI Desktop, open the template file.
  3. On the screen that appears, in the OKRs OData URL box, enter the URL for your OKR OData feed. 

               

    NOTE

    The URL for your OKR OData feed is one of the following options based on your geographic region:

    • https://odata-ap.okrs.planview.com/odata
    • https://odata-us.okrs.planview.com/odata
    • https://odata-eu.okrs.planview.com/odata

               

  4. In Planview Admin, an administrator must take the following actions to generate a new access token:
    1. Click the Settings menu.
    2. On the Settings screen, click the Services tab.
    3. Click Generate token in the OKRs Production box or the OKRs Sandbox box.
    4. On the Authentication token generated screen, after the access token text appears, click Copy token to copy the access token to the clipboard.
  5. In Power BI Desktop, enter the access token in the OkrReportingToken box and click Load.

    Power BI Desktop automatically loads the predefined dimensions, models, and the relationships from the template. The report itself is blank. You can now design a brand-new report using OKR data.

               

    IMPORTANT

    The access token is valid for 60 minutes. If designing the report takes more than one hour, you will need a Planview Admin administrator to generate a new access token and send it to you as explained in the previous step. However, after you finish designing a report, you will no longer need new access tokens if a Planview Portfolios administrator schedules a job stream as explained in the next step. 

               

               

    NOTE

    When selecting fields from the predefined dimensions to use in the report, note the following product name mappings that might appear:

    • A field for or from Planview Portfolios may include e1 or e1_prm in the name instead of portfolios.
    • A field for or from Planview AgilePlace may include leankit in the name instead of agileplace.

               

  6. In Planview Portfolios, an administrator must schedule a job stream to refresh the OData service. This job both refreshes the data and generates a new access token automatically.

For details about using OKRs, see Objectives and Key Results (OKRs) in Planview Portfolios, OKRs in AgilePlace, and Connected OKRs.

           

           

Setting Up the OKR OData Service for Use with the Power BI Service (POWERBI.COM)

           

NOTE

There are two versions of Power BI Desktop—Power BI Desktop for Cloud and Power BI Desktop for Report Server. Both versions can be installed on the same report designer machine. Microsoft releases a new version of Power BI Desktop for Cloud every month. To use the Planview OKR OData service with powerbi.com, make sure you have the latest version of Power BI Desktop for Cloud from Microsoft.

           

To use OData with OKRs and the Power BI service:

  1. In Power BI Desktop, in the Home ribbon, click Get Data.
  2. Search for the Planview OKR connector and click Connect.
  3. Click Continue to acknowledge the warning about connecting to a third-party service.
  4. On the screen that appears, in the Planview Admin URL box, enter the main part of the URL for your Planview Admin environment, such as https://example.exampleplanviewid.com.

               

    NOTE

    Do not include /admin or any part of the URL after that.

               

  5. In the Planview OKR OData URL box, enter the URL for your OKR OData feed.

               

    NOTE

    The URL for your OKR OData feed is one of the following options based on your geographic region:

    • https://odata-ap.okrs.planview.com/odata
    • https://odata-us.okrs.planview.com/odata
    • https://odata-eu.okrs.planview.com/odata

               

  6. Click OK.
  7. On the screen that appears, click Sign in.
  8. On the Planview Admin sign-in screen that appears, enter the email address for a Planview Admin administrator and click Continue.
  9. On the screen that appears, enter the password for the administrator account and click Sign In.
  10. After the Planview Admin sign-in screen closes, when you are back in Power BI Desktop, click Connect.

    Power BI Desktop automatically loads predefined dimensions that you can use to build models and design a brand-new report using OKR data. You can now publish your content to your powerbi.com workspace.