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
    4. 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.
ParameterTypeDefaultDescription
CompressionLevelint6Zlib compression level, number between 0 and 9. Will be ignored if UseCompression = false
CultureCodestringde-DECulture Code which is used by the application. Depends on the host operating system. A list of culture codes can be found online as well.
IndividualParametersstringnullindividual_parameters-Parameter which is sent upon server start
KeepAliveTimeoutint60Time interval between keepalive signals sent to the PLANTA Server in seconds
RoutingRequestTimeoutint5Request timeout for routing requests to PLANTA link
RoutingWebHookstringnullThe PLANTA link webhook which is required for routing
PanelDestructionDelayint1440Time in minutes for which the web server saves panel information when the user has interrupted the connection or left the page
Passwordstringnullpassword parameter which is sent upon server start
SessionDestructionDelayint7200Time in minutes for which the web server saves session information when the user has interrupted the connection or left the page
ServersarraynullList of the PLANTA Server must at least contain one entry. Further information
UseCompressionbooltrueDefines whether communication with the PLANTA Server is to be compressed
Userstringnullindividual_parameters parameter which is sent upon server start
UseSSLboolfalseDefines whether SSL is to be activated for communication with the PLANTA Server

Settings of the Servers parameter

ParameterTypeDescription
HoststringServer Host Name
PortintServer 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.
ParameterTypeDefaultDescription
ProxyAuthboolfalseIf 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.
ProxyUserFormatstringplainThe format in which the value is provided. So far, only the "plain" format has been implemented, which passes the header value to the server.
ProxyUserHeaderstringx-forwarded-userThe name of the HTTP header field which contains the user ID authenticated by the reverse proxy.
AppPathBasestring/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.
ProxyLogoutRoutestring
Logout route which is opened when the user wants to terminate his/her session on the reverse proxy.

WebAPI Authentication Settings

ParameterTypeDefaultDescription
APIKeystringAPIKEYAPI key which is used to access the web API end points

Adaptive Card Settings

Signature settings

ParameterTypeDefaultDescription
RsaPrivateKeyXmlstring
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.
ParameterTypeDefaultDescription
CompressionLevelint6Zlib compression level, number between 0 and 9. Will be ignored if UseCompression = false
AllowedExtensionsstring.doc, .docx, .xls, .txtFile endings which can be uploaded
MaxFileSizeint2000000Maximum size of files in kB
ChunkSizeint100000If 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.
TemporaryFilePathstring.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.
ParameterTypeDefaultDescription
EnabledbooltrueActivate Message Dump feature
LogDirectorystring.\Logs\DumpPath 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