Web Client Configuration
Information
- Below follows a description of the PLANTA web client configuration.
Basics
Information
- There are several ways in which configurations can be applied. Below the options will be listed from lowest to highest priority.
- If a variable has been defined at more than one position, the position with the highest priority will be used:
appsettings.json
: Main (default) configuration, changes are not recommendedappsettings.[Environment].json
: environmental specific (e.g. production) configuration- Environment Variables
- Command line parameter
Define parameters outside the JSON format
Information
- You have to use a particular format for conversion variables and command line parameters:
Define parameters within a block
JSON:
{
"ConnectionSettings": {
"User": "username"
}
}
JS
Commanfd line:
--ConnectionSettings:User=username
CODE
Define parameters within an array
JSON:
{
"ConnectionSettings": {
"Servers": [
{
"Host":"serverA",
"Port":1234
},
{
"Host":"ServerB",
"Port":4567
}
]
}
}
JS
Overwrite ServerB port in the command line:
--ConnectionSettings:Servers:1:Port=9999
CODE
Parameter
Information
- The following parameters can be used to configure the web client.
Connection Settings
Information
- Parameters which define the server start and the communication with the PLANTA Server.
- Must be defined within a
ConnectionSettings
block.
Parameter | Type | Default | Description |
---|---|---|---|
CompressionLevel | int | 6 | Zlib compression level, number between 0 and 9. Will be ignored if UseCompression = false |
CultureCode | string | de-DE | Culture Code which is used by the application. Depends on the host operating system. A list of culture codes can be found online as well. |
IndividualParameters | string | null | individual_parameters -Parameter which is sent upon server start |
KeepAliveTimeout | int | 60 | Time interval between keepalive signals sent to the PLANTA Server in seconds |
RoutingRequestTimeout | int | 5 | Request timeout for routing requests to PLANTA link |
RoutingWebHook | string | null | The PLANTA link webhook which is required for routing |
PanelDestructionDelay | int | 1440 | Time in minutes for which the web server saves panel information when the user has interrupted the connection or left the page |
Password | string | null | password parameter which is sent upon server start |
SessionDestructionDelay | int | 7200 | Time in minutes for which the web server saves session information when the user has interrupted the connection or left the page |
Servers | array | null | List of the PLANTA Server must at least contain one entry. Further information |
UseCompression | bool | true | Defines whether communication with the PLANTA Server is to be compressed |
User | string | null | individual_parameters parameter which is sent upon server start |
UseSSL | bool | false | Defines whether SSL is to be activated for communication with the PLANTA Server |
Settings of the Servers parameter
Parameter | Type | Description |
---|---|---|
Host | string | Server Host Name |
Port | int | Server Port |
Authentication Settings
Information
- Parameters which are used to configure whether and how the reverse proxy informs us about the authenticated user. This requires the use of PLANTA secure.
- Must be defined within a
AuthenticationSettings
block.
Parameter | Type | Default | Description |
---|---|---|---|
ProxyAuth | bool | false | If this option is activated, the web client sends a message to the server during session initialization which informs him/her about the pre-authentication and the corresponding user code. |
ProxyUserFormat | string | plain | The format in which the value is provided. So far, only the "plain" format has been implemented, which passes the header value to the server. |
ProxyUserHeader | string | x-forwarded-user | The name of the HTTP header field which contains the user ID authenticated by the reverse proxy. |
AppPathBase | string | / | The web base path that the reverse proxy uses for the web client, e.g. if the web client can be accessed on the reverse proxy under http://www.example.com/webclient, the base path will be /webclient. |
ProxyLogoutRoute | string | Logout route which is opened when the user wants to terminate his/her session on the reverse proxy. |
WebAPI Authentication Settings
Parameter | Type | Default | Description |
---|---|---|---|
APIKey | string | APIKEY | API key which is used to access the web API end points |
Adaptive Card Settings
Signature settings
Parameter | Type | Default | Description |
---|---|---|---|
RsaPrivateKeyXml | string | XML formatted private RSA key for signing Adaptive Cards |
Upload Settings
Information
- Parameters which define the behavior in file uiploads.
- Must be defined within a
FileUploadSettings
block.
Parameter | Type | Default | Description |
---|---|---|---|
CompressionLevel | int | 6 | Zlib compression level, number between 0 and 9. Will be ignored if UseCompression = false |
AllowedExtensions | string | .doc, .docx, .xls, .txt | File endings which can be uploaded |
MaxFileSize | int | 2000000 | Maximum size of files in kB |
ChunkSize | int | 100000 | If a number > 0 is defined, the file will be uploaded in chunks according to the specified size. If 0 is defined, the file will be iploaded in a request. |
TemporaryFilePath | string | . | Path under which the files are temporarily saved during upload |
Message Dumper Settings
Information
- Message Dumper saves the communication with PLANTA Server: one xml file per session.
- The parameters must be defined within a
MessageDumperSetting
block.
Parameter | Type | Default | Description |
---|---|---|---|
Enabled | bool | true | Activate Message Dump feature |
LogDirectory | string | .\Logs\Dump | Path under which message dump files are saved |
Logging Settings
Information
- The PLANTA web client uses Serilog for logging.
- Serilog uses so-called "Sinks” for showing logs. The web client currently supports the following sinks:
- Console
- File
Change Host URL
Information
- ASP.Net Core applications use ports 5000 (http) und 5001 (https) by default.
- With the
Urls
parameter it can be overwritten as follows:
JSON:
"Urls": "http://localhost:9000;https://localhost:9001",
JS
Command line
--Urls:http://localhost:9000;https://localhost:9001
CODE