|
Configuration of the Client Properties
Starting with version 2020.1, Panopticon Streams Server generates a streams.json configuration file in the JavaScriptConfiguration directory of the AppData folder (i.e., c:\streamsserverdata).
The default content of the streams.json file has the following objects/names:
{
"baseUrl" : ".",
"hideAuthenticationButton" : false,
}
|
NOTE |
In the JSON files, a dot in the name (e.g., name1.name2) is used to denote a nested object structure: { "name1": { "name2": ... } }
|
In the streams.json file, you can control the configuration of the following objects/names:
|
|
|
|
Object/Name |
baseUrl |
|
Description |
Location of Panopticon Streams Server. |
|
Default Value |
"." |
|
Required |
Yes |
|
Object/Name |
automaticReconnectOnServerDisconnect |
|
Description |
If set to true, then the real time connection (WebSocket or long polling) to the Panopticon server will be automatically reconnected if it is disconnected. |
|
Default Value |
false |
|
Required |
No |
|
Object/Name |
dataLoading.transport |
|
Description |
Controls the which transport should be used when viewing log from the server. Valid values are "websocket" and "long-polling". If configured to "websocket", but the WebSocket connection fails, then the web client will automatically fall back to "long-polling". |
|
Default Value |
"websocket" |
|
Required |
No |
|
Object/Name |
maxClipboardLength |
|
Description |
Maximum length of text that will be attempted to be put into the system clipboard (copy). If too much text is attempted, then the browser might become unresponsive. |
|
Default Value |
500000 |
|
Required |
No |
|
Object/Name |
hideAuthenticationButton |
|
Description |
Boolean. Hides the login and logout buttons. |
|
Default Value |
false |
|
Required |
No |
|
Object/Name |
localization.useBrowserLocale |
|
Description |
Boolean. If set to true, then the browser navigator.language, navigator.userLanguage on IE11, controls the localization of the UI. Not all languages are supported. |
|
Default Value |
true |
|
Required |
No |
|
Object/Name |
localization.defaultLocale |
|
Description |
Locale used if the browser locale is not supported, or if useBrowserLocale is set to false. |
|
Default Value |
"en-US" |
|
Required |
No |
|
Object/Name |
localization.fallbackLocale |
|
Description |
Locale used if a resource string is missing from the locale in use. Should be specified if localization.defaultLocale is specified. |
|
Default Value |
value of localization.defaultLocale |
|
Required |
No |
|
Object/Name |
localizationOverride |
|
Description |
Nested object with resource strings per language. Used to customize resource strings. |
|
Default Value |
|
|
Required |
No |
|
Object/Name |
logLevel |
|
Description |
Controls which types of logs Panopticon will write to the browser dev console. Valid values are: "trace", "debug", "info", "warn", "error" and "silent". |
|
Default Value |
"info" |
|
Required |
No |
|
NOTE |
If there are no config files available on the server, default ones will be created and saved. After that, you can alter them in any way you would like and keep the configuration even if the server is restarted.
|