Web-Client-Konfiguration
Information
Im Folgenden wird die Konfiguration des PLANTA Web-Clients beschrieben.
Grundlagen
Information
Es gibt verschiedene Optionen, um Konfigurationen anzuwenden. Im Folgenden werden die Möglichkeiten von der niedrigsten zur höchsten Priorität aufgelistet.
Wenn eine Variable an mehr als einem Ort definiert ist, wird die Stelle mit der höchsten Priorität angewandt:
appsettings.json
: Haupt-(Default-)Konfiguration, Änderungen nicht empfohlenappsettings.[Environment].json
: umgebungsspezifische (z. B. Produktion) KonfigurationUmgebungsvariablen
Kommandozeilenparameter
Parameter außerhalb des JSON-Formats definieren
Information
Für Umgebungsvariablen und Kommandozeilenparameter muss ein bestimmtes Format verwendet werden:
Parameter innerhalb eines Blocks definieren
JSON: | Kommandozeile: |
JS
|
CODE
|
Parameter innerhalb eines Arrays definieren
JSON: | ServerB-Port in der Kommandozeile überschreiben: |
JS
|
CODE
|
Parameter
Information
Die folgenden Parameter können zur Konfiguration des Web-Clients verwendet werden.
Verbindungseinstellungen
Information
Parameter, die den Serverstart und die Kommunikation mit dem PLANTA-Server definieren.
Müssen innerhalb eines
ConnectionSettings
-Blocks definiert werden.
Parameter | Typ | Default | Beschreibung |
---|---|---|---|
| int | 6 | Zlib compression level, Zahl zwischen 0 und 9. Wird ignoriert, wenn |
| string | de-DE | Culture Code, der von der Anwendung verwendet wird. Hängt vom Host-Betriebssystem ab. Eine Liste von Culture Codes findet sich auch online. |
| string | null |
|
| int | 60 | Zeitintervall zwischen Keepalive-Signalen an den PLANTA-Server, in Sekunden |
| int | 5 | Request Timeout für Routing-Anfragen an PLANTA link |
| string | null | Der PLANTA link Webhook, der für das Routing benötigt wird |
| int | 1440 | Zeit, in der der Web-Server die Panel-Informationen speichert, wenn der Benutzer die Verbindung abgebrochen oder die Seite verlassen hat, in Minuten |
| string | null |
|
| int | 7200 | Zeit, in der der Web-Server die Session-Informationen speichert, wenn der Benutzer die Verbindung abgebrochen oder die Seite verlassen hat, in Minuten |
| array | null | Liste der PLANTA-Server, muss mindestens einen Eintrag enthalten. Mehr Informationen |
| bool | true | Definiert, ob die Kommunikation mit dem PLANTA-Server komprimiert werden soll |
| string | null |
|
| bool | false | Definiert, ob SSL für die Kommunikation mit dem PLANTA-Server aktiviert sein soll |
Einstellungen des Parameters Servers
Parameter | Typ | Beschreibung |
---|---|---|
| string | Server-Host-Name |
| int | Server-Port |
Authentifizierungs-Einstellungen
Information
Parameter, mit denen konfiguriert wird, ob und wie der Reverse-Proxy uns über den authentifizierten Benutzer informiert. Hierzu ist der Einsatz von PLANTA PLANTA secure erforderlich.
Müssen innerhalb eines
AuthenticationSettings
-Blocks definiert werden.
Parameter | Typ | Default | Beschreibung |
---|---|---|---|
| bool | false | Wenn diese Option aktiviert ist, sendet der Webclient während der Sitzungsinitialisierung eine Nachricht an den Server, die ihn über die Vorauthentifizierung und die entsprechende Benutzerkennung informiert. |
| string | plain | Das Format, in dem der Wert bereitgestellt wird. Bisher ist nur das Format "plain" implementiert, das den Header-Wert an den Server weitergibt. |
| string | x-forwarded-user | Der Name des HTTP-Header-Feldes, das die vom Reverse-Proxy authentifizierte Benutzer-ID enthält. |
| string | / | Der Web-Basispfad, den der Reverse-Proxy für den Webclient verwendet, z. B. wenn der Webclient auf dem Reverse-Proxy unter http://www.example.com/webclient erreichbar ist, lautet der Basispfad /webclient. |
| string | Logout-Route, die aufgerufen wird, wenn der Benutzer seine Sitzung auf dem Reverse-Proxy beenden möchte. |
WebAPI Authentifizierungs-Einstellungen
Parameter | Typ | Default | Beschreibung |
---|---|---|---|
| string | APIKEY | API-Schlüssel, der zum Erreichen der Web-API-Endpunkte verwendet wird |
Adaptive Cards-Einstellungen
Signierungseinstellungen
Parameter | Typ | Default | Beschreibung |
---|---|---|---|
| string | XML-formatierter privater RSA-Schlüssel zum Signieren von Adaptive Cards |
Upload-Einstellungen
Information
Parameter, die das Verhalten bei Datei-Uploads definieren.
Müssen innerhalb eines
FileUploadSettings
-Blocks definiert werden.
Parameter | Typ | Default | Beschreibung |
---|---|---|---|
| int | 6 | Zlib compression level, Zahl zwischen 0 und 9. Wird ignoriert, wenn |
| string | .doc, .docx, .xls, .txt | Dateiendungen, die hochgeladen werden dürfen |
| int | 2000000 | Maximale Dateigröße von Dateien, in kB |
| int | 100000 | Wenn eine Zahl > 0 definiert wird, wird die Datei in Chunks der angegebenen Größe (in kB) hochgeladen. Wird 0 definiert, wird die Datei in einem Request hochgeladen. |
| string | . | Pfad, unter dem Dateien während des Uploads temporär gespeichert werden |
Message Dumper-Einstellungen
Information
Message Dumper speichert die Kommunikation mit dem PLANTA-Server, eine xml-Datei pro Session.
Die Parameter müssen innerhalb eines
MessageDumperSetting
s-Blocks definiert werden.
Parameter | Typ | Default | Beschreibung |
---|---|---|---|
| bool | true | Message Dump-Feature aktivieren |
| string | .\Logs\Dump | Pfad, unter dem Message Dump-Dateien gespeichert werden |
Logging-Einstellungen
Information
Der PLANTA Web-Client verwendet Serilog für das Logging.
Serilog verwendet so genannte "Sinks", um Logs anzuzeigen. Der Web-Client unterstützt derzeit die folgenden Sinks:
Konsole
Datei
Host-URL ändern
Information
Defaultmäßig verwenden ASP.Net Core-Anwendungen die Ports 5000 (http) und 5001 (https).
Mit dem
Urls
-Parameter kann das wie folgt überschrieben werden:
JSON: | Kommandozeile: |
JS
|
CODE
|