Manage Microsoft Planner Data in DBArtisan as a JDBC Source

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Microsoft Planner JDBC Driver

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



Use wizards in DBArtisan to create a JDBC data source for Microsoft Planner.

The CData JDBC Driver for Microsoft Planner seamlessly integrates Microsoft Planner data into database management tools like DBArtisan by enabling you to access Microsoft Planner data as a database. This article shows how to create a JDBC source for Microsoft Planner in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Microsoft Planner Data into DBArtisan Projects

Follow the steps below to register Microsoft Planner data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic JDBC.
  3. Click Manage.
  4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
  5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

    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.

    Below is a typical connection string:

    jdbc:microsoftplanner:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
  6. Finish the wizard to connect to Microsoft Planner data. Microsoft Planner entities are displayed in the Datasource Explorer.

You can now work with Microsoft Planner data as you work with any other database. See the driver help documentation for more information on the queries supported by the Microsoft Planner API.