Automated Continuous Microsoft Planner Replication to Apache Kafka

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live Microsoft Planner data into your Apache Kafka instance, allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure Apache Kafka as a Replication Destination

Using CData Sync, you can replicate Microsoft Planner data to Apache Kafka. To add a replication destination, navigate to the Connections tab.

1. Click Add Connection.
2. Select the Destinations tab and locate the Apache Kafka connector.
3. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Apache Kafka connector. For more information about installing new connectors, see Connections in the Help documentation.
4. To connect to Apache Kafka, set the following connection properties:
   • Connection Name: Enter a connection name of your choice for the Apache Kafka connection.
   • Bootstrap Servers: Enter the address of the Apache Kafka Bootstrap servers to which you want to connect.
   • Auth Scheme: Select the authentication scheme. Plain is the default setting. For this setting, specify your login credentials:
   • User: Enter the username that you use to authenticate to Apache Kafka.
   • Password: Enter the password that you use to authenticate to Apache Kafka.
   • Type Detection Scheme: Specify the detection-scheme type (None, RowScan, SchemaRegistry, or MessageOnly) that you want to use. The default type is None.
   • Registry Url: Enter the URL to the server for the schema registry.
   • Registry Service: Select the Schema Registry service that you want to use for working with topic schemas.
   • Registry Auth Scheme: Select the scheme that you want to use to authenticate to the schema registry.
   • Use SSL: Specify whether you want to use the Secure Sockets Layer (SSL) protocol. The default value is False.

5. Once connected, click Create & Test to create, test and save the connection.

You are now connected to Apache Kafka and can use it as both a source and a destination.

NOTE: You can use the Label feature to add a label for a source or a destination.

In this article, we will demonstrate how to load Microsoft Planner data into Apache Kafka and utilize it as a destination.

Configure the Microsoft Planner Connection

You can configure a connection to Microsoft Planner from the Connections tab. To add a connection to your Microsoft Planner account, navigate to the Connections tab.

1. Click Add Connection.
2. Select a source (Microsoft Planner).
3. Configure the 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.

   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.
   
4. Click Connect to Microsoft Planner to ensure that the connection is configured properly.
5. Click Save & Test to save the changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

Replicate Entire Tables

To replicate an entire table, navigate to the Task tab in the Job, click Add Tasks, choose the table(s) from the list of Microsoft Planner tables you wish to replicate into Apache Kafka, and click Add Tasks again.

Customize Your Replication

Schedule Your Replication

Select the Overview tab in the Job, and click Configure under Schedule. You can schedule a job to run automatically by configuring it to run at specified intervals, ranging from once every 10 minutes to once every month.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your Microsoft Planner data to Apache Kafka.

Run the Replication Job

Once all the required configurations are made for the job, select the Microsoft Planner table you wish to replicate and click Run. After the replication completes successfully, a notification appears, showing the time taken to run the job and the number of rows replicated.

Free Trial & More Information

Now that you have seen how to replicate Microsoft Planner data into Apache Kafka, visit our CData Sync page to explore more about CData Sync and download a free 30-day trial. Start consolidating your enterprise data today!

As always, our world-class Support Team is ready to answer any questions you may have.