Housekeeper Dashboard

What is Housekeeper

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

plugins

Why Housekeeper

Housekeeper 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 resource meta data, ability to set or use friendly names for resources, or change thresholds for running rules that are derived from the meta data.
  • Create alarms and instantiate tasks/rules for notifications
  • Flexible resource grouping in logical groups with tree based navigation
  • Trigger commands on devices

Installation

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 Housekeeper dashboard environment can then be added to your Waylay hosted environment. There is no limitation on how many Organisations you can support on your Housekeeper instance.

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

Features

Housekeeper comes with the following features:

  • Self service organisation definition: a Waylay tenant admin can log in to Housekeeper and create “organisations” for each of the customers. An “Organisation” is a group of users that share a set of resources and a dashboard. Each organisation can have one or more organisation admins that can group resources 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 resources and tree based navigation

  • Drag & drop wizard for a statistics page per resource or per group

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

  • SVG site map upload for resource localisation

  • Geographical map for resource localisation

  • Command executions on resources

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

  • Overview of alarms and clear/Accept/Acknowledge alarms

  • Sharing dashboards between Organisation admins and their users

Configuration

A prerequisite for Housekeeper to be able to detect the right resources and their capabilities is to have the right information in the 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 Housekeeper. [ { “unit”: “”, “valueType”: “”, “name”: “”}, … ]
  • If a resource supports commands, there must be a “commands” mata key and value. The value must have the format defined in Waylay Commands

Branding capabilities

The Waylay tenant admin can define

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