Zum Hauptinhalt springen

Installation des SAP REST Connector

Der SAP REST Connector ist ein in NestJS entwickelter Webserver, der als ausführbare Datei für Windows (sap-public-cloud-connector.exe) und Linux (sap-public-cloud-connector) bereitgestellt wird. Das gesamte Produkt wird als Zip-Archiv ausgeliefert und enthält u. a.:

  • Beispiel-Konfigurationsdatei: .env.example

  • Beispieldatei für POST-Requests: post-body.json – enthält Beispiel-Daten für den POST-Request-Body

  • Ausführungsskripte für POST-Request: Sendet POST-Request mit POST-Request-Body aus Datei post-body.json ab.

    • Windows: request-execution.ps1
    • Linux: request-execution.sh

Im Windows-Release sind zudem zusätzliche Dateien enthalten, die die Installation als Windows-Dienst ermöglichen:

  • sap-public-cloud-connector-service.exe
  • sap-public-cloud-connector.xml
  • install.ps1
  • uninstall.ps1
  • licenses.md

Diese Anleitung führt Sie Schritt für Schritt durch die Installation und Einrichtung des SAP REST Connector als Dienst, sodass der Webserver dauerhaft im Hintergrund läuft.

Voraussetzungen​

  • Betriebssystem: siehe
  • Installationspaket: Zip-Archiv
  • Rechte: Schreib- und Ausführungsrechte im Zielverzeichnis

Schritt 1: Herunterladen oder Kopieren des Archivs​

Laden Sie das Zip-Archiv von folgendem Link herunter:

Download-Link

Alternativ können Sie eine bereits vorhandene Version des Archivs auf den Server kopieren.

Schritt 2: Entpacken des Archivs​

Entpacken Sie das heruntergeladene Zip-Archiv in das gewünschte Installationsverzeichnis.

  • Unter Windows: Klicken Sie mit der rechten Maustaste auf die Zip-Datei und wählen Sie "Alle extrahieren..." oder nutzen Sie ein Entpackprogramm wie 7-Zip.

  • Unter Linux: Öffnen Sie ein Terminal und führen Sie folgenden Befehl aus:

    unzip sap-public-cloud-connector.zip -d /pfad/zum/installationsverzeichnis

Schritt 3: Konfiguration​

Im entpackten Archiv finden Sie die Datei .env.example. Diese Datei dient als Vorlage für die benötigten Umgebungsvariablen.

  1. Kopieren Sie die Datei und benennen Sie diese in .env um: 
    cp .env.example .env
  2. Öffnen Sie die .env-Datei mit einem Texteditor und passen Sie die Variablen an Ihre Umgebung an. Weitere Informationen zu den verfügbaren Umgebungsvariablen und deren Bedeutung finden Sie unter Environment Variablen.

Schritt 4: Starten des Webservers​

Nach erfolgreichem Entpacken und Anpassen der Konfiguration können Sie den Webserver starten.

  • Unter Windows: Doppelklicken Sie auf die Datei sap-public-cloud-connector.exe oder starten Sie diese über die Eingabeaufforderung:

    cd \pfad\zum\installationsverzeichnis
    sap-public-cloud-connector.exe

  • Unter Linux: Öffnen Sie ein Terminal, navigieren Sie in das Installationsverzeichnis und führen Sie:

    cd /pfad/zum/installationsverzeichnis
    ./sap-public-cloud-connector

Schritt 5: Einrichten als Service​

Um sicherzustellen, dass der Webserver dauerhaft läuft, empfiehlt es sich, ihn als Service einzurichten. Falls Sie den SAP REST Connector in Schritt 4 gestartet haben, beenden Sie diesen bitte zuerst.

Unter Windows​

Unter Windows können Sie den Webserver als Service installieren und starten, indem Sie in einer PowerShell im Installationsverzeichnis (in dem auch die sap-public-cloud-connector.exe liegt) folgenden Befehl in der Kommandozeile ausführen:

powershell.exe -ExecutionPolicy Bypass -File .\install.ps1

Mit dem nächsten Befehl können Sie den Service stoppen und wieder deinstallieren:

powershell.exe -ExecutionPolicy Bypass -File .\uninstall.ps1

Bitte bestätigen Sie zweimal die Sicherheitsabfrage, die von Windows angezeigt wird.

Unter Linux (Systemd)​

Erstellen Sie eine Service-Datei, z.B. /etc/systemd/system/spcc.service, mit folgendem Inhalt:

[Unit]
Description=SAP REST Connector Service
After=network.target

[Service]
Type=simple
WorkingDirectory=/pfad/zum/installationsverzeichnis
ExecStart=/pfad/zum/installationsverzeichnis/sap-public-cloud-connector
Restart=on-failure

[Install]
WantedBy=multi-user.target

Laden Sie anschließend die Systemd-Konfiguration neu und aktivieren Sie den Service:

sudo systemctl daemon-reload
sudo systemctl enable spcc.service
sudo systemctl start spcc.service

Zusammenfassung​

  • Download/Kopie: Laden Sie das Zip-Archiv über den bereitgestellten Link herunter oder kopieren Sie eine vorhandene Version.
  • Entpacken: Extrahieren Sie das Archiv in das gewünschte Installationsverzeichnis.
  • Konfiguration: Kopieren Sie .env.example in .env und passen Sie die Umgebungsvariablen an.
  • Starten: Führen Sie den Webserver aus, um zu testen, dass der Webserver erfolgreich starten kann und beenden Sie diesen wieder.
  • Service: Richten Sie den Webserver als Service ein, um einen dauerhaften Betrieb sicherzustellen.

Mit dieser Anleitung sollten Sie den SAP REST Connector problemlos installieren und in Betrieb nehmen können.