Settings

Web UI plugin is configured by the following global configuration settings.

Dashboards

Settings in this group configure dashboard behavior.

Property

Description

Undo Redo Stack Size

Number of dashboard edit actions made in Web UI Builder that are kept in memory for Undo/Redo. When the stack limit is reached, the oldest actions are discarded as new ones are added.
Default value: 100

Open Timeout

Dashboard open/load timeout (in seconds). If the dashboard is not opened within this time, the operation times out.
Default value: 30

Connect to Server Before Showing Dashboard

When enabled (default), establishes WebSocket connections to the server before the dashboard is shown, so it appears fully interactive immediately.

When disabled, the dashboard is displayed as soon as possible and WebSocket connections are started afterwards. This speeds up the initial render, but the dashboard may be temporarily unresponsive after it appears. This is often suitable for public websites and portal pages.

Dashboard Cache

Settings in this group control dashboard instance caching.

Property

Description

Enable Caching

Enables or disables caching for all Web UI dashboards on or off. Dashboard specific cache configuration can override this setting.

Sizing Attribute Type

Defines whether maximum cache size is limited by Dashboard Instance Count or Memory Footprint.

Dashboard Instance Count

Maximum number of dashboard instances in the cache.

reCAPTCHA Settings

Settings in this group configure reCAPTCHA usage.

Property

Description

Enable reCAPTCHA

Enables reCAPTCHA v3 on the login page.

Server-Side Rendering

Settings in this group configure server-side rendering (SSR) for the initial dashboard HTML.

Property

Description

Server-Side Rendering Mode

Defines the activation mode for Server-Side Rendering (SSR).

  • Disabled: SSR is permanently disabled. The application always renders pages as a Single-Page Application (SPA).

  • Fallback Mode (If Available): The Iotellect server attempts to fetch pre-rendered HTML from the SSR service. If the SSR service is unavailable or returns an error, the system automatically falls back to SPA rendering. This ensures application availability even if the rendering service is down.

  • Strict Mode (Always): The server always attempts to render pages using the SSR service. If the SSR service is unavailable or fails, the server returns an error (e.g., HTTP 500). This mode is intended for debugging and strict SSR enforcement.

Server-Side Rendering Address

Specifies the hostname or IP address where the SSR service is deployed.

Alias Configuration

Settings in this group 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.
To disable processing of aliases, you should keep both expressions empty. Note that web/redirect() function always works with the full path of the dashboard context.

Alias Encode Expression

Define the rule for converting a dashboard context path into an alias. Must return a String, which will be displayed as part of the URL for each dashboard.

Alias Encode Expression Resolution Environment:

Element

Description

Default Data Table

A single-record table with a contextPath string field that contains the full context path of the target dashboard. In most cases, it will be something similar to users.<dashboard owner>.dashboards.<dashboard name>.

Default Context

Root context.

Default Row

None.

Environment Variables

Standard variables only.

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:

Element

Description

Default Data Table

A single-record table with a contextPath string field that contains the full context path of the target dashboard. In most cases, it will be something similar to users.<dashboard owner>.dashboards.<dashboard name>.

Default Context

Root context.

Default Row

None.

Environment Variables

Standard variables only.

{alias} can be both the full context name or only the name of the dashboard, depending on the provided URL.

Best practice is to 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 admin user, this expression catches both full and short context paths provided by {alias}:

startsWith({alias}, "users.admin.dashboards.") ? {alias} : "users.admin.dashboards." + {alias}

Customization

Settings in this group configure customization of Web UI's browser tab.

Property

Description

Custom Browser Tab Title

Specifies a custom browser tab title prefix. It is appended to the dashboard-specific title.

Custom Browser Tab Icons

Specifies a custom browser tab icon (favicon).

User Analytics

Settings in this group indicate how Google services collect analytics data about platform and application usage.

Property

Description

Google Analytics Tag

Enables Google Analytics tracking for Web UI pages.

Google Tag Manager Tag

Enables Google Tag Manager for Web UI pages.

Additional HTTP Headers

This setting specifies additional HTTP response headers that the server returns with Web UI Dashboard HTML pages.

The 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

This setting specifies additional HTML content to be added into the <head> element of Web UI Dashboard pages (for example, tags for custom styles or fonts).

Format is the same as <head> Content for an individual Web UI Dashboards.

Was this page helpful?