Connect to Microsoft Planner Data in DBVisualizer

The CData JDBC Driver for Microsoft Planner implements JDBC standards to provide connectivity to Microsoft Planner data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to Microsoft Planner data in DBVisualizer and use the table editor to edit and save Microsoft Planner data.

Create a New JDBC Data Source for Microsoft Planner Data

Follow the steps below to use the Driver Manager to provide connectivity to Microsoft Planner data from DBVisualizer tools.

1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
2. Enter a name for the data source.
3. Enter the following in the URL Format box: jdbc:microsoftplanner:
   The DBVisualizer Driver Manager.
4. In the User Specified tab, click the Open File button and select the cdata.jdbc.microsoftplanner.jar file, located in the lib subfolder of the installation directory.
5. In the Driver Class menu, select the MicrosoftPlannerDriver class, cdata.jdbc.microsoftplanner.MicrosoftPlannerDriver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.

2. In the Connection section, set the following options:

   • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
   • Driver: Select the driver you just created.

   • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:microsoftplanner: followed by the connection properties in a semicolon-separated list of name-value pairs.

     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.

     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.

     A typical connection string is below:

     jdbc:microsoftplanner:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
   • Database UserId: The username to use to authenticate to Microsoft Planner.
   • Database Password: The password to use to authenticate to Microsoft Planner.

3. On the Connection tab, click Connect.

To browse through tables exposed by the Microsoft Planner JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.