Query Blackbaud FE NXT Data as a MySQL Database in Node.js

You can use the SQL Gateway from the ODBC Driver for Blackbaud FE NXT to query Blackbaud FE NXT 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 Blackbaud FE NXT 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.

Blackbaud Financial Edge NXT uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

See the Getting Started guide in the CData driver documentation for more information.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Blackbaud FE NXT 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.

Query Blackbaud FE NXT from Node.js

The following example shows how to define a connection and execute queries to Blackbaud FE NXT 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 Blackbaud FE NXT data and start executing queries with the code below:

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

connection.end();