NetLock RMMNetLock RMM Docs
II — Console Reference

Dashboard

Widgets, creating and deleting dashboards, the Panel Builder, and the first-run Setup Wizard.

Dashboard

The Dashboard is the default landing page for most users. It is a grid of panels, configurable widgets that display information from the Console's database: device counts, sensor values, event slices, and anything else you can express as a SQL query. Each user can create multiple dashboards, each with its own set of panels, and arrange them in an explicit layout mode.

Default dashboard with three panels

Requires permission: the dashboard must be enabled for your user. A user without this permission does not see the Dashboard menu entry.

Overview

The Dashboard page sits at /dashboard. At the top is a bar of dashboards you have created; the active dashboard shows below it as a grid of panels. Dialogs handle creating and deleting dashboards and adding or configuring panels.

The first-run Setup Wizard

The first time a newly provisioned administrator opens the Dashboard, the Setup Wizard opens automatically. It walks through the minimum configuration needed to make the product useful: creating a first tenant, location, and group, and optionally downloading an agent installer. See First-Run Walkthrough for the full sequence.

You can close the wizard and reopen it from the help area later. If your environment is already set up, dismiss it and proceed directly to the empty dashboard.

Creating a dashboard

A fresh user starts with one empty default dashboard. You can create more so that different roles or different periods of the day get their own view (for example a "morning triage" dashboard and a "server health" dashboard).

  1. Click the add button in the dashboard bar to open the Add Dashboard dialog.
  2. Enter a name in the dashboard bar.
  3. Save. The new dashboard is active and empty, ready for panels.

Dashboards are per-user. Two users do not share each other's dashboards unless an administrator configures defaults (see A.12 Content defaults).

Deleting a dashboard

  1. Open the dashboard you want to remove.
  2. Use the delete action to open the Delete Dashboard confirmation.
  3. Confirm. The dashboard is removed immediately along with all panels it contains.

Warning: Deleting a dashboard cannot be undone. The panels you configured are lost. Recreate them from the Panel Builder if necessary.

Adding and configuring panels

Panels are the individual widgets that make up a dashboard. Use the Panel Builder to add or reconfigure them.

  1. On the active dashboard, click Add Panel.

  2. The Panel Builder opens.

  3. Choose a panel type: chart or table. For chart, also pick a chart sub-type: bar, line, area, pie, doughnut, or radar.

  4. Build the data query. Pick a catalog widget, or write your own SQL statement. For your own statement the Panel Builder offers a SQL query builder with:

    • aggregate functions COUNT, SUM, AVG, MIN, MAX, and DISTINCT;
    • filter operators =, !=, <, >, <=, >=, LIKE, NOT LIKE, IS NULL, IS NOT NULL;
    • joins INNER JOIN, LEFT JOIN, RIGHT JOIN;
    • ORDER BY direction ASC or DESC.

    The query builder lists exactly the tables and columns the MySQL user for SQL access can read; you can also type the statement directly. See SQL panels and SQL access below.

  5. For chart panels, configure the label column and value column that map the query rows onto the chart axes or slices.

  6. Configure display settings: colours, legend position, legend visibility, axis labels, fill (area / line), line tension (line / area).

  7. Configure the panel size in the dashboard grid: Width in grid columns (1-12) and Height in pixels (200-1200).

  8. Save. The panel appears on the dashboard and renders from its query.

SQL panels and SQL access

A panel with its own SQL statement (typed directly or generated by the query builder, including its preview in the Panel Builder) runs only over the MySQL user configured under Settings → SQL access. That user's grants decide which tables and columns the statement can read. Setting it up is described in Set up SQL access for reports, dashboards and custom fields; on cloud instances SQL access is not available.

  • Creating and changing SQL panels needs the permission dashboard_sql_panels and assignment to every tenant of the instance.
  • On save, the statement is checked with EXPLAIN over that user (syntax, tables and columns it may read). When MySQL refuses it, its message is shown.
  • A panel that was added from one of the shipped panel templates and still carries the template statement unchanged runs without SQL access, like the built-in report templates. Once its statement is edited, it needs SQL access.
  • Without SQL access, all other SQL panels are locked with a notice, on the dashboard and in the TV view. The Panel Builder shows a notice with a link to Settings → SQL access and offers neither the query builder, the SQL field nor the AI SQL assistant. Catalog widget panels are not affected.

Panel types at a glance

TypeSub-typeBest forData shape
chartbarRanked counts across categorieslabel + value
chartlineTrend over timelabel (time) + value
chartareaTrend over time with emphasised volumelabel (time) + value
chartpieProportional breakdownlabel + value
chartdoughnutProportional breakdown, ring stylelabel + value
chartradarMulti-axis comparisonlabel + value
table—Raw rows with many columnsany

Sensor status widget

The Sensor status widget of the Monitoring category is a chart with the sensors of your devices that are OK, failing or offline. It is not part of the standard dashboard; add it to a dashboard of your own. When a dashboard carries it, the TV view shows its three counters in its header. The widget needs the sensors permission of the Collections area and counts only the devices of the tenants your account is assigned to.

