Installationsanleitung RATIOserver Anwendung

Owned by a.kneer
Last updated: Jun 28, 2022
8 min read

Einführung

Der Datenaustausch zwischen Webplattform und Unternehmensdatenbank erfolgt über ein Schnittstellenmodul, das einmalig im Unternehmen installiert wird, die sogenannte Bridge (RATIOserver Anwendung).

Installation

Zur Installation der RATIOserver Anwendung muss zunächst die Setup-Datei heruntergeladen werden.
Diese ist als ausführbare Datei (ratioserver-setup.exe) und als Archiv (ratioserver-setup.zip) verfügbar. 

https://www.ratioapp.de/webplattform/apps/ratioserver/settings

Der Benutzer, der die RATIOserver Anwendung ausführt, benötigt Schreibrechte für das Installationsverzeichnis. Dies ist notwendig, da Konfigurationsdatei (ratioserver.ini), Logdatei (ratioserver.log) und Setup-Datei (ratioserver-setup.exe; notwendig für Updates) im Installationsverzeichnis gespeichert werden.

Nach erfolgreicher Installation kann die RATIOserver Anwendung gestartet werden.

Konfiguration

RATIOserver-Port

Hier kann der Port bestimmt werden, unter dem die RATIOserver Anwendung (Bridge) von der Webplattform erreicht werden kann.

Report-Timeout (sek.)

Maximale Zeit für die Erstellung des Formulars bei einer Web-Buchung/Web-Gutschein.

Log-Level

Informationen zum laufenden Programm können über diese Auswahlbox aufgezeichnet werden. Bei ERROR werden nur Fehlermeldung berücksichtigt, bei TRACE werden detaillierte Informationen zum Programmablauf erfasst. Die Informationen werden in die Datei ratioserver.log ins Programmverzeichnis geschrieben.

Datenbankpfad

Verweist auf die Interbase-Datenbank des Unternehmens im lokalen Netzwerk.

Sicherheitsschlüssel

Der Sicherheitsschlüssel des entsprechenden Mandanten muss auf der Webplattform eingetragen sein. Hiermit wird der Datenaustausch verschlüsselt.

Auto-Update

Damit kann die RATIOserver Anwendung zu einer bestimmten Uhrzeit automatisch aktualisiert werden.

Testseite öffentlich 

Der Haken sollte nur zu Testzwecken kurzfristig gesetzt werden. Im Produktivbetrieb sollte er grundsätzlich entfernt werden, um keine internen Systeminformationen öffentlich sichtbar zu machen.

Update-Test

Damit kann der Updatemechanismus getestet werden. Die RATIOserver Anwendung erkennt bei aktivierter Option auch die aktuelle Version als neue Version und führt ein Update durch. 

Entwicklermodus

Hier kann die URL der Webplattform geändert werden, sodass Updates von diesem Server geladen werden.

Testseite-Button

Hier kann die Konfiguration geprüft werden. Es öffnet sich eine Seite im Webbrowser mit Systeminformationen. Die externe Erreichbarkeit der RATIOserver Anwendung kann ebenfalls geprüft werden indem die öffentliche IP-Adresse inklusive RATIOserver Anwendung-Port in einen Webbrowser eingegeben wird. Dazu muss ein Haken bei Testseite öffentlich gesetzt sein.

Windows Dienst

Die RATIOserver Anwendung wird als Windows Dienst installieren. Damit wird die Erreichbarkeit der RATIOserver Anwendung überprüft und nach einem bestimmten Anzahl von Fehlversuchen neu gestartet.

Damit wird die RATIOserver Anwendung gestartet.

Damit wird die RATIOserver Anwendung angehalten.

Öffnet im Standardbrowser die Testseite.

Damit wird auf ein mögliches Update geprüft. Wenn es ein Update gibt, wird dieses gestartet.

Damit wird die RATIOserver Anwendung beendet.

 

In der Statusleiste im unteren Bereich werden folgende Daten angezeigt:

  • Versionsnummer

  • Anwendung gestartet oder beendet

  • Aktuelle Anzahl der Verbindungen

  • Aktive Events

