URL Handling

The Dashboard URL can be modified with additional parameters for added functionality and flexibility. As such it can be used to enhance or shorten processes for the user, for example, by directly addressing sub-pages or logging in automatically.

The dashboard can be reached both by the standard long address,

https://<hostname>/data/dashboard-wc/index.html

and a shortened address of

https://<hostname>/#/index.html

. The short URL however can only be used properly if the config entry [httpServer] indexPage is set to data/dashboard-wc/index.html. In case this is not set, the short URL will show the standard Desktop UI Download page on reload (See also dashboard_advanced_url_handling.html#dashboard_advanced_url_handling__add_redirect). If [httpServer] indexPage is set, the short URL will redirect to the long URL in case a reload is necessary. The long URL will always reload correctly.

When [httpServer] indexPage is set, the corresponding data/dashboard-wc/index.html part of an address can be omitted from the URL:

.../data/dashboard-wc/index.html#dashboard/12

This is shortened to:

.../#/dashboard/12

Note:

This shortening of the URL may not work correctly in combination with additional parameters added to the URL.

Login Page

The login page can be reached at:

.../data/dashboard-wc/index.html#/login

The use of #/auth (notation from the former angular Dashboard) will redirect to #/login.

Write Permissions

In case write-permissions are desired, open the login page with the dbrw parameter:

.../data/dashboard-wc/index.html#/login?dbrw

System Dashboard

The sdb parameter can be used to access only the System Dashboard:

.../data/dashboard-wc/index.html#/login?sdb

This option requires and uses no licenses, but no dashboards other than the System Dashboard can be accessed.

Automatic Login

The login can be automated with the use of a token:

.../data/dashboard-wc/index.html#/login?token=<Token ID>

.../data/dashboard-wc/index.html#?token=<Token ID>

Note:

The use of a token can not be combined with the use of the dbrw parameter, as this must already be set when the token is created.

Specific Dashboard Access

A specific Dashboard can be accessed directly after login:

.../data/dashboard-wc/index.html#/dashboard/lt;dashboard number>

.../data/dashboard-wc/index.html#/login?redirect=/dashboard/lt;dashboard number>

Combining Parameters

A combination of some parameters is possible. For example, an automated login with a redirect to dashboard 12 can look like this:

.../data/dashboard-wc/index.html#/dashboard/12?token=<Token ID>

.../data/dashboard-wc/index.html#/login?redirect=/dashboard/12&token=<Token ID>

Note:

Not all parameters can be added after a page has already been loaded (e.g.: the dbrw cannot be used to add write permissions after loading). Best practice is to place the full URL in a new window and open it there.