Waylay Dashboard

What is the Waylay Dashboard

The Waylay Dashboard is a multi-tenant, white-labeled dashboard application on top of a single tenant Waylay environment. With the Waylay Dashboard, end customers (typically the customers of Waylay’s customers) get an intuitive and wizard style dashboard to create graphs, alarms, notification tasks and actuations.


Why the Waylay Dashboard

The Waylay Dashboard addresses a number of limitations usually found in open-source visualization tools and comes with the following capabilities:

  • Integrated user/role management with the core Waylay platform,
  • Access to device meta data, ability to set or use friendly names for devices, or change thresholds for running rules that are derived from the meta data.
  • Create alarms and instantiate tasks/rules for notifications
  • Flexible device grouping in logical groups with tree based navigation
  • Trigger commands on devices


We assume you already have a Waylay account and Waylay environment ready to connect to, and have also requested a hosted version of the dashboard. The Waylay Console environment can then be added to your Waylay hosted environment. There is no limitation on how many Organisations you can support on your Waylay Dashboard instance.

After contacting our support team, you can use the Waylay environment admin account to configure the Waylay Dashboard for your customers: e.g. create Organisations and users, create graph dashboards, per Organisation brand the dashboard, create alarms and actuations, etc.


The Waylay Dashboard comes with the following features:

  • Self service organisation definition: a Waylay tenant admin can log in to the Waylay Dashboard and create “organisations” for each of the customers. An “Organisation” is a group of users that share a set of devices and a dashboard. Each organisation can have one or more organisation admins that can group devices and build dashboards.

  • It supports logical grouping of data and devices, mapped to the business context for each Organisation

  • Self service user account management: user, role and permission management is integrated with the Waylay platform. Organisation admins can create log in usernames and passwords for their users. Only tenant admins can create organisation admin accounts. Each account can only belong to one organisation.

  • Flexible and dynamic grouping of devices and tree based navigation

  • Drag & drop wizard for a statistics page per device or per group with a wide variety of widgets

  • View, add and edit device and group meta data: e.g. set tags, friendly names, …

  • Site map visualisation for device localisation

  • Geographical map for device localisation and geofencing; see also here

  • Command executions on devices

  • Self service threshold crossing alarm creation with notifications (sms, email, …) on device metrics.

  • Organisation specific service enablement and organisation specific settings, including task quotas and meta data whitelisting

  • Overview of alarms and clear/accept/acknowledge alarms

  • Sharing dashboards between Organisation admins and their users, dasbhoard import and export


A prerequisite for the Waylay Dashboard to be able to detect the right devices and their capabilities is to have the right information in the device/resource meta data in the Waylay environment:

  • Each resource must have a “customer” meta key and value. The value must correspond to the organisation id.
  • Each resource must have a “metrics” meta key and value. The value must have the following format. The definition of these metrics will be used by the graph widgets in the Waylay Dashboard. [ { “unit”: “”, “valueType”: “”, “name”: “”}, … ]
  • If a resource supports commands, there must be a “commands” meta key and value. The value must have the format defined in Waylay Commands

Check out this 2-minute video on how to get started in the Waylay Dashboard:

How to create a Waylay Dashboard

Branding capabilities

The Waylay tenant admin can define

  • The Waylay Console icons and favicons per organisation
  • The preferred language
  • The Waylay Dashboard URL (one per Waylay environment - to be set up by Waylay Devops)

Waylay Dashboard Users and Roles

The tenant admin or the organisation admin can create users that have access to the organisation dashboard. When users are created, they will receive an email from Waylay to activate their account. This activation email is brandable.

  • note: These users will only have access to the Waylay Dashboard and not to the Waylay environment

user_overview create_user

Waylay Dashboard users can have different roles. The below table gives an overview of the access rights and operations allowed for each of the roles


Organisation specific services

A tenant admin can customize the settings of services for each organisation and which settings are changeable by the organisation admin. For example, if the Twilio SMS service is available to send SMS notifications when an alarm is triggered, then the tenant admin can

  • Enable or disable this service for organisation admins. If it is disabled, then the organisation admin will not be able to choose SMS as action when creating an alarm
  • Make SMS service settings visible or invisible for organisation admins, e.g. hide the authentication token for the Twilio SMS provider.
  • Configure default SMS service settings, e.g. the FROM_PHONE originator telephone number for the SMS


The tenant admin can now set per organisation task quotas and meta data whitelists. The task quotas limits the number of tasks/alarms that an organisation admin can create within one organisation. If the task quota is exceeded, then the organisation admin will get an error message on the screen that any new task cannot be created.

The metadata whitelists are meant for tenant admins to define which device metadata is visible to the organisation admin and users. This allows the tenant admin to restrict the info widget to display only whitelisted metadata key and values.


Dashboard archival

We introduced a way to archive an organisation dashboard. Once a dashboard is archived, it is not deleted from the system, but it is no longer viewable for its users.


  • You cannot un-archive without help from Waylay Devops. Please contact us via the regular support channels.
  • You cannot re-use the same name for a new organisation
  • Archived organisations are excluded from billing reports

Collaborative dashboard development

