Web-Client-Konfiguration | PLANTA Online-Hilfe

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:
1. appsettings.json: Haupt-(Default-)Konfiguration, Änderungen nicht empfohlen
2. appsettings.[Environment].json: umgebungsspezifische (z. B. Produktion) Konfiguration
3. Umgebungsvariablen
4. 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:
JavaScript `{ "ConnectionSettings": { "User": "username" } }`	`--ConnectionSettings:User=username`

Parameter innerhalb eines Arrays definieren

JSON:	ServerB-Port in der Kommandozeile überschreiben:
JavaScript `{ "ConnectionSettings": { "Servers": [ { "Host":"serverA", "Port":1234 }, { "Host":"ServerB", "Port":4567 } ] } }`	`--ConnectionSettings:Servers:1:Port=9999`

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
`CompressionLevel`	int	6	Zlib compression level, Zahl zwischen 0 und 9. Wird ignoriert, wenn `UseCompression` = `false`
`CultureCode`	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.
`IndividualParameters`	string	null	`individual_parameters`-Parameter, der beim Server-Start gesendet wird
`KeepAliveTimeout`	int	60	Zeitintervall zwischen Keepalive-Signalen an den PLANTA-Server, in Sekunden
`RoutingRequestTimeout`	int	5	Request Timeout für Routing-Anfragen an PLANTA link
`RoutingWebHook`	string	null	Der PLANTA link Webhook, der für das Routing benötigt wird
`PanelDestructionDelay`	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
`Password`	string	null	`password`-Parameter, der beim Server-Start gesendet wird
`SessionDestructionDelay`	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
`Servers`	array	null	Liste der PLANTA-Server, muss mindestens einen Eintrag enthalten. Mehr Informationen
`UseCompression`	bool	true	Definiert, ob die Kommunikation mit dem PLANTA-Server komprimiert werden soll
`User`	string	null	`user`-Parameter, der beim Server-Start gesendet wird
`UseSSL`	bool	false	Definiert, ob SSL für die Kommunikation mit dem PLANTA-Server aktiviert sein soll

Einstellungen des Parameters Servers

Parameter	Typ	Beschreibung
`Host`	string	Server-Host-Name
`Port`	int	Server-Port

AI-Einstellungen

Parameter	Typ	Beschreibung
ChatHost	string	URL des AI-Assistenten-Chats.

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 secure erforderlich.
Müssen innerhalb eines AuthenticationSettings-Blocks definiert werden.

Parameter	Typ	Default	Beschreibung
`ProxyAuth`	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.
`ProxyUserFormat`	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.
`ProxyUserHeader`	string	x-forwarded-user	Der Name des HTTP-Header-Feldes, das die vom Reverse-Proxy authentifizierte Benutzer-ID enthält.
`AppPathBase`	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.
`ProxyLogoutRoute`	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
`APIKey`	string	APIKEY	API-Schlüssel, der zum Erreichen der Web-API-Endpunkte verwendet wird

Adaptive Cards-Einstellungen

Signierungseinstellungen

Parameter	Typ	Default	Beschreibung
`RsaPrivateKeyXml`	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
`CompressionLevel`	int	6	Zlib compression level, Zahl zwischen 0 und 9. Wird ignoriert, wenn `UseCompression` = `false`
`AllowedExtensions`	string	.doc, .docx, .xls, .txt	Dateiendungen, die hochgeladen werden dürfen
`MaxFileSize`	int	2000000	Maximale Dateigröße von Dateien, in kB
`ChunkSize`	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.
`TemporaryFilePath`	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 MessageDumperSettings-Blocks definiert werden.

Parameter	Typ	Default	Beschreibung
`Enabled`	bool	true	Message Dump-Feature aktivieren
`LogDirectory`	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:
JavaScript `"Urls": "http://localhost:9000;https://localhost:9001",`	`--Urls:http://localhost:9000;https://localhost:9001`