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 and Transfer Data in Talend



Integrate Microsoft Planner data with standard components and data source configuration wizards in Talend Open Studio.

This article shows how you can easily integrate the CData JDBC driver for Microsoft Planner into your workflow in Talend. This article uses the CData JDBC Driver for Microsoft Planner to transfer Microsoft Planner data in a job flow in Talend.

Connect to Microsoft Planner in Talend as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Microsoft Planner:

  1. Add a new database connection to Microsoft Planner data: To add a new connection, expand the Metadata node, right-click the Db Connections node, and then click Create Connection.
  2. In the resulting wizard, enter a name for the connection.
  3. On the next page, select Generic JDBC from the DB Type menu and enter 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.

    A typical JDBC URL is below:

    jdbc:microsoftplanner:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
  4. Enter the path to the cdata.jdbc.microsoftplanner.jar file, located in the lib subfolder of the installation directory.
  5. Right-click the connection and then click Retrieve Schema.
  6. Click Next with the default options to select the tables you want to import.
  7. Finish the wizard with the default options.

Output the Tasks Table to a Flat File

You can follow the procedure below to transfer the Tasks table to a flat file output component:

  1. In the Table Schemas node, drag the tables to the workspace.
  2. In the dialog that is displayed, select the tJDBCInput component.
  3. Next, drag a tFileOutputDelimited component from the Business Intelligence tab of the Palette into the workspace.
  4. Right-click the Tasks tJDBCInput component and drag a vector to the output file.

Run the project to transfer the data.