Installation (ArcFlow.Next)
Voraussetzungen für die Installation
Der ArcFlow WebApi Dienst kann auf einem Windows System ab der Version Microsoft Windows Server 2016 mit .NET Famework 4.7.2 installiert werden. Da das System für den Zugriff von außerhalb des eigenen Netzes gedacht ist, sollte das aktuelle Windows Betriebssystem mit den letzten Updates verwendet werden. Für die spätere Kommunikation über HTTPS muss ein Zertifikat vorhanden sein. Alle weiteren Voraussetzungen (Web-Server usw.) werden bei der Installation des Dienstes mit installiert.
Installation
Der Programmstand für die ArcFlow WebApi befindet sich nach der Installation von ArcFlow im Unterverzeichnis "...\Client\App\Install\ArcFlow.Next". Die dort vorhandene ZIP-Datei kann in ein beliebiges Verzeichnis kopiert und dort entpackt werden. Für die weitere Beschreibung wird davon ausgegangen, dass die Dateien in das Verzeichnis "...\Services\WebApi" entpackt wurden. Folgende Dateien sind in der ZIP-Datei enthalten:
- ArcFlow.NET.API.dll - ArcFlow .NET Bibliothek
- ArcFlow.NET.dll - ArcFlow .NET Bibliothek
- ArcFlow.SYS.dll - ArcFlow .NET Bibliothek
- ArcFlowWebApiService.exe - Programm des WebApi-Dienstes
- ArcFlowWebApiService.exe.config - Konfigurationsdatei des Programms.
- Service_install.cmd - Kommando zur Installation des Dienstes
- Service_uninstall.cmd - Kommando zur Deinstallation des Dienstes
- settings.json - Konfigurationsdatei
- lib - Verzeichnis das weitere Bibliotheken zur Ausführung des WebApi-Dienstes enthält.
- logs - Das Verzeichnis wird beim ersten Starten angelegt und enthält die Protokolldateien der WebApi.
- spa - Verzeichnis mit den Dateien des WebApi-Clients (Single Page Application).
- x64 - 64-Bit Bibliotheken des WebApi-Dienstes.
- x86 - 32-Bit Bibliotheken des WebApi-Dienstes.
Starten des Dienstes
Das Programm "ArcFlowWebApiService.exe" kann über den Menüpunkt "Als Administrator ausführen" des Kontextmenü des Explorers gestartet werden.
Mit den jetzigen Einstellungen in der "settings.json" kann von der gleichen Maschine aus über den Link http://localhost:9000 die Web-Oberfläche von ArcFlow aufgerufen werden. Die Anmeldung erfolgt mit dem Benutzer "admin" und dem in ArcFlow hinterlegtem Kennwort. Alle weiteren Benutzer in ArcFlow benötigen zur Anmeldung das Applikationsrecht "ArcFlow.Next Lese-Modus".
Zur Installation als Dienst muss das Programm wieder beendet werden und das Betriebssystem-Skript "Service_install.cmd" als Administrator ausgeführt werden. Das Skript installiert das Programm als Dienst und startet es.
Anpassungen der Einstellungen
Nach der Installation befindet sich eine Datei "settings.json" mit Standardwerten im Installationsverzeichnis.
{
"LogLevel": "Default",
"Database": {
"PgixMode": "Auto",
"ServerName": "...",
"AreaName": "arcflow",
"MaxConnections": 10,
"AutoCloseTimeout": "00:00:30"
},
"Web": {
"Scheme": "http",
"Host": "localhost",
"Port": 9000,
"ClientConfigDirectoryName": "spa",
"ClientConfigFileName": "js\\config.js",
"CertificateThumbprint": "",
"JwtTokenSecret": "U...=="
},
"Service": {
"Description": "ArcFlowWebApiService",
"DisplayName": "ArcFlowWebApiService",
"Name": "ArcFlowWebApiService"
}
}
Die Einstellungen des ArcFlow WebApi Dienstes erfolgen in der Datei "settings.json". In der Datei können folgende Einstellungen vorgenommen werden:
- LogLevel In diesem Bereich kann der Level für die Protokollierung angegeben werden. Folgende Loglevel stehen zur Verfügung:
- Default - Protokollierung von Info-, Warnungs- und Fehlermeldungen
- Debug - Protokollierung von Debug-, Info-, Warnungs- und Fehlermeldungen
- Silence - Protokollierung von Fehlermeldungen
"LogLevel": "Default"
- Database In diesem Bereich werden Einstellungen zur Datenbankverbindung angegeben.
- PgixMode - Die Verbindung zur ArcFlow-Datenbank wird über eine DLL hergestellt. Diese DLL steht in unterschiedlichen Ausprägungen zur Verfügung. Mit der Angabe von Bit64, Bit32 bzw. Extendes32 wird die 64-, 32-Bit DLL oder die 32-Bit DLL mit erweitertem Funktionsumfang geladen. Durch die Angabe von Auto wird die für das System geeignete DLL geladen.
"PgixMode": "Auto"
- ServerName - Name oder IP-Adresse des ArcFlow Datenbankservers. Ist der Datenbankserver auf der gleichen Maschine gestartet, kann auch "*" angegeben werden.
"ServerName": "*"
- AreaName - Name der Datenbank. Standardmäßig wird "arcflow" verwendet.
"AreaName": "arcflow"
- MaxConnections - Maximale Anzahl von Verbindungen zur Datenbank
"MaxConnections": 10
- AutoCloseTimeout - Werden in der angegebenen Zeit keine Anfragen an die Datenbank gesendet, wird die Datenbank Verbindung getrennt. Die Angabe erfolgt in Stunden:Minuten:Sekunden.
"AutoCloseTimeout": "00:00:30"
- Web In diesem Bereich erfolgen die Angaben für den Zugriff auf die WebApi.
- Scheme -
"Scheme": "http"
- Host -
"Host": "localhost"
- Port -
"Port": 9000
- ClientConfigDirectoryName -
"ClientConfigDirectoryName": "spa"
- ClientConfigFileName -
"ClientConfigFileName": "js\\config.js"
- CertificateThumbprint -
"CertificateThumbprint": ""
- JwtTokenSecret -
"JwtTokenSecret": "..."
- Service
- -
Deinstallation
Zu Deinstallation des Dienstes reicht es aus, den Dienst zu entfernen. Dazu können entweder die Funktionen des Betriebssystems verwendet oder das Betriebssystem-Skript "Service_uninstall.cmd" als Administrator ausgeführt werden. Der Dienst wird dann gestoppt und von den Diensten entfernt. Die Dateien im Installationsverzeichnis können anschließend gelöscht werden.