Windows Dienst einrichten (ab Version 3.4)

Ab der Version 3.4 ist es möglich einen Überwachungsdienst zu installieren.

Dieser prüft, in einem einstellbaren Intervall und Versuche, ob die RATIOserver Anwendung läuft.

Wenn dieser nach X Versuchen nicht erreicht, so wird die RATIOserver Anwendung automatisch neu gestartet.

Um die RATIOserver Anwendung als Dienst zu starten, wird der Haken "Windows-Dienst" gesetzt.

Anschließend muss der Überwachungsdienst mit Ja bestätigt werden.

Danach gibt man die Mandantenkennung, Prüfintervall und Versuche ein.

Mit dem Button "Übernehmen" wird der Dienst erstellt.

Zum Schluss muss noch die Windows Dienste aufgerufen werden und den neu erstellten Dienst starten.
(Oder im Task Manager unter Dienste den neu erstellten Dienst starten)

Windows Ereignisanzeige

Der neue Dienst wird in der Windows Ereignisanzeige protokolliert.

RATIOserver Anwendung - Dienst beenden

Um den Dienst zu beenden müssen folgende Schritte gemacht werden:

  1. Im Windows Task Manager den Reiter Dienste öffnen.

  2. Die RATIOserver Anwendung anhalten.

  3. Im Reiter Prozesse den TASK RATIOserver Anwendung beenden.

Um den Dienst wieder zu starten müssen folgende Schritte gemacht werden:

  1. Den Windows Task Manager öffnen.

  2. Den Reiter Dienste öffnen.

  3. Die RATIOserver Anwendung Starten.

Windows Aufgabe einrichten (nur für Versionen die älter sind als 3.4)

Um die RATIOserver Anwendung beim Systemstart sofort auszuführen, kann eine Windows-Aufgabe angelegt werden.

Allgemein

Name

RATIOserver (Instanz X)

Sicherheitsoptionen

Unabhängig von der Benutzeranmeldung ausführen

Trigger

Aufgabe starten

Beim Start

Erweitere Einstellungen

Aktiviert

Aktionen

Aktion

Programm starten

Programm/Skript

Pfad der ratioserver.exe

Beispiel: C:\RATIOserver\ratioserver.exe

Argumente hinzufügen

--autostart

Starten in

Verzeichnis der ratioserver.exe

Beispiel: C:\RATIOserver

Bedingungen

Einstellungen

Folgende Haken müssen gesetzt werden:

  • Ausführung der Aufgabe bei Bedarf zulassen

  • Aufgabe so schnell wie möglich nach einem verpassten Start ausführen

  • Falls Aufgabe scheitert, neu starten alle: 1 Minute
    Neustartversuche bis maximal: 3 Mal

  • Beenden der aktiven Aufgabe erzwingen, falls sie auf Aufforderung nicht beendet wird

Folgende Haken dürfen nicht gesetzt sein:

  • Aufgabe beenden, falls Ausführung länger als:

  • Falls keine weitere Ausführung geplant ist, Aufgabe löschen nach:

Zusätzlich muss folgende Regel angewendet werden:

  • Folgende Regel anwenden, falls die Aufgabe bereits ausgeführt wird: Keine neue Instanz starten

Auto-Update - Windows-Aufgabe

Allgemein

Name

RATIOserver-Update (Instanz X)

Sicherheitsoptionen

  • Unabhängig von der Benutzeranmeldung ausführen

  • Mit höchsten Privilegien ausführen

Trigger

Aktionen

Aktion

Programm starten

Programm/Skript

Pfad der ratioserver-setup.exe

Datei muss sich im selben Verzeichnis wie die ratioserver.exe befinden!

Beispiel: C:\RATIOserver\ratioserver-setup.exe

Argumente hinzufügen

/SILENT /FORCECLOSEAPPLICATIONS /DIR="C:\RATIOserver"

DIR = Verzeichnis der ratioserver.exe

Starten in

Verzeichnis der ratioserver.exe

Beispiel: C:\RATIOserver

Bedingungen

Einstellungen

