Configuration of the Client Properties

Starting with version 2020.1, Panopticon Real Time generates JSON configuration files in the JavaScriptConfiguration directory of the AppData folder (i.e., /etc/panopticon/appdata).

NOTE: In the JSON files, a dot in the name (e.g., name1.name2) is used to denote a nested object structure:

{
  "name1": {
    "name2": ...
  }
}

The default content of the admin.json file has the following objects/names:

{
"baseUrl" : ".",
"hideAuthenticationButton" : false,
}

In the admin.json file, you can control the configuration of the following objects/names:


Object/Name	automaticReconnectOnServerDisconnect
Description	If set to true, 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	baseUrl
Description	Location of Panopticon Real Time.
Default Value	"."
Required	Yes
Object/Name	dataLoading.transport
Description	Controls 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	hideAuthenticationButton
Description	Boolean. Hides the login and logout buttons.
Default Value	false
Required	No
Object/Name	localization.defaultLocale
Description	Locale used if the browser locale is not supported, or if the 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	localization.useBrowserLocale
Description	Boolean. If set to true, 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	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
Object/Name	workbookUrl
Description	Location of the workbook application. NOTE: The workbookUrl property should reflect the actual location of the workbook application, but it doesn’t rename or change the location of said application.
Default Value	"workbook"
Required	Yes
Object/Name	dataLoading.connectTimeout
Description	Controls the timeout used, in milliseconds, when opening the data loading connection to the server.
Default Value	10000
Required	No
Object/Name	showFileUploadUI
Description	Controls the visibility of UI that is used to upload a file to the server.
Default Value	true
Required	No
Object/Name	showLinkToFileUI
Description	Controls the visibility of UI that is used to specify a data file on the server local file system as a data source. Per default, this flag is automatically inserted into the client configuration at runtime.
Default Value	true
Required	No
Object/Name	visibleViewerTabs.datatables
Description	Controls only visibility of Data Library tab for viewer role.
Default Value	true
Required	No
Object/Name	visibleViewerTabs.webhooks
Description	Controls only visibility of Webhooks tab for viewer role.
Default Value	true
Required	No
Object/Name	visibleViewerTabs.alerts
Description	Controls only visibility of Alerts tab for viewer role.
Default Value	false
Required	No
Object/Name	visibleViewerTabs.parameters
Description	Controls only visibility of Parameters tab for viewer role.
Default Value	false
Required	No
Object/Name	visibleViewerTabs.themes
Description	Controls only visibility of Themes tab for viewer role.
Default Value	false
Required	No
Object/Name	visibleViewerTabs.system
Description	Controls only visibility of System tab for viewer role.
Default Value	false
Required	No
Object/Name	visibleDesignerTabs.datatables
Description	Controls only visibility of Data Library tab for designer role.
Default Value	true
Required	No
Object/Name	visibleDesignerTabs.webhooks
Description	Controls only visibility of Webhooks tab for designer role.
Default Value	true
Required	No
Object/Name	visibleDesignerTabs.alerts
Description	Controls only visibility of Alerts tab for designer role.
Default Value	true
Required	No
Object/Name	visibleDesignerTabs.parameters
Description	Controls only visibility of Parameters tab for designer role.
Default Value	true
Required	No
Object/Name	visibleDesignerTabs.themes
Description	Controls only visibility of Themes tab for designer role.
Default Value	true
Required	No
Object/Name	visibleDesignerTabs.system
Description	Controls only visibility of System tab for designer role.
Default Value	false
Required	No
Object/Name	maxrowcount
Description	Controls the maximum number of rows a table can return.
Default Value	100000
Required	No
Object/Name	preventDataLoadOnMaxRowCountExceeded
Description	Controls whether an exception is raised when number of rows from the data table exceeds maxRowCount or should the rows be truncated.
Default Value	true
Required	No
Object/Name	connectors.showLegacyButton
Description	Controls the visibility of the Show Legacy Connectors switch button in the select connector panel. Used to show/hide legacy connectors.
Default Value	true
Required	No
Object/Name	connectors.legacyVisible
Description	Default value of Show Legacy Connectors switch button in select connector panel.
Default Value	false
Required	No

The default content of the workbook.json file has the following objects/names:

{
  "baseUrl" : "..",
  "forceClientSelectionHandling" : true,
  "startUrl" : "../",
  "subscriptionCompression" : true,
  "dataLoading" : {
    "transport" : "websocket"
  },
  "webGlEnabled" : true,
  "pdfMultiplePagesEnabled" : true
}

In the workbook.json file, you can control the configuration of the following objects/names:


Object/Name	baseUrl
Description	Location of Panopticon Real Time.
Default Value	".."
Required	Yes
Object/Name	localization.useBrowserLocale
Description	Boolean. If set to true, 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
Object/Name	disableExternalHelpText
Description	Disables the browser dev console splash screen.
Default Value	false
Required	No
Object/Name	theme
Description	Name of the default theme for all workbooks. Per default, the first theme available is picked as the default theme.
Default Value
Required	No
Object/Name	allowOrigin
Description	A comma separated list of allow origins, used by the Panopticon POST message API.
Default Value
Required	No
Object/Name	automaticReconnectOnServerDisconnect
Description	If set to true, 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	alwaysHideNonInteractiveParametersInDialog
Description	Hides parameters that are not interactive when displaying the interactive parameter dialog.
Default Value	false
Required	No
Object/Name	enableDevicePixelRatioCanvasScaling
Description	Enable or disable handling of device pixel ratio for 2D visualizations.
Default Value	true
Required	No
Object/Name	staleStateTimeout
Description	Time (in milliseconds) that controls how fast the "stale data" overlay should be rendered on top of visualizations. Only applies to those interactions that doesn't show "data loading" animation. A value equal to or less than zero will disable the stale data overlay.
Default Value	150
Required	No
Object/Name	preloadDetailsPopup
Description	Data to be shown in the Details pop-up is preloaded as part of the visualization data request. If set to false, then the details data will be loaded on demand.
Default Value	true
Required	No
Object/Name	forceClientSelectionHandling
Description	If set to true, then selection handling in the visualizations will be performed by the client. If set to false, then the server will calculate the selection.
Default Value	false
Required	No
Object/Name	subscriptionCompression
Description	Controls if data query strings longer than 2048 chars should be compressed by the web client before sending them to the server.
Default Value	false
Required	No
Object/Name	pdfMultiplePagesEnabled
Description	Controls the visibility of the "Create multiple pages..." checkbox in the ad hoc PDF report dialog.
Default Value	true
Required	No
Object/Name	startUrl
Description	URL used by the Home and Back buttons, and by the dialog for unexpected errors.
Default Value
Required	No
Object/Name	useBrowserHistoryToNavigateBack
Description	If set to true, the Back button will execute window.history.back() when pressed. This setting takes precedence over having a configured startUrl.
Default Value	false
Required	No
Object/Name	hideThemeSelection
Description	Controls the visibility of the theme drop down.
Default Value	false
Required	No
Object/Name	dataLoading.transport
Description	Controls the which transport should be used when loading data from the server and receiving notifications. Valid values are "websocket" and "long-polling". If configured to "websocket", but the WebSocket connection fails, then the web client will automatically fall back on "long-polling".
Default Value	"websocket"
Required	No
Object/Name	dataLoading.connectTimeout
Description	Controls the timeout used, in milliseconds, when opening the data loading connection to the server.
Default Value	10000
Required	No
Object/Name	preventVisualizationMouseWheelDefaultEvents
Description	Prevents the browser default action when using the mouse wheel over a visualization. Useful in an embed scenario if the hosting web page is scrolled when the user tries to zoom in a visualization using the mouse wheel.
Default Value	false
Required	No
Object/Name	webGlEnabled
Description	Enables the use of WebGL in visualizations that supports it.
Default Value	true
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	selectionInDetailsPopup
Description	Enables/disables selection data in the visualization details popup. Primary use case for this setting is to disable it on a server level.
Default Value	true
Required	No
Object/Name	showAlertsButton
Description	Controls the visibility of the Alerts workbook button.
Default Value	true
Required	No
Object/Name	showBackButton
Description	Controls the visibility of the Back workbook button.
Default Value	true
Required	No
Object/Name	showBookmarksButton
Description	Controls the visibility of the Bookmarks workbook button.
Default Value	true
Required	No
Object/Name	showCopyDashboardImageButton
Description	Controls the visibility of the Copy Image workbook button.
Default Value	true
Required	No
Object/Name	showHomeButton
Description	Controls the visibility of the Home workbook button.
Default Value	true
Required	No
Object/Name	showPdfExportButton
Description	Controls the visibility of the Create PDF Report workbook button.
Default Value	true
Required	No
Object/Name	showRefreshDataButton
Description	Controls the visibility of the Refresh workbook button.
Default Value	true
Required	No
Object/Name	showPauseRealtimeButton
Description	Controls the visibility of the Pause Real-Time workbook button.
Default Value	true
Required	No
Object/Name	showExcelExportButton
Description	Controls the visibility of the Create Excel Report workbook button.
Default Value	true
Required	No
Object/Name	pluginDenyList
Description	Array of plugin IDs, used to block the specified dashboard parts and visualizations.
Default Value	empty array
Required	No
Object/Name	pluginAllowList
Description	Array of plugin IDs, used to allow only the specified dashboard parts and visualizations. The default value, an empty array, allows all plugins.
Default Value	empty array
Required	No
Object/Name	showFileUploadUI
Description	Controls the visibility of UI that is used to upload a file to the server.
Default Value	true
Required	No
Object/Name	showLinkToFileUI
Description	Controls the visibility of UI that is used to specify a data file on the server local file system as a data source. Per default, this flag is automatically inserted into the client configuration at runtime.
Default Value	true
Required	No
Object/Name	partCreator.showLegacyButton
Description	Controls the visibility of the Show Legacy switch button in the Select part panel. Used to show/hide legacy visualization parts.
Default Value	true
Required	No
Object/Name	partCreator.legacyVisible
Description	Default value of Show Legacy switch button in select part panel.
Default Value	false
Required	No
Object/Name	maxrowcount
Description	Controls the maximum number of rows a table can return.
Default Value	100000
Required	No
Object/Name	preventDataLoadOnMaxRowCountExceeded
Description	Controls whether an exception is raised when number of rows from the data table exceeds maxRowCount or should the rows be truncated.
Default Value	true
Required	No
Object/Name	connectors.showLegacyButton
Description	Controls the visibility of the Show Legacy Connectors switch button in the select connector panel. Used to show/hide legacy connectors.
Default Value	true
Required	No
Object/Name	connectors.legacyVisible
Description	Default value of Show Legacy Connectors switch button in select connector panel.
Default Value	false
Required	No
Object/Name	autoBucketingEnabled
Description	Controls if automatic time bucketing columns should be created.
Default Value	true
Required	No

NOTE:

With the new application configuration files, the workbook/config.js inside the extracted war file is no longer valid.
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.

Intellectual Property Rights Notice | Technical Support