Copy and unlink: this feature is particularly handy for dashboard building and collaboration between different organisation admins within one organisation. When you click ‘Copy dashboard & Unlink’, a local copy of the dashboard will be stored in your browser cache. After you made changes (e.g. add widgets to the dashboard), you can then again publish the dashboard which will overwrite the default dashboard stored in the cloud for this organisation. Another organisation admin, can then take the changes of the first organisation admin, click ‘Copy dashboard & Unlink’ and continue working on the dashboard.


You can now import and export dashboard configurations. When you click the export button, the browser will download a JSON file with the dashboard settings of the widgets

  • Note that dashboard input/export is only supported on the device level, not on the group level


Dashboard libraries

Once you logged into an organisation and started building dashboards, you’ll notice a new blue-white icon on the top right. This icon is only available to Organisation admins or Waylay tenant admins.


It gives you access to a storage location where you can store dashboards as templates.


This allows you to create a dashboard with widgets once and then (manually) store that dashboard, including it’s configuration in the dashboard library and then (manually) apply that template dashboard to another group or device within your organisation

  • note: you cannot share templates in your dashboard library across organisations

Device grouping

When defining a group in the Waylay Dashboard, you can define a query based on device tags, such that all devices with those tags automatically belong to your group. Tags can be added by the organisation admin on devices. Devices can have multiple tags and devices can belong to multiple groups at the same time. This mechanism is quite handy during the provisioning of new devices in the core Waylay platform: if the device gets an appropriate tag (and customer field) in the meta data, then the Waylay Dashboard will automatically add it to the right group in the UI.


You can also add devices manually to a particular group (without using the query mechanism). In this case, the group will have a fixed set of devices and the group is not automatically updated when a new device is provisioned in Waylay.

Organisation and device name alias

If you don’t like how the Organisation and devices appear in the list of organisations or navigation tree respectively, you can create an alias for them:

  • When you ‘edit’ your organisation, then you will find a new field ‘alias’ that allows you to give your Organisation an alias. That alias will be shown to the Organisation admin instead of the actual name

  • When you add a meta data field called ‘alias’ to a device, then the value for that alias will be used in the tree navigation. See also alias reserved keyword.

  • There is no alias for a group name


Time Series Graph

This graph shows a line chart for one or more metrics. It also provides Zoom controls and support value downloads in CSV file.

The Time Series Graph widget wizard allows you to add “References” to the chart. These can be set manually or fromthe meta data of your device.

  • For example, if you add “temperature_threshold” with value “50”, then you can add this meta data key in the “References” field and it will cause the time series widget to plot a straight line at y=50. It is a handy trick to visually see when a dataset is crossing a particular threshold value.

Scatter Plot Graph


Gauge widget

The gauge widget always takes the last raw value received so far. In other words, they are not controlled by the Time Window settings. In the gauge widget, this value is then rounded to the precision: e.g. if the precision is set to ‘2’, then the value is rounded to 2 digits after the dot.


Bulletin widget

The bulletin widget is capable of showing a list of multiple metrics and you can customize the foreground and background colors for each metric.

  • note: The bulletin widget always takes the last raw value received so far. In other words, they are not controlled by the Time Window settings


Info widget

The info widget allows you to visualise information that is typically static and stored in the meta data of a device: e.g. a URL to an FAQ page, a URL to an image of the device, etc. You can maninpulate the format of the data and its visualisation using the Markdown editor in the info widget wizard. For example, you can use HTML tags to show a clickable link that opens a new tab with external product documentation, or show an image with a fixed size.


Custom tables using the Info widget

We’ve made an extension to the info widget to be able to create custom tables. Concretely, you can now add the following code in the Markdown editor of the Info widget wizard:

{{RESOURCE:METRIC MyDevice:temperature}}

The Waylay Dashboard will auto-resolve this to the last value in our time series database for metric ‘temperature’ from device with name = ‘MyDevice’

For example, if you use the following Markdown code in your info widget, then you get the following fancy table

| <h3>Energy</h3> | <h3>Shop Status</h3> |
| Energy Consumption: <font color="red">{{RESOURCE:METRIC example_store:ActualActiveEnergyConsumption}} </font> kWh | <h1>{{RESOURCE:METRIC example_store:isOpen}}</h1> |

| <h3>External</h3> |
| Outside temperature: {{RESOURCE:METRIC example_store:weather_temperature}} Degrees Celsius |


Alarm widget

The alarm widget allows you to show a historical log of all alarms for a particular alarm type


Analytics widget

The analytics widget offers you the ability to show Time Series Analytics data models and predictions. The TSA models need to be created via the core Waylay platform, see Time Series Analytics

Map widget

The map wigdet allows you to show the location of one or more devices, their trajectory and any geofences. See also the geofencing use case

Aggregation widget

The aggregation widget is only available on a group level. It allows to calculate an aggregated value over a number of devices that have the same metric: e.g. calculate the average temperature over all temperature sensors in the office.


Widget refresh rate

Every time you refresh your browser you force refresh for all widgets and then the data is re-fetched for all widgets. You can also refresh one graph at the time, using the refresh icon per widget.

Next to this, the widgets are also auto-refreshed:

Widget Auto-refresh rate
Timeseries every 15 minutes
Scatter every 15 minutes
Info every 15 seconds
Gauge every 5 seconds
Bulletin Single stat: every 5 seconds, Timeseries: every 60 seconds
Alarm every 10 seconds
Aggregation every 15 minutes
Map every minute