node-rfc: A JavaScript repository from PaulWieland

❗ Don't upgrade SAP NWRFC SDK on Darwin, see #143.

Asynchronous, non-blocking SAP NetWeawer RFC SDK client bindings for Node.js.

Features

Based on N-API standard
Stateless and stateful connections (multiple function calls in the same ABAP session (same context))
Async/await, promise and callback API
Sequential and parallel calls, using one or more clients
Automatic conversion between JavaScript and ABAP datatypes
Buffer, Decimal and Date objects support
Connection pool
🆕 Throughput monitoring: number of calls, bytes sent/received, application/total time; SAP NWRFC SDK >= 7.53 required

Supported platforms

Current and active nodejs LTS releases
The node-rfc connector can be built from source on all platforms supported by SAP NW RFC SDK and by nodejs
Pre-built binaries are provided for active nodejs LTS releases, for 64 bit Windows 8.1, Ubuntu 16.04 and macOS 10.14.

NodeJS platforms

Usage from other platforms:

Prerequisites

All platforms

SAP NW RFC SDK C++ binaries must be downloaded (SAP partner or customer account required) and locally installed (installation instructions). More information on SAP NW RFC SDK section on SAP Support Portal. Using the latest version is reccomended as SAP NW RFC SDK is fully backwards compatible, supporting all NetWeaver systems, from today S4, down to R/3 release 4.6C.
Build toolchain requires CMake
Build from source on macOS and older Linux systems, may require uchar.h file, attached to SAP OSS Note 2573953, to be copied to SAP NW RFC SDK include directory: documentation

Windows

Visual C++ Redistributable is required for runtime. The version is given in SAP Note 2573790 - Installation, Support and Availability of the SAP NetWeaver RFC Library 7.50
Build toolchain requires Microsoft C++ Build Tools, the latest version reccomended

macOS

Disable macOS firewall stealth mode (Can't ping a machine - why?):

sudo /usr/libexec/ApplicationFirewall/socketfilterfw --setstealthmode off

Add SAP NWRFC SDK libraries path to DYLD_FALLBACK_LIBRARY_PATH env variable:

$ export DYLD_FALLBACK_LIBRARY_PATH=$SAPNWRFC_HOME/lib:$DYLD_FALLBACK_LIBRARY_PATH

SPJ articles

A series of three insightful articles about RFC communication and SAP NW RFC Library, published in the SAP Professional Journal (SPJ)

Installation

After the SAP NW RFC SDK is installed on your system, you can install the node-rfc package from npm:

yarn add node-rfc

npm install node-rfc

Alternatively, or if the node-rfc package not provided for your platform, buld the package from the latest source and install:

git clone -b https://github.com/SAP/node-rfc.git
cd node-rfc
npm install
# set connection properties in test/abapSystem
npm test

Getting started

Note: the module must be installed before use.

In order to call remote enabled ABAP function module, we need to create a client with valid logon credentials, connect to SAP ABAP NetWeaver system and then invoke a remote enabled ABAP function module from nodejs.

Connection parameters for remote ABAP systems are documented in sapnwrfc.ini file, located in the SAP NWRFC SDK demo folder

The client can be used for one or more subsequent RFC calls and for more examples check unit tests.

Callback API example below shows basic principles. See also:

Examples and API
node-rfc documentation, complementing SAP NW RFC Library programming guide and documentation

"use strict";

const Client = require("node-rfc").Client;

// ABAP system RFC connection parameters
const abapSystem = {
    user: "demo",
    passwd: "welcome",
    ashost: "10.68.104.164",
    sysnr: "00",
    client: "620",
    lang: "EN",
};

// create new client
const client = new Client(abapSystem);

// echo SAP NWRFC SDK and nodejs/RFC binding version
console.log("Client version: ", client.version);

// open connection
client.connect(function (err) {
    if (err) {
        // check for login/connection errors
        return console.error("could not connect to server", err);
    }

    // invoke ABAP function module, passing structure and table parameters

    // ABAP structure
    const structure = {
        RFCINT4: 345,
        RFCFLOAT: 1.23456789,
        // or RFCFLOAT: require('decimal.js')('1.23456789'), // as Decimal object
        RFCCHAR4: "ABCD",
        RFCDATE: "20180625", // in ABAP date format
        // or RFCDATE: new Date('2018-06-25'), // as JavaScript Date object
    };

    // ABAP table
    let table = [structure];

    client.invoke(
        "STFC_STRUCTURE",
        { IMPORTSTRUCT: structure, RFCTABLE: table },
        function (err, res) {
            if (err) {
                return console.error("Error invoking STFC_STRUCTURE:", err);
            }
            console.log("STFC_STRUCTURE call result:", res);
        }
    );
});

Finally, the connection is closed automatically when the instance is deleted by the garbage collector or by explicitly calling the client.close() method on the client instance.

Known Issues

NAPI Type checks nodejs/node-addon-api/#265

How to obtain support

If you encounter an issue or have a feature request, you can create a ticket.

Check out the SCN Forum (search for "node-rfc") and stackoverflow (use the tag "node-rfc"), to discuss code-related problems and questions.

PaulWieland/node-rfc