Access Microsoft Planner Data as OData Feeds in Tableau



Use the Tableau Desktop business intelligence tool to connect to Microsoft Planner data using the API Server.

The CData API Server, when paired with the ADO.NET Provider for Microsoft Planner (or any of 200+ other ADO.NET Providers), provides Microsoft Planner data as OData Web services. This article will explain how to use the API Server to provide the underlying connectivity to Microsoft Planner data in Tableau's business intelligence tool.

Set Up the API Server

Follow the steps below to begin producing secure Microsoft Planner OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Microsoft Planner

After you deploy the API Server and the ADO.NET Provider for Microsoft Planner, provide authentication values and other connection properties needed to connect to Microsoft Planner by clicking Settings -> Connections and adding a new connection in the API Server administration console.

You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Driver opens the MS Planner OAuth endpoint in your default browser. Log in and grant permissions to the Driver. The Driver then completes the OAuth process.

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

When you configure the connection, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

You can then choose the Microsoft Planner entities you want to allow the API Server to access by clicking Settings -> Resources.

Additionally, click Settings -> Server and set the Default Format to XML (Atom) for compatibility with Tableau.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Create Real-Time Microsoft Planner Data Visualizations

Follow the steps below to create data visualizations based on the remote Microsoft Planner data:

  1. In Tableau, select 'Connect to data'. In the 'On a server' section, click OData.

  2. In the resulting wizard, enter the URL of the OData endpoint for the API Server. Append the name of the table you want to access to the OData entry URL. For example:

    https://your-server/api.rsc/Tasks
  3. Select the 'Use a Username and Password' option and enter the username and password of a user who has access to the API Server.
  4. Tableau uses the table metadata exposed by the API Server to detect dimension and measure columns.

  5. To view the Microsoft Planner data, right-click under the table name in the Data section of the dashboard and select the View Data option. The Microsoft Planner data will appear in Tableau.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server