Dashboard Service

The DashboardService must be added to a station's Services container. Note that using dashboards requires that the dashboard-rt, dashboard-ux, and dashboard-wb modules be installed on the platform. The service is responsible for reading dashboard data from, and writing dashboard data to db*.json files stored in the dashboards directory which is located within the protected station home (local:|platformssl:|file:~stations/stationName/dashboards/userName).

Actions

The DashboardService provides two admin actions that permit clearing your own dashboard data from the system, and if logged on as a super user, you can clear all dashboard data (made by any user) from the system. Right-click on the service to select either of these actions:

  • Clear My Dashboards:

    Clears all of the dashboard data (changes you have made) from the system. Therefore, if you are logged on (and have admin invocation privileges on the service), you can invoke this action to clear all of your dashboard data from the system.

  • Clear All Dashboards:

    If you are logged on as a super user, you can invoke this action to clear dashboard data for all users from the system. If not logged on as a super user, you will see an error message upon invoking this action.

Dashboard Service properties

Name Value Description
Status read-only
Reports the condition of the entity or process at last polling.

{ok} indicates that the component is licensed and polling successfully.

{down} indicates that the last check was unsuccessful, perhaps because of an incorrect property, or possibly loss of network connection.

{disabled} indicates that the Enable property is set to false.

{fault} indicates another problem. Refer to Fault Cause for more information.

Fault Cause read-only
Indicates the reason why a system object (network, device, component, extension, etc.) is not working (in fault). This property is empty unless a fault exists.
Enabled true or false
Activates (true) and deactivates (false) use of the object (network, device, point, component, table, schedule, descriptor, etc.).