Connect to Microsoft Planner Data in DBeaver

The CData JDBC Driver for Microsoft Planner implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Microsoft Planner data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Microsoft Planner Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
2. In the Driver Name box, enter a user-friendly name for the driver.
3. To add the .jar, click Add File.
4. In the create new driver dialog that appears, select the cdata.jdbc.microsoftplanner.jar file, located in the lib subfolder of the installation directory.
5. Click the Find Class button and select the MicrosoftPlannerDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.microsoftplanner.MicrosoftPlannerDriver.
6. Add jdbc:microsoftplanner: in the URL Template field.

Create a Connection to Microsoft Planner Data

Follow the steps below to add credentials and other required connection properties.

1. In the Databases menu, click New Connection.
2. In the Create new connection wizard that results, select the driver.
3. On the next page of the wizard, click the driver properties tab.

4. Enter values for authentication credentials and other properties required to connect to 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.

   Below is a typical connection string:

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

Query Microsoft Planner Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.