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



Execute SQL Server queries against SAP ByDesign data from Node.js.

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

CData Connect Cloud 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 Cloud 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 Cloud. To work with SAP ByDesign data from NodeJS, we start by creating and configuring a SAP ByDesign connection.

  1. Log into Connect Cloud, click Connections and click Add Connection
  2. Select "SAP ByDesign" from the Add Connection panel
  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.
  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add SAP ByDesign Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

  1. Click on your username at the top right of the Connect Cloud app and click User Profile.
  2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
  3. Give your 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, 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 Cloud 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);
})

Ready to get started?

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

Free Trial