Skip to main content
Skip table of contents

Web Client Configuration

Information

  • Here you will find a description of the PLANTA Web Client configuration.

Basics

Information

  • There are several ways to apply configurations. Below, all options are 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:

Commanfd line:

JS 
{ 
	"ConnectionSettings": { 
		"User": "username" 
	} 
}
CODE 
--ConnectionSettings:User=username

Define parameters within an array

JSON:

Overwrite ServerB port in the command line:

JS 
{ 
	"ConnectionSettings": { 
		"Servers": [ 
			{ 
			 "Host":"serverA", 
			 "Port":1234 
			}, 
			{ 
				"Host":"ServerB", 
				"Port":4567 
			} 
		] 
	} 
}
CODE 
--ConnectionSettings:Servers:1:Port=9999

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 the 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

AI settings

Parameter

Type

Description

ChatHost

string

URL of the AI assistant chat.

The AI assistant is configured in a separate container. See here.

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 the 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.

JwtAuth

bool

false

When enabled, the Webclient will use JWT/OIDC for authentication (enables OIDC flows).

JwtAuthOnClient

bool

false

When true the client initiates the OIDC login flow by itself; otherwise the OIDC login flow will be initiated by reverse proxy.

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

Name of the HTTP header field that contains the user ID authenticated by the reverse proxy.

ProxyUserAccessToken

string

x-forwarded-access-token

Name of the HTTP cookie that contains the JWT access token

ProxyUserIdToken

string

x-forwarded-id-token

Name of the HTTP cookie that contains the JWT access token

AppPathBase

string

/

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.

OidcSettings

OIDC Settings

Configuration for the OpenID connect authentication

ReverseProxyJwtSettings

ReverseProxyJwtSettings

Configuration for the JWT authentication via reverse proxy (Cloudflare by default).

ReverseProxyJWT settings

Parameter

Type

Defaut

Description

HeaderKey

string

Cf-Access-Jwt-Assertion

HTTP header key that contains the application JWT from the reverse proxy (default: Cf-Access-Jwt-Assertion). The authentication service also checks if the header name contains Cf- to detect Cloudflare usage.

The HTTP header key that contains the application JWT from the reverse proxy. The authentication service also checks whether the header name contains Cf- to recognize the use of Cloudflare.

IssuerUrl

string

Expected iss claim value of the incoming token (e.g. your Cloudflare Access Issuer URL).

JwksUrl

string

JWKS end point URL used for validating the token signature.

Audience

string

Expected aud claim value. In Cloudflare Access, it is usually the 64 digit hex tag.

Notes

  • When JwtAuth is true and JwtAuthOnClient is false, the client tries to find the tokens made available by the reverse proxy either in cookies (standard OIDC cookies) or in the configured HeaderKey. If HeaderKey contains a Cf prefix and a matching request header exists, the reverse proxy/Cloudflare flow is used. .

  • After successful validation, the client sends an XML message of the <ProxyToken type="1" .../> type that contains the application token in access_token to the backend. The backend must support type="1" and access_token as validated reverse proxy JWT.

OIDC settings

Information

  • Parameter for configuring the OpenID connect authentication.

  • They must be defined within the AuthenticationSettings.OidcSettings block.

Parameter

Type

Default

Description

ClientId

string

Oauth client ID that is used for token validation.

ClientSecret

string

Client secret that is used for authentication to the OIDC provider.

DiscoveryUrl

string

URL for the OIDC identification document.

Scope

string

Access area requested by the OIDC provider.

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 that define the behavior in file uiploads.

  • They must be defined within the 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 the 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) and 5001 (https) by default.

  • With the Urls parameter it can be overwritten as follows:

JSON:

Commanfd line:

JS 
"Urls": "http://localhost:9000;https://localhost:9001",
CODE 
--Urls:http://localhost:9000;https://localhost:9001

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close