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

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

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

Configure SAP SuccessFactors Connectivity for NodeJS

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

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

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

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

   You can authenticate to SAP Success Factors using Basic authentication or OAuth with SAML assertion.

   Basic Authentication

   You must provide values for the following properties to successfully authenticate to SAP Success Factors. Note that the provider will reuse the session opened by SAP Success Factors using cookies. Which means that your credentials will be used only on the first request to open the session. After that, cookies returned from SAP Success Factors will be used for authentication.

   • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
   • User: set this to the username of your account.
   • Password: set this to the password of your account.
   • CompanyId: set this to the unique identifier of your company.

   OAuth Authentication

   You must provide values for the following properties, which will be used to get the access token.

   • Url: set this to the URL of the server hosting Success Factors. Some of the servers are listed in the SAP support documentation (external link).
   • User: set this to the username of your account.
   • CompanyId: set this to the unique identifier of your company.
   • OAuthClientId: set this to the API Key that was generated in API Center.
   • OAuthClientSecret: the X.509 private key used to sign SAML assertion. The private key can be found in the certificate you downloaded in Registering your OAuth Client Application.
   • InitiateOAuth: set this to GETANDREFRESH.
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add SAP SuccessFactors 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 SuccessFactors data from Node.js.

Query SAP SuccessFactors from Node.js

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

Connect to SAP SuccessFactors 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: 'SAPSuccessFactors1'
	}
}

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

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