Query NetSuite SuiteAnalytics Data as a SQL Server Database in Node.js

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

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

Configure NetSuite SuiteAnalytics Connectivity for NodeJS

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

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "NetSuite SuiteAnalytics" from the Add Connection panel

3. Enter the necessary authentication properties to connect to NetSuite SuiteAnalytics.

   Prerequisites

   Before you can connect to NetSuite SuiteAnalytics, you must set up SuiteAnalytics Connect in your NetSuite account:

   1. Enable the Connect Service feature.

      1. Ensure that your Account Administrator has enabled your Account and Role with the Connect Service feature.

      2. Navigate to Setup > Company > Enable Features.

      3. Click the Analytics tab and check the SuiteAnalytics Connect box.

   2. Add the SuiteAnalytics Connect permission to an existing Role, and note the Role ID for later.

   3. Find the Settings portlet on your home page and click Set Up SuiteAnalytics Connect, then click Your Configuration to view your service host and account ID. These settings map directly to the Server and Account Id properties.

   Add the NetSuite SuiteAnalytics Connection

   1. Open the Sources page of the Connect Cloud dashboard.

   2. Click Add Connection and select NetSuite SuiteAnalytics from the list of connectors.

   3. Enter a Connection Name of your choice.

   Authenticate to NetSuite SuiteAnalytics

   Set the following required properties:

   • Server: The Service Host value you found when setting up SuiteAnalytics Connect.

   • Account Id: The Account ID value you found when setting up SuiteAnalytics Connect.

   • Role Id: The internal ID of the login role you granted the SuiteAnalytics Connect permission.

   Next, choose one of the supported authentication methods:

   Basic authentication

   • User: The username you use to authenticate to your NetSuite account.

   • Password: The password associated with that account.

   Token-based authentication

   • Consumer Key and Consumer Secret: Generated when you create your integration record in NetSuite.

   • Token Key and Token Secret: The access token and secret generated for that integration.

   After you enter your credentials, click Save & Test to validate the connection.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add NetSuite SuiteAnalytics Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI 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 AI. 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 AI 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 NetSuite SuiteAnalytics data from Node.js.

Query NetSuite SuiteAnalytics from Node.js

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

• server: tds.cdata.com
• port: 14333
• user: a Connect AI user (e.g. [email protected])
• password: the PAT for the above user
• database: The connection you configured for NetSuite SuiteAnalytics (SuiteAnalytics1)

Connect to NetSuite SuiteAnalytics 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: 'SuiteAnalytics1'
	}
}

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

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