Ready to get started?

Download a free trial of the Microsoft Planner Driver to get started:

 Download Now

Learn more:

Microsoft Planner Icon Microsoft Planner JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft Planner.

Connect to Microsoft Planner Data in RazorSQL



Connect to Microsoft Planner from wizards and query Microsoft Planner data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for Microsoft Planner enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Microsoft Planner using wizards in RazorSQL.

Create a JDBC Data Source for Microsoft Planner Data

  1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
  2. In the Connection Wizard that appears, set the following properties:
    • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
    • Driver Class: Set the driver class to cdata.jdbc.microsoftplanner.MicrosoftPlannerDriver.
    • Username: Enter the username. (This property can also be set in the JDBC URL.)
    • Password: Enter the password. (This property can also be set in the JDBC URL.)
    • JDBC URL: Enter connection parameters. The JDBC URL begins 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.

      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.

      A typical JDBC URL is the following:

      jdbc:microsoftplanner:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH

Query Microsoft Planner Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.