Folgende Haken müssen gesetzt werden:

  • Ausführung der Aufgabe bei Bedarf zulassen

  • Beenden der aktiven Aufgabe erzwingen, falls sie auf Aufforderung nicht beendet wird

Folgende Haken dürfen nicht gesetzt sein:

  • Aufgabe so schnell wie möglich nach einem verpassten Start ausführen

  • Falls Aufgabe scheitert, neu starten alle:

  • Aufgabe beenden, falls Ausführung länger als:

  • Falls keine weitere Ausführung geplant ist, Aufgabe löschen nach:

Zusätzlich muss folgende Regel angewendet werden:

  • Folgende Regel anwenden, falls die Aufgabe bereits ausgeführt wird: Keine neue Instanz starten

Verknüpfung

Die Verknüpfung muss im Installationsverzeichnis der RATIOserver Anwendung erstellt werden:

%Windir%\System32\schtasks.exe /run /TN "RATIOserver-Update (Instanz 1)"

/TN = Name der Update-Aufgabe

Die Verknüpfung muss ratioserver-update.exe heißen, damit sie vom Updatemechanismus erkannt wird.

Update Informationen

Update-Test

Beim automatischen Update lauern einige Fallstricke wie Benutzerkontensteuerung, Benutzerberechtigungen, Virenscanner oder Firewalls. Deshalb sollte der Updatemechanismus ausführlich getestet werden. 

Während der Tests kann über die Checkbox Update-Test ein Update erzwungen werden, auch wenn tatsächlich kein solches vorliegt. Nach Abschluss der Tests muss die Option jedoch wieder deaktiviert werden!

Manuelles Update

Grundlage für das automatische Update ist die Funktionsfähigkeit des manuellen Updates. Das manuelle Update kann über den Button Auf Update prüfen gestartet werden. 

Automatisches Update MIT angemeldetem Benutzer

Wird ein Haken bei Auto-Update gesetzt, kann die Tageszeit eingegeben werden, zu der ein automatisches Update durchgeführt werden soll. Ab der eingestellten Uhrzeit wird innerhalb der folgenden 10 Minuten jede Minute auf ein Update geprüft. Wird als Uhrzeit beispielsweise 03:00 Uhr definiert, so prüft das Programm im Zeitraum von 03:00 bis 03:10 Uhr einmal pro Minute auf Updates. Bei gesetzter Option Update-Test werden also bis zu 10 Updates in Folge durchgeführt.

Automatisches Update OHNE angemeldetem Benutzer

Um das automatische Update zu prüfen, wenn der RATIOserver Anwendung im Hintergrund läuft, d.h. wenn dieser beim Systemstart durch die Auto-Start-Aufgabe ausgeführt wird, kann ein Doppelklick auf die Verknüpfung ratioserver-update.exe erfolgen. Davor ist allerdings sicherzustellen, dass der RATIOserver Anwendung beendet wurde und sich die Datei ratioserver-setup.exe im Installationsverzeichnis befindet. Die Verknüpfung sorgt dafür, dass die RATIOserver Anwendung im Hintergrund (d.h. ohne Oberfläche) gestartet wird.

Im Taskmanager muss ein neuer Prozess ratioserver.exe erscheinen, der die Sitzungskennung 0 (Null) besitzt. Die Spalte Sitzungskennung muss ggf. erst eingeblendet werden. Jetzt am besten die Datei ratioserver-setup.exe löschen. Sobald das automatische Update anläuft, wird im Idealfall die Setup-Datei heruntergeladen und ausgeführt. Funktioniert dies nicht, muss die Systemkonfiguration geprüft werden (Berechtigungen, Virenscanner, Firewall etc.).

Soll die Konfiguration der RATIOserver Anwendung geändert werden, muss der Prozess zunächst über den Taskmanager beendet werden. Danach kann er durch Doppelklick auf die ratioserver.exe mit Oberfläche neu gestartet werden. Zur Fehleranalyse bietet es sich an das Log-Level entweder auf ERROR oder TRACE zu setzen. Im Produktivbetrieb sollte das Log-Level jedoch auf ERROR stehen, damit die Logdatei nicht zu groß wird.