Query Microsoft Planner Data as a SQL Server Database in Node.js



Execute SQL Server queries against Microsoft Planner data from Node.js.

You can use CData Connect Cloud to query Microsoft Planner data through a SQL Server interface. Follow the procedure below to create a virtual database for Microsoft Planner in Connect Cloud and start querying using Node.js.

CData Connect Cloud provides a pure MySQL, cloud-to-cloud interface for Microsoft Planner, allowing you to easily query live Microsoft Planner data in Node.js — without replicating the data to a natively supported database. As you query data in Node.js, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc) directly to Microsoft Planner, leveraging server-side processing to quickly return Microsoft Planner data.

Configure Microsoft Planner Connectivity for NodeJS

Connectivity to Microsoft Planner from NodeJS is made possible through CData Connect Cloud. To work with Microsoft Planner data from NodeJS, we start by creating and configuring a Microsoft Planner connection.

  1. Log into Connect Cloud, click Sources, and then click Add Connection
  2. Select "Microsoft Planner" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to Microsoft Planner.

    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 Create & Test
  5. Navigate to the Permissions tab in the Add Microsoft Planner Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect Cloud through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect Cloud. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect Cloud app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create.
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Microsoft Planner data from Node.js.

Query Microsoft Planner from Node.js

The following example shows how to define a connection and execute queries to Microsoft Planner with the SQL Server module. You will need the following information:

  • server: tds.cdata.com
  • port: 14333
  • user: a Connect Cloud user (e.g. [email protected])
  • password: the PAT for the above user
  • database: The connection you configured for Microsoft Planner (MicrosoftPlanner1)

Connect to Microsoft Planner data and start executing queries with the code below:

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: '[email protected]', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'MicrosoftPlanner1'
	}
}

sql.connect(config, err => { 
    if(err){
        throw err ;
    }
    new sql.Request().query('SELECT * FROM Tasks', (err, result) => {
        console.dir(result)
    })
        
});

sql.on('error', err => {
    console.log("SQL Error: " ,err);
})

Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

Free Trial