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:
  1. appsettings.json: Main (default) configuration, changes are not recommended
  2. appsettings.[Environment].json: environmental specific (e.g. production) configuration
  3. Environment variables: are defined in the host operation system (e.g. passed on by using an e flag in a docker container)
  4. Command line parameter: can be used if the application was started with, e.g., the help of a shell scripts

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

{
    "ConnectionSettings": {
        "User": "username"
    }
}

--ConnectionSettings:User=username

Define parameters within an array

{
    "ConnectionSettings": {
        "Servers": [
            {
             "Host":"serverA",
             "Port":1234
            },
            {
                "Host":"ServerB",
                "Port":4567
            }
        ]
    }
}

--ConnectionSettings:Servers:1:Port=9999

Parameters:

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.

Server Sttings

Authentication settings

Configure if and how the reverse proxy tells us about the authenticated user. This requires the use of PLANTA secure.

WebAPI authentication settings

Adaptive card settings

Signing settings

Upload Settings

Information

• Parameters which define the behavior in file uiploads.
• Must be defined within a FileUploadSettings block.

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.

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:

"Urls": "http://localhost:9000;https://localhost:9001",

--Urls:http://localhost:9000;https://localhost:9001