We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Integrate Microsoft Planner Data in the Pentaho Report Designer
Publish reports based on Microsoft Planner data in the Pentaho BI tool.
The CData JDBC driver for Microsoft Planner data enables access to live data from dashboards and reports. This article shows how to connect to Microsoft Planner data as a JDBC data source and publish reports based on Microsoft Planner data in Pentaho.
Connect and Create a Report
- Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
- Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Microsoft Planner connection. In the resulting dialog, configure the connection properties as shown below.
Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:microsoftplanner: and is followed by a semicolon-separated list of connection properties.
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.
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- Saves OAuth values in OAuthSettingsLocation to be persisted across connections.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Microsoft Planner JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.microsoftplanner.jar
Fill in the connection properties and copy the connection string to the clipboard.
When you configure the JDBC URL, 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.
Below is a typical JDBC URL:
jdbc:microsoftplanner:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
- Custom Driver Class Name: Enter cdata.jdbc.microsoftplanner.MicrosoftPlannerDriver.
- User Name: The username to authenticate with.
- Password: The password to authenticate with.
Add Microsoft Planner Data to a Report
You are now ready to create a report with Microsoft Planner data.
-
Add the Microsoft Planner source to your report: Click Data -> Add Data Source -> JDBC and select the data source.
Configure the query. This article uses the one below:
SELECT TaskId, startDateTime FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'
- Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Tasks table.
- Finally, run the report to see the chart.