The state comes from the events the sensors reported. A sensor is failing while an unread sensor event of its device names it and no newer "Sensor Resolved" event of that sensor exists. Reading the event on the Events page acknowledges the failure and the sensor returns to OK, and so does a resolved event the agent writes when the check passes again. Failed sensor runs ("... failed") count as failing as well. Sensors of offline devices are counted as offline, not as failing. The sensors a device is expected to run follow its policy, its automation rules and the SNMP devices it monitors, the same way the agent receives them. Each sensor event carries the id of the sensor, so renamed sensors and sensors with the same name are matched exactly. OK also means that no failure was reported at all.

Rearranging panels

Panels are laid out in a responsive grid. To reposition or resize them:

  1. Click Edit Layout in the dashboard header to enter layout mode.
  2. Adjust each panel's width (1-12 columns) and height (200-1200 pixels) using the inline numeric fields that appear on every panel.
  3. Click Exit Layout Mode to save the layout.

Layout is stored per-user per-dashboard; your layout does not change what other users see on their own dashboards.

TV view

Every dashboard can be shown full screen on a wall display or an office monitor. On the Dashboard page, select the dashboard and click Open TV view. The view opens in a window of its own without the menu, the app bar and the editing controls, refreshes its panels by itself and shows the time of the last refresh, a countdown to the next one and a clock in its header.

The address of the view is /dashboard/tv/<id>, where 0 is the standard dashboard and any other id is a dashboard you can see. The view is always dark, whatever theme the console uses. One optional query parameter adjusts it:

  • refresh=<seconds> sets how often panels without an interval of their own are refreshed. The default is 60 seconds, the minimum 15, the maximum 3600. A panel with its own refresh interval keeps that interval. Panels with their own SQL statement are never refreshed more often than every 300 seconds, the smallest interval the Panel Builder offers for them, whatever this parameter says.

Example: https://console.example.com/dashboard/tv/12?refresh=120

The view follows the sharing of the dashboard and the permissions of the signed-in account. It needs the dashboard permission, a dashboard of another user is only shown while it is shared with the account or visible to everyone, and a widget the account may not see stays locked, as on the dashboard page. The panel definitions are read again once per refresh interval, so panels added, changed or removed on the dashboard page appear on the TV without a reload; a dashboard that is deleted or unshared while the view is open is replaced by a notice.

TV playlist and TV settings

The TV view menu on the Dashboard page offers Open this dashboard, Open playlist and TV settings. The settings dialog holds the playlist of your account: the dashboards the rotating view shows in order (the standard dashboard can be one of them), how long each stays on screen (30 seconds to 5 minutes) and how often the panels are refreshed. The dialog also shows the address of the playlist view, /dashboard/tv, with a copy button, so it can be typed into the browser of the TV device. Every account has one playlist of its own.

The playlist view rotates through the entries, shows the position and the next dashboard in its header and reads the playlist again after every full round, so changes made in the dialog appear without a reload. An entry you may no longer see is skipped, and the view shows a notice when the playlist is empty. The refresh query parameter takes precedence over the stored setting.

Sign in with Remember me on the device that shows the view. The open view keeps the session from idling out, but every session ends when its absolute lifetime is reached; the view then shows a notice with a Sign in again link instead of redirecting on its own, so the screen never ends up on the sign-in page unattended. The sign-in page brings the account straight back to the TV address it came from, whether the sign-in is done with a password or through SSO; only a TV address is accepted for that return. The notices mean:

  • No permission: the account does not hold the dashboard permission.
  • Dashboard not available: the dashboard was deleted, or it is no longer shared with the account.
  • Session expired: the session has ended; sign in again and the view comes back on its own.
  • Playlist is empty: the playlist has no entry you may see; add dashboards in the TV settings.

The unread events list appears below the panels when the dashboard is set up to show it and the account may see events.

Common tasks

Set up a tenant-overview dashboard for an MSP

  1. Create a new dashboard named after the tenant.
  2. Add a device-count panel scoped to that tenant.
  3. Add an event feed panel filtered to that tenant's devices.
  4. Optionally add sensor panels for critical devices (a file server's disk usage, a domain controller's CPU).
  5. Switch between per-tenant dashboards via the dashboard bar as you move through your queue.

Build a quiet "watch list" dashboard

  1. Create a dashboard named Watch list.
  2. Add quick-access panels that link to the specific devices you are currently watching after a policy rollout or software deployment.
  3. Add an event feed filtered to the same devices.
  4. Remove the dashboard when the watch window ends.

Reset a cluttered dashboard

If a dashboard has grown unwieldy, create a new one and delete the old one. Panels are quick to recreate with the Panel Builder, and you keep only the panels you use.

Permissions and conditional behaviour

  • Access to the Dashboard is gated by a user-level permission. Users without it do not see the page or the menu entry.
  • The panels you can add depend on the data you are permitted to see. For example, a user scoped to a single tenant will only see that tenant's devices in a device-count panel, regardless of how the panel is configured.
  • The Setup Wizard is only shown on the administrator's first visit to the Dashboard and can be dismissed.