Skip to main content
Skip table of contents

Installing the Restifier for SAP

The RESTifier for SAP is a Node.js service that enables you to access any BAPI RFC function of your SAP system from within any application by using REST calls.

Requirements and Package Formats

The RESTifier for SAP is delivered as a Node.js package. To run the RESTifier package, you need a Bridge running on Windows 64 bit or Linux 64 bit, or an installation of Node.js.

The RESTifier for SAP runs on 64 bit versions of Windows and Linux only.

Refer to the table below for a list of dependencies between RESTifier and Bridge/Node.js versions.

Bridge Version

RESTifier Version

Node.js Version

Bridge 7

7.5.0

RESTifier for SAP version 3.2.x

8.16.0 (or newer)

7.1.0

RESTifier for SAP version 3.1.0

8.11.x

7.0.0

RESTifier for SAP version 3.0.0

8.9.x

For Bridge 7, you need E2E RESTifier for SAP version 3 or higher.

Bridge 6

Bridge 5.1

RESTifier for SAP version 2.2 - 2.4.2

4.4.x and 6.10.x

> 6.0.56.1

RESTifier for SAP version 2 - 2.4.2

4.4.x

< 6.0.56.1

RESTifier for SAP version 1.x

0.10.x

If you will be using the RESTifier behind a proxy, please also refer to Using the RESTifier Behind a Proxy.

Installing the RESTifier for SAP

Download the package sap-restifier.zip and deploy it to your Bridge as described in Deployment of Node.js Services.

Prerequisites

  1. If you are deploying a RESTifier as of version 2, make sure to have at least a Bridge 6.0.56.1 installed. As of this Bridge version, Node.js 4.x LTS is included, which is needed by the RESTifier.

  2. Each Bridge has a maximum upload size that can be configured in the node instance preferences. If the RESTifier packages fails to upload, you may need to increase this value.

Before starting the service you need to define some environment variables.

Variable

Value

Remark

CONFIG_DIR

The SAP host information and cache are stored in this directory. If you don't specify the variable, all configuration data will be lost, when you update the sap-restifier.zip package.

You only need this for Bridge versions before 6.0.52. Bridge 6.0.52 or later defines the environment variable already.

LD_LIBRARY_PATH

RESTifier for SAP 3.2.x 
(or newer)

node_modules/@e2ebridge/sapnwrfc/build/linux/x64/Release

You only need this variable on Linux.

RESTifier for SAP 3.1.x

node_modules/@e2ebridge/sapnwrfc/compiled/8.11/linux/x64

RESTifier for SAP 3.0.x

node_modules/@e2ebridge/sapnwrfc/compiled/8.9/linux/x64

RESTifier for SAP 2.x
BRIDGE with Node.js 6

node_modules/@e2ebridge/sapnwrfc/compiled/6.10/linux/x64

RESTifier for SAP 2.x
BRIDGE with Node.js 4.4.x

node_modules/@e2ebridge/sapnwrfc/compiled/4.4/linux/x64

RESTifier for SAP 1.x
BRIDGE with Node.js. 0.10.x

node_modules/sapnwrfc/compiled/0.10/linux/x6

PATH

RESTifier for SAP 3.2.x 
(or newer)

node_modules/@e2ebridge/sapnwrfc/build/win32/x64/Release

You only need this variable on Windows.

RESTifier for SAP 3.1.x

node_modules/@e2ebridge/sapnwrfc/compiled/8.11/win32/x64

RESTifier for SAP 3.0.x

node_modules/@e2ebridge/sapnwrfc/compiled/8.9/win32/x64

RESTifier for SAP 2.x
BRIDGE with Node.js 6

node_modules/@e2ebridge/sapnwrfc/compiled/6.10/win32/x64

RESTifier for SAP 2.x
BRIDGE with Node.js 4.4.x

node_modules\@e2ebridge\sapnwrfc\compiled\4.4\win32\x64

RESTifier for SAP 1.x
BRIDGE with Node.js. 0.10.x

node_modules\sapnwrfc\compiled\0.10\win32\x64

Now you can start the sap-restifier service and open a browser at http://localhost:3000 to configure your SAP host. Having done that, the RESTifier for SAP is ready to use.

List of other supported environment variables:

Variable

Remark

PORT

Port number of the service. Default is 3000.

NODE_ENV

Log all http requests in restifier.log (value development) or not (value production.) Default is production.

LOG_DIR

To this directory the log files are written. Default is ../logs which is good for the BRIDGE to display the logs in the UI.

UV_THREADPOOL_SIZE

Increase number of concurrent SAP connections. Default is 4.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.