Query SAP ByDesign Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for SAP ByDesign to query SAP ByDesign data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to SAP ByDesign Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to SAP ByDesign data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query SAP ByDesign from Node.js

The following example shows how to define a connection and execute queries to SAP ByDesign with the mysql module. You will need the following information:

• Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
• Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
• Database name: The DSN you configured for the MySQL remoting service.

Connect to SAP ByDesign data and start executing queries with the code below:

var mysql = require('mysql');
var connection = mysql.createConnection({
 host : 'localhost',
 database : 'CData SAPByDesign Sys',
 port	 : '3306',
 user : 'mysql_user',
 password : 'test'
});
connection.connect();
connection.query('SELECT * FROM [Inventory Balance]', function(err, rows, fields) {
 if (err) throw err;
 console.log(rows);
});

connection.end();