SAP Netweaver RFC SDK Bindings for Node.js
This module provides bindings to the SAP Netweaver RFC SDK. With it, you will be able to call remote enabled function modules of a SAP system. Opening the connection and function invocations are fully/partially asynchronous operations, which will call a callback function upon completion.
Note: In order to use this module you will have to obtain the SAP NW RFC SDK via http://service.sap.com. For further instructions see OSS note 1025361.
- Extract the SDK archive with SAPCAR
- Copy the files from the lib and include folders to the corresponding system directories (/usr/local/Lib /usr/local/include)
./SAPCAR_3-20002089.EXE -xf NWRFC_8-20004549.SARcd nwrfcsdkcp ./lib/* /usr/libcp ./include/* /usr/inlude
- Extract the SDK archive with SAPCAR
- Copy the files from the lib folder to C:\Windows\system32
- Warning: If you are working with NodeJS 32-bit on a Windows 64-bit OS, you should copy the files to C:\Windows\SysWOW64 instead.
OS X is not supported due to the fact that there is no suitable SAP RFC NW SDK available. The module will compile but fail when trying to lazy-load its dependencies.
Installation (both Linux and Windows)
- You may now download the addon from the npm registry and install it by using the
npm install sapnwrfc
As with all other Node.js modules, you need to require it:
var sapnwrfc = ;
var conParams =ashost: '192.168.0.10'sysid: 'NPL'sysnr: '42'user: 'DEVELOPER'passwd: 'password'client: '001'lang: 'E';
Set path to sapnwrfc.ini
Before you open a connection you can set the directory path to look for the
var con = ;var iniPath = '/path/to/dir/with/inifile/in/it'con;
Opening the connection
Before you can invoke a remote function, you will have to open a connection to the SAP system.
- callback: A function to be executed after the connection has been attempted. In case of an error, an errorObject will be passed as an argument.
versionInfo = Connection;
- versionInfo: An Array containing major number, minor number and patch level of the NW RFC SDK
var con = ;con;
Calling a remote function module
This is a two step process:
- You will first have to lookup the function module's definition, getting a Function object in return
- After a successful lookup, you may invoke the function and pass arguments to it
However, you can use the Function object subsequently multiple times for invocations, without having to do another lookup upfront.
functionObject = Connection
- functionModuleName: A string containing the name of the remote function module to be called
For the sake of simplicity, the following example will neither pass arguments to the remote function nor receive a result:
var func = con;func;
Passing and receiving arguments
Assigning primitive types (non-structures, non-tables) is straightforward. You will, however, have to take care that the argument matches the parameter's data type. E.g. if the parameter type is an integer, you may not assign a string value to it.
var params =QUESTION: 'How are you';var func = con;func;
var func = con;var params = QUESTION: '00FF65' 'hex' ;func;
var params =IMPORTSTRUCT: RFCFLOAT: 314159 RFCINT1: 123 RFCTIME: '094500' RFCCHAR4: 'NODE';var func = con;func;
var table =I: 1 C: 'A' STR: 'String1'I: 2 C: 'B' STR: 'String2'I: 3 C: 'C' STR: 'String3';var params =IMPORT_TAB: table;var func = con;func;
Retrieving function signature as JSON Schema
You can retrieve the name and types of remote function arguments with MetaData() call.
var func = con;var signature = func;console;
The console output is:
"title": "Signature of SAP RFC function STFC_STRING""type": "object""properties":"MYANSWER":"type": "string""length": "0""sapType": "RFCTYPE_STRING""description": """sapDirection": "RFC_EXPORT""QUESTION":"type": "string""length": "0""sapType": "RFCTYPE_STRING""description": """sapDirection": "RFC_IMPORT"
The result of function MetaData() is an object of JSON Schema.
The properties sub-object specifies the parameter of the remote function. In the above example the remote function STFC_STRING has the parameters MYANSWER and QUESTION. The sapDirection specifies if it is an input parameter (RFC_IMPORT) or output parameter (RFC_EXPORT) or input and/or output (RFC_CHANGING | RFC_TABLES).
Attributes with the prefix sap are specific to this JSON Schema instance.
- title: Name of the JSON Schema.
- length: Length of a simple type or structure.
- description: Description of parameters from SAP. Can be empty.
- sapType: Native SAP type. RFCTYPE_TABLE | RFCTYPE_STRUCTURE | RFCTYPE_STRING | RFCTYPE_INT | RFCTYPE_BCD | RFCTYPE_FLOAT | RFCTYPE_CHAR | RFCTYPE_DATE | RFCTYPE_TIME | RFCTYPE_BYTE | RFCTYPE_NUM | ... . You find the complete list of possible values in the SAP header file sapnwrfc.h. Look for enum type RFCTYPE.
- sapDirection: Attribute of the first level of properties. RFC_IMPORT | RFC_EXPORT | RFC_CHANGING | RFC_TABLES
- sapTypeName: Name of a structure or name of a structure of a table.
- Alfred Gebert
- Stefan Scherer
- Michael Scherer
- Szilard Novaki
- Jakub Zakrzewski
- Add SetIniPath
- RAW fields and XSTRINGs return/expect node Buffers
- Automatic builds for Linux and Windows
- Add tests
- Add gulp script for bulk compiling
- Support for Node.js 4.x (and io.js)
- Fix library path issue (Windows)
- Add parameter msvs_nwrfcsdk_path for node-gyp
- Add MetaData()
- Support for Node.js 0.10
- Fix compilation on Linux (issue #2)
- Support for Node.js >= 0.7.9
- Change global invocation lock to a connection based lock
- Unit tests
- Missing but probably useful functions:
- RfcIsConnectionHandleValid (aka Connection::IsOpen())
- RfcRemoveFunctionDesc (invalidate cache)
- Use of buffers for xstring
- Event emission on disconnect