Access Microsoft Planner Data in Mule Applications Using the CData JDBC Driver

The CData JDBC Driver for Microsoft Planner connects Microsoft Planner data to Mule applications enabling read , write, update, and delete functionality with familiar SQL queries. The JDBC Driver allows users to easily create Mule applications to backup, transform, report, and analyze Microsoft Planner data.

This article demonstrates how to use the CData JDBC Driver for Microsoft Planner inside of a Mule project to create a Web interface for Microsoft Planner data. The application created allows you to request Microsoft Planner data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData JDBC Driver to create a Web interface for the 200+ available data sources.

1. Create a new Mule Project in Anypoint Studio.
2. Add an HTTP Connector to the Message Flow.
3. Configure the address for the HTTP Connector.
4. Add a Database Select Connector to the same flow, after the HTTP Connector.
5. Create a new Connection (or edit an existing one) and configure the properties.
   • Set Connection to "Generic Connection"
   • Select the CData JDBC Driver JAR file in the Required Libraries section (e.g. cdata.jdbc.microsoftplanner.jar).
   • Set the URL to the connection string for Microsoft Planner

     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.

     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.

   • Set the Driver class name to cdata.jdbc.microsoftplanner.MicrosoftPlannerDriver.
   • Click Test Connection.
6. Set the SQL Query Text to a SQL query to request Microsoft Planner data. For example: SELECT TaskId, startDateTime FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'
7. Add a Transform Message Component to the flow.
8. Set the Output script to the following to convert the payload to JSON:

   %dw 2.0
   output application/json
   ---
   payload
           

9. To view your Microsoft Planner data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default): http://localhost:8081. The Microsoft Planner data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with Microsoft Planner data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the JDBC Driver for Microsoft Planner and see the CData difference in your Mule Applications today.