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

Ready to get started?

Learn more or sign up for a free trial:

CData Connect



Execute MySQL queries against SAP ByDesign data from Node.js.

You can use CData Connect Cloud to query SAP ByDesign data through a MySQL 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.

Create a Virtual MySQL Database for SAP ByDesign Data

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Connect Cloud and click Databases.
  2. Select "SAP ByDesign" from Available Data Sources.
  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 Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to SAP ByDesign data from any MySQL client.

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 address of your instance of the Connect Cloud (myinstance.cdatacloud.net) and the port (3306)
  • Username and password: The username and password of a user you authorized on Connect Cloud
  • Database name: The database you configured for SAP ByDesign (sapbydesigndb)

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

var mysql      = require('mysql');
var fs         = require('fs');
var connection = mysql.createConnection({
  host     : 'myinstance.cdatacloud.net',
  database : 'sapbydesigndb',
  port	   : '3306',
  user     : 'admin',
  password : 'password',
  ssl      : {
    ca : fs.readFileSync('C:/certs/myCA.pem')
  }
});
connection.connect();
connection.query('SELECT * FROM [Inventory Balance]', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();