Settings
Web UI plugin is configured by the following global configuration settings.
Dashboards
Settings in this group configure dashboard behaviour.
Enable Caching. Switches caching for all web dashboards on or off. Dashboard specific cache configuration can override this option and disable caching for particular dashboards.
Cache Sizing Method. Allows to define whether maximum cache size is limited by Dashboard Instance Count or Memory Footprint.
Dashboard Instance Count. Maximum number of dashboard instances in the cache.
Memory Footprint. Maximum heap space allocated for dashboard instances.
Recaptcha Settings
Settings in this group configure reCAPTCHA usage.
Enable reCAPTCHA. Amends the login page with reCAPTCHA v3 authentication.
reCAPTCHA Server Key. Server key to use.
reCAPTCHA Secret Key. Secret key to use.
Number of reCAPTCHA Attempts. Maximum authorization attempt count.
Server-Side Rendering
Settings in this group configure whether the Iotellect server renders the initial HTML of the Web UI before sending it to the browser. Server-side rendering can result in faster page loads for the client, but also increases load on the server.
Enable Server-Side Rendering. When enabled, the Iotellect server will render the Web UI’s initial HTML before sending it to the client (browser).
Server-Side Rendering Port. Specifies the port number on which the rendering server is listening for requests.
Alias Configuration
Configure alias handling for all dashboards. To correctly process dashboard aliases, both the encode and decode expressions must be defined, since the alias encode and decode expressions work in tandem. The encode expression takes the dashboard context path and must return an alias. The decode expression takes an alias and must return the dashboard context path.
Alias Encode Expression. Define the rule for converting a dashboard context path into an alias. Must return a string, which will be the displayed as part of the URL for each dashboard.
Alias Encode Expression Resolution Environment: | |
None. | |
Root context. | |
None. | |
Standard variables and special variable The |
Alias Decode Expression. Define the rule for converting an alias to a dashboard context path. Must return a string representing the target dashboard context path.
Alias Decode Expression Resolution Environment: | |
None. | |
Root Context. | |
None. | |
Standard variables and special variable The |
![]() | Note that Best practice is to both ensure that the provided URLs include the full context path to the target dashboard, as well as considering both the short and full context path names in the Alias Decode Expression. For example, assuming a dashboard accessed through the
|
Customization
Settings in this group configure customization of Web UI's browser tab.
Custom Title. Allows to setup a custom browser tab prefix.
Custom Icon. Allows to setup a custom favicon.
User Analytics
Indicate a Google analytics tag to collect information on application usage.
Google Analytics Tag. Google analytics tag to be used in all Web UI pages.
Additional HTTP Headers
Indicate additional headers to be applied to all Web UI dashboards.
Format is the same as Additional HTTP Headers for individual Web UI Dashboards.
Any Additional HTTP Headers specified for an individual dashboard will be merged with the Additional HTTP Headers specified by this property when the dashboard is rendered.
<HEAD> Content
Indicate <HEAD> Content to be applied to all Web UI dashboards.
Format is the same as <HEAD> Content for an individual Web UI Dashboards.
Any <HEAD> Content specified for an individual dashboard will be merged with the <HEAD> Content specified by this property when the dashboard is rendered.
Custom Files
Some default parameters of the Web UI can be customized with override files.
Custom CSS
Change any part of the default CSS for the Web UI. Any CSS changes indicated in the file ~/<installation folder>/admin/web/static/style/custom.css
will be applied throughout the Web UI, including to all dashboards.
Was this page helpful?