Configurable Dashboards

Configurable dashboards allow you to select a variety of widgets and arrange them into custom layouts or tabs. Widgets allow you to view data about specific sensors, sites, features, or to see aggregate data about your solution as a whole.

Default Dashboard

By default a personal dashboard is created as soon as you deploy a sensor and for everyone that is invited to join a CloudReady deployment. The system automatically creates a default dashboard with a number of different tabs in it.

Getting Started

To get started, navigate to a dashboard page and select a layout from the layout dropdown. Layouts represent tabs or workspaces where you can start adding widgets.

There are several pre-configured layouts that let you get up and running quickly as well as a blank layout that allows you to fully customize your experience. After you’ve added a layout, you can add, remove, and reconfigure each widget on the layout.

Much of what you do on a dashboard is saved automatically, but some actions are not. In that case, a count of active changes is kept over the save button, and you will be prompted to save before leaving a layout.

Dashboards

A dashboard is simply a collection of layouts or tabs. The dashboard is always available on the page, but it may be empty. In which case you will see a message prompting you to add a layout to begin.

Personal Dashboard

Each user gets a personal dashboard where they are free to manipulate different tabs and widgets.

Shared Dashboard

There is a shared dashboard area that is shared between all members of a tenant. By default the shared dashboard doesn’t have any tabs in it. To create or copy a tab from your personal dashboard to the shared area, you must have admin rights.

To copy a layout or tab from the personal are to the shared:

  1. Select a tab from your personal dashboard
  2. Once selected, you will see a gear icon on the tab. Click the gear for a drop down menu of options.
  3. Click ‘Copy to Shared Dashboard’

You can also copy a layout from the shared dashboard are to your personal dashboard.

Layouts

A layout appears as a discreet tab or sub-page on the dashboard, and you can switch back and forth between layouts to view different collections of widgets. There are several types of layouts available that have different capabilities, and more are in development.

Top level settings are available in the settings bar at the top of the page, and more are available in the layout settings dropdown. You can toggle whether layouts automatically refresh their widget data and rename, filter, sort, add widgets, or change how many columns all the widgets on the layout take up.

Widgets

Widgets represent a discreet data view. Some widgets show trends or charts for a particular sensor, others show overviews of sites, and some aggregate data from third-party APIs. A widget typically allows you to change its title, change which sensor, site, or tenant it points to (depending on the widget and your particular set of services), or remove it from a layout.

We are frequently developing new widgets, but you can read a brief overview of some of the current ones below:

  • All of these widgets show you data about a single sensor. They are added automatically to list layouts of the respective type. These widgets can be renamed, pointed to a different sensor, or removed from the layout. They also include a list of relevant links to allow you to get a more details picture of the state of that sensor.

  • O365 Service Health, and Messages

    These widgets show you data from Microsoft’s Office 365 Service Communications API. You can view the availability of services, a list of messages published by Microsoft and follow the link to view the same data on Microsoft’s Admin Center page.

  • Site and Solution Overviews

    These widgets show you how many sites and sensors are in either alarm or error states.

  • Site Map

    This widget shows you your sites laid out on a world map. The widget will try to find the location of your site based on the gateway IP address, but the best way to ensure the accurate display of sites is to pin a location to the site when it’s configured.

  • Site Grid

    This widget shows each type of sensor you have configured and each site you have set up. A cell is displayed at every intersection based on the state of the site. If you have set up a series of sensors for one site, but have not yet created corresponding sensors for another site, the appropriate cell will display a gap in data with a link to add a sensor there.

Where data is color coded, red, orange, and green represent error, alarm, and operational states respectively. State is displayed on a priority basis with error states superseding alarm states and alarm states superseding operational states, so, for instance, if a site has a sensor in error state, that site will be in error state regardless of the state of other sensors. If it has one in alarm state, the site will be in alarm. The site will show operational only if all sensors are operational at that site.

Updated on October 10, 2018

Related Articles