Query SAP ByDesign Data as a SQL Server Database in Node.js

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

CData Connect AI provides a pure MySQL, cloud-to-cloud interface for SAP ByDesign, allowing you to easily query live SAP ByDesign 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 SAP ByDesign, leveraging server-side processing to quickly return SAP ByDesign data.

Configure SAP ByDesign Connectivity for NodeJS

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

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

2. Select "SAP ByDesign" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect to SAP ByDesign.

   Set the following connection properties to connect to SAP ByDesign.

   • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
   • User: Set this to the username of your account.
   • Password: Set this to the password of your account.
   • CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
     If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add SAP ByDesign Connection page and update the User-based permissions. 👁 Updating 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. 👁 Creating a new PAT
   
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 SAP ByDesign data from Node.js.

Query SAP ByDesign from Node.js

The following example shows how to define a connection and execute queries to SAP ByDesign 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 SAP ByDesign (SAPByDesign1)

Connect to SAP ByDesign 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: 'SAPByDesign1'
	}
}

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

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