• Updated

Needs review This article was migrated from Zendesk and has not yet been reviewed or aligned to the current article template.

This article explains how to gather the necessary information for your OnePlan group’s reporting OData feed and authentication key.

Private plan permissions are not enforced in reporting OnePlan does not enforce private plan permissions in the OData feed or in Power BI reports. Anyone with access to the feed or to a report built on it can see data from private plans. To keep private plan data separate, filter by plan type and create separate datasets for each audience. See Control Access to Private Plan Data in Reporting below.

Get an Authentication Key

  1. Go to the Admin page > Integrations. Integrations - New Key.png

  2. Click Add Key Screenshot_2021-12-01_150734.png to create a new key. The Add Key form will open.

Add Key.png

  1. Complete the Add Key form.

    1. Enter “Reporting” for the name (or whatever you want for your records). Enter an Expiration date and select the OData global scope. See the Required Authentication Key Permissions section below. Click ADD.

    2. Record and keep the generated key. As soon as you refresh or navigate away, the key turns to ***********.

New Key available.png

Required Authentication Key Permissions: OData Reporting

To create an authentication key for OData reporting in OnePlan, select the following settings in the Add Key form. For a description of each field, see How to Create and Rotate Authentication Keys in OnePlan.

Global Scopes — OData

No Data Type permissions are required for OData reporting. Grant only the OData scope so the key has the minimum access reporting needs.


Control Access to Private Plan Data in Reporting

OnePlan does not enforce private plan permissions in the OData feed or in Power BI reports. The feed returns data for all plans in the group, regardless of who can view them in OnePlan.

To keep private plan data from reaching the wrong audience, filter by plan type and publish separate datasets:

  1. In Power BI, filter the data by plan type so each dataset contains only the plans its audience should see.
  2. Create a separate dataset for each audience, for example one for private plans and one for all other plans.
  3. Share each dataset and its reports only with the people who are allowed to see that data.

Get the Report URL for the oData feed

  1. Go to the Admin page > Integrations.

  2. Save your Reporting URL (ex: https://my.oneplan.ai/odata/df05554f-573f-45eb-a653-fd9e397631a6). This is the OData feed. You will be prompted for your URL in a later step.

Reporting URL.png

See Deploy OnePlan reports for the next steps.

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.