Programmausführung

Das Programm kann als Konsolenanwendung oder als Windows-Dienst ausgeführt werden. In beiden Fällen muss die Anwendungsdatei xSuiteInterface5.exe aus dem Programmverzeichnis gestartet werden.

Die Anwendungsdatei benötigt mindestens Zugriff auf die globale Konfigurationsdaten (siehe Datenformat und Datenquellen) mit generellen Programmeinstellungen. Als initiale Quelle dieser Daten wird nur die Dateiform unterstützt. Standardmäßig wird eine solche Konfigurationsdatei direkt im Programmverzeichnis unter dem gleichen Namen wie die EXE-Datei gesucht, aber mit der abweichenden Endung .json, z. B. xSuiteInterface5.json.

Bei Projekten, die komplexer strukturiert sind, liegt die Konfigurationsdatei üblicherweise in einem separaten Ordner. Der Pfad zur globalen Konfigurationsdatei (Ordner und Dateiname) muss daher explizit als Aufrufparameter der EXE-Datei angegeben werden:

xSuiteInterface.exe /ConfigFile "{Konfigurationsdateipfad}"

Die Angabe des Ordners kann dabei sowohl absolut als auch relativ sein, bezogen auf den Ordner der ausgeführten EXE-Datei.

Um das Programm als Windows-Dienst auszuführen, ist eine Registrierung als Windows-Dienst erforderlich. Wenn diese Registrierung nicht bereits über die Basiskonfiguration im Zuge der Installation erfolgt ist, wird dazu typischerweise das Windows-Kommandozeilenwerkzeug sc.exe genutzt. In einer Eingabeaufforderung, die mit administrativen Rechten gestartet werden muss, kann das Kommando im einfachsten Fall wie folgt aussehen:

sc.exe create "{Dienstname}" binPath= "{.exe-Pfad}"

Wenn auch hier der Parameter mit dem Verweis auf die Konfigurationsdatei mitgegeben werden soll, muss der Parameterwert binPath als Ganzes und auch der Parameterwert ConfigFile in Anführungszeichen eingeschlossen sein. Die eingebetteten Anführungszeichen müssen als \" maskiert werden:

sc.exe create "{Dienstname}" binPath= "\"{.exe-Pfad}\" 
/ConfigFile \"{Konfigurationsdateipfad}\""

Informationen zu weiteren Optionen für das sc.exe-Werkzeug, z. B. zur Angabe des Dienste-Kontos und der Startart, finden Sie z. B. unter https://docs.microsoft.com/de-de/windows-server/administration/windows-commands/sc-create. Alternativ können solche Einstellungen auch im Nachgang über die Oberfläche der Windows-Dienststeuerung angepasst werden.

Unabhängig von der Ausführungsart muss das Programm zwingend mit den Rechten eines (lokalen) Administratorkontos gestartet werden.