Stream Microsoft Planner Data into Apache Kafka Topics

Apache Kafka is an open-source stream processing platform that is primarily used for building real-time data pipelines and event-driven applications. When paired with the CData JDBC Driver for Microsoft Planner, Kafka can work with live Microsoft Planner data. This article describes how to connect, access and stream Microsoft Planner data into Apache Kafka Topics and to start Confluent Control Center to help users secure, manage, and monitor the Microsoft Planner data received using Kafka infrastructure in the Confluent Platform.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Microsoft Planner data. When you issue complex SQL queries to Microsoft Planner, the driver pushes supported SQL operations, like filters and aggregations, directly to Microsoft Planner and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Microsoft Planner data using native data types.

Prerequisites

Before connecting the CData JDBC Driver for streaming Microsoft Planner data in Apache Kafka Topics, install and configure the following in the client Linux-based system.

1. Confluent Platform for Apache Kafka
2. Confluent Hub CLI Installation
3. Self-Managed Kafka JDBC Source Connector for Confluent Platform

Define a New JDBC Connection to Microsoft Planner data

1. Download CData JDBC Driver for Microsoft Planner on a Linux-based system
2. Follow the given instructions to create a new directory extract all the driver contents into it:
   1. Create a new directory named Microsoft Planner mkdir MicrosoftPlanner
   2. Move the downloaded driver file (.zip) into this new directory mv MicrosoftPlannerJDBCDriver.zip MicrosoftPlanner/
   3. Unzip the CData MicrosoftPlannerJDBCDriver contents into this new directory unzip MicrosoftPlannerJDBCDriver.zip
3. Open the Microsoft Planner directory and navigate to the lib folder ls cd lib/
4. Copy the contents of the lib folder of Microsoft Planner into the lib folder of Kafka Connect JDBC. Check the Kafka Connect JDBC folder contents to confirm that the cdata.jdbc.microsoftplanner.jar file is successfully copied into the lib folder cp * ../../confluent-7.5.0/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/ cd ../../confluent-7.5.0/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
5. Install the CData Microsoft Planner JDBC driver license using the given command, followed by your Name and Email ID java -jar cdata.jdbc.microsoftplanner.jar -l
6. Enter the product key or "TRIAL" (In the scenarios of license expiry, please contact our CData Support team)
7. Start the Confluent local services using the command: confluent local services start

   This starts all the Confluent Services like Zookeeper, Kafka, Schema Registry, Kafka REST, Kafka CONNECT, ksqlDB and Control Center. You are now ready to use the CData JDBC driver for Microsoft Planner to stream messages using Kafka Connect Driver into Kafka Topics on ksqlDB.

8. Create the Kafka topics manually using a POST HTTP API Request: curl --location 'server_address:8083/connectors' --header 'Content-Type: application/json' --data '{ "name": "jdbc_source_cdata_microsoftplanner_01", "config": { "connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", "connection.url": "jdbc:microsoftplanner:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;; InitiateOAuth=GETANDREFRESH", "topic.prefix": "microsoftplanner-01-", "mode": "bulk" } }'

   Let us understand the fields used in the HTTP POST body (shown above):

   • connector.class: Specifies the Java class of the Kafka Connect connector to be used.
   • connection.url: The JDBC connection URL to connect with Microsoft Planner data.

     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.

     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.

   • topic.prefix: A prefix that will be added to the Kafka topics created by the connector. It's set to "microsoftplanner-01-".
   • mode: Specifies the mode in which the connector operates. In this case, it's set to "bulk", which suggests that the connector is configured to perform bulk data transfer.

   This request adds all the tables/contents from Microsoft Planner as Kafka Topics.

   Note: The IP Address (server) to POST the request (shown above) is the Linux Network IP Address.

9. Run ksqlDB and list the topics. Use the commands: ksql list topics;
10. To view the data inside the topics, type the SQL Statement: PRINT topic FROM BEGINNING;

Connecting with the Confluent Control Center

To access the Confluent Control Center user interface, ensure to run the "confluent local services" as described in the above section and type http://<server address>:9021/clusters/ on your local browser.

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for Microsoft Planner and start streaming Microsoft Planner data into Apache Kafka. Reach out to our Support Team if you have any questions.