V5 API-Installations- und Aktualisierungshandbuch

Einführung

Die V5-API wurde entwickelt, um dies zu erleichtern Integration zwischen dem ERP-System eines Kunden und V5 Traceability. In dieser Anleitung erfahren Sie, wie Sie die V5-API installieren und ein Update durchführen.

1. Voraussetzungen:
   1. Javac
   2. Apache Tomcast/Hosting
2. Installation der V5-API
3. Konfigurieren der API
4. Aktualisieren der API

Falls noch nicht auf dem System vorhanden, muss Java Runtime Environment (Version 8-15) installiert werden. Dies kann entweder 32 oder 64 Bit sein. Wenn Sie die API auf einem System installieren, auf dem auch V5-Traceability-Apps installiert sind, ist Java bereits installiert und dieser Schritt kann übersprungen werden.

OpenJDK (Java Development Kit) ist auch für die Verwendung mit der V5-API kompatibel.

Das erste, was wir tun müssen, um die V5-API zu installieren, ist die Installation Apache Tomcat. Die V5-API unterstützt die Verwendung von Apache Tomcat bis Version 10 und SG Systems empfiehlt die Installation von Version 9 oder 10.

Anstelle von Apache Tomcat können auch andere Hosting-Plattformen wie Glassfish verwendet werden, in diesem Beispiel verwenden wir jedoch Tomcat.

In diesem Beispiel installieren wir Tomcat 9.0.75 und führen eine „normale“ Installation der Software durch. Wir können einen HTTP-Port für Tomcat festlegen, der standardmäßig Port 8080 ist. Dies kann zu Konfliktproblemen mit führen SG-Berichte der standardmäßig auch Port 8080 verwendet. Wir empfehlen daher, hier einen anderen Port zu verwenden (in diesem Beispiel 8181), wenn SG Reports auf dem System installiert ist.

Hier können auch ein Dienstname sowie ein Tomcat-Administrator-Benutzername und ein Passwort festgelegt werden, was nach Ihrem eigenen Ermessen liegt. Für unsere Demo-Installation gehen wir wie folgt vor:

Während der Installation werden Sie aufgefordert, das Installationsprogramm auf den JRE-Installationsordner zu verweisen. Dies sollte automatisch ausgefüllt werden. Wenn nicht, müssen Sie den richtigen Ordner angeben.

Nachdem die Installation abgeschlossen ist, sollte die Option „Apache Tomcat ausführen“ ausgewählt werden.

Dieser neue Windows-Dienst sollte in Zukunft so eingestellt werden, dass er mit Windows startet, um sicherzustellen, dass die API ständig ausgeführt wird. Dies kann in den Windows-Diensteinstellungen oder im Tomcat-Eigenschaftenfenster festgelegt werden, das Sie finden, indem Sie eine Windows-Suche nach „configure Tomcat“ durchführen. Auf der Registerkarte „Allgemein“ kann dann der Starttyp eingestellt werden:

Es wird außerdem empfohlen, die Zeitzoneneinstellungen für Tomcat in demselben Eigenschaftenfenster festzulegen. Unter der Registerkarte „Java“ müssten wir einfügen '-Duser.timezone=GMT' in das Fenster „Java-Optionen“ ein und wenden Sie dann Folgendes an:

Es wird außerdem empfohlen, den maximalen Speicherpool von Tomcat auf 1024 MB zu erhöhen, um größere Datenanforderungen besser verarbeiten zu können:

Um die korrekte Installation von Tomcat zu überprüfen, wird an dieser Stelle empfohlen, die Konnektivität dazu in einem Webbrowser zu überprüfen. Für diese Installation würden wir uns mit verbinden http://127.0.0.1:8181/ (lokaler Host und die Portnummer, die wir während der Installation ausgewählt haben) und würde Folgendes sehen:

Sobald wir sichergestellt haben, dass alle Voraussetzungen erfüllt sind, können wir mit der API selbst fortfahren. Die neueste Version der V5-API kann heruntergeladen werden werden auf dieser Seite erläutert. Dadurch wird „V5-API.war“ heruntergeladen.

Diese Datei sollte dann abgelegt werden in:

*Installationsverzeichnis*\Apache Software Foundation\*ausgewählter Dienstname*\webapps

Für unser Beispiel ist das also:

C:\Programme\Apache Software Foundation\Tomcat 9.0_Tomcat9-V5-API\webapps

Sobald die Datei hier platziert ist und der Tomcat-Dienst ausgeführt wird, wird automatisch ein „V5-API“-Ordner neben der „war“-Datei erstellt.

Die V5-API-Installation ist nun abgeschlossen. Jetzt müssen wir es nur noch mit der V5-Datenbank verbinden.

Im Hauptinstallationsordner von Tomcat (so 'C:\Programme\Apache Software Foundation\Tomcat 9.0_Tomcat9-V5-API' in unserem Fall hier) müssen wir einen neuen Ordner mit dem Namen „Config'. Laden Sie dann die folgende Datei „db_settings.properties“ herunter werden auf dieser Seite erläutert.

Öffnen Sie diese Datei mit Notepad und löschen Sie alle Datensätze, die für den Typ der SQL-Datenbank, die mit V5 Traceability verwendet wird, nicht relevant sind. Wenn Sie sich bei dieser Methode nicht sicher sind, wenden Sie sich bitte an SG-Unterstützung.

Wenden Sie sich an Ihren Datenbankadministrator, um die Felder für Benutzername und Passwort auszufüllen.

Legen Sie dann diese fertige Datei in den oben angegebenen Ordner ab und starten Sie den Tomcat-Dienst neu. Die Verbindung zur Datenbank wird nun hergestellt!

Anleitungen zur Verwendung der V5-API finden Sie in unserem speziellen API-Abschnitt werden auf dieser Seite erläutert.

Das Aktualisieren der V5-API ist so einfach wie das erneute Herunterladen der Datei „V5-API.war“ mit diesen Link. Löschen Sie nach dem Herunterladen die alte .war-Datei sowie den Ordner, den sie bei der ursprünglichen Installation erstellt hat.

Wiederholen Sie dann einfach die oben genannten Schritte der Installation, legen Sie die Datei „V5-API.war“ erneut in diesem Ordner ab, lassen Sie den Ordner erneut extrahieren und starten Sie dann den Tomcat-Dienst neu.

Sie können die auf die neueste Version aktualisierte API jetzt weiterhin verwenden!