Enable everyone in your organization to access their data in the cloud — no code required.
Learn More →Enable the Microsoft Planner JDBC Driver in KNIME
Use standard data access components in KNIME to create charts and reports with Microsoft Planner data.
One of the strengths of the CData JDBC Driver for Microsoft Planner is its cross-platform support, enabling integration with major BI tools. Follow the procedure below to access Microsoft Planner data in KNIME and to create a chart from Microsoft Planner data using the report designer.
Define a New JDBC Connection to Microsoft Planner Data
- Install the Report Designer extension: Click File -> Install KNIME Extensions, and filter on "Report".
- In a new workflow, click File -> Preferences and expand the KNIME -> Databases node to add cdata.jdbc.microsoftplanner.jar. The driver JAR is located in the lib subfolder of the installation directory.
-
In the Node Repository view, expand the Database -> Read/Write node and drag a Database Reader onto the workflow editor.
-
Double-click the Database Reader and set the following properties:
- Database Driver: In the menu, select the driver name, cdata.jdbc.microsoftplanner.MicrosoftPlannerDriver
Database URL: Enter the connection properties. 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.
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- 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 JDBC URL is below.
jdbc:microsoftplanner:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
- User Name: The username used to authenticate.
- Password: The password used to authenticate.
- SQL Statement: Enter an SQL query in the SQL Statement box or double-click a table. This article uses the query below to create a chart:
SELECT TaskId, startDateTime FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'
-
Test the connection by clicking Fetch Metadata.
-
Connect the Database Reader to a Data to Report node to supply the dataset to a range of data visualization controls. Click Execute and then click Edit Report at the top of the workflow to open the report designer perspective.
-
You can now generate reports based on live data. To create a chart, drag the chart control from the palette to the report designer. In the resulting wizard, you can use the filtering and aggregation controls available in KNIME.
Troubleshooting
The following list shows how to resolve common errors:
- Encountered duplicate row Id "Row1": To resolve this error, add the following to the knime.ini file located in your KNIME installation directory:
-Dknime.database.fetchsize=0