Creating Dashboards

• Introduction
• Create New Dashboard
• Dashboard Toolbar
  • Edit Mode
  • Add New Widget
  • Time Window
    • Time Window Modes
    • Key Parameters
    • Aggregation
    • Grouping Interval
  • Entity Aliases
    • Create Entity Alias
  • Filters
    • Add Filter
  • Dashboard Settings
    • Title Settings
    • Toolbar Settings
  • Dashboard States
    • Add Dashboard State
• Managing Dashboards
  • Export Dashboard
  • Import Dashboard
  • Make Dashboard Public
  • Manage Assigned Customers
  • Delete Dashboard
• Next Steps

Introduction

IndustryOS offers a powerful feature – the ability to create and customise interactive visualisations, also known as dashboards. These dashboards are instruments for monitoring and managing your data and devices efficiently. With IndustryOS dashboards, users can adapt interfaces to their specific needs, making it easier than ever to inspect their IoT devices and data.

Each dashboard can be populated with numerous widgets, offering flexibility and customisation. These dashboards aren’t limited to a single data source; they can display data from various entities, including devices, assets, and more. Plus, you can assign dashboards to specific Customers, ensuring that the right individuals or teams have access to the data they need.

Dashboards in IndustryOS provide users with the following capabilities:

• Data Visualisation - Create various widgets such as charts, graphs, tables, and more to visualise data obtained from connected devices. This enables operators and analysts to easily analyse information and track device statuses.
• Device Management - Dashboards can be used to perform management operations on devices, such as turning devices on or off, changing parameters, and so on. Users can set actions and respond to real-time data from devices.
• Interactivity - Dashboards can be designed with interactive elements such as buttons and switches, allowing users to interact with devices and data.
• Display Customisation - Users can customise the arrangement and size of widgets, choose colour palettes, fonts, and other visualisation aspects to create a user-friendly and informative interface.
• Role-Based Access - IndustryOS allows controlling access to dashboards with different levels of privileges based on user roles. This ensures data security and confidentiality.

Create New Dashboard

To add a new dashboard:

1. Log in to your IndustryOS instance and navigate to the Dashboards page through the main menu on the left of the screen
2. Click the “+” sign in the upper right corner of the screen, and select Create new dashboard from the drop-down menu
3. In the opened dialogue, enter a dashboard title (description is optional). Click Add
4. Once you have created the dashboard, it will be automatically opened. Save it by clicking the Save button in the upper right corner
5. Your first dashboard has been successfully created. As you continue to add new dashboards, they will appear at the top of the list

Dashboard Toolbar

Before starting work with a dashboard, familiarise yourself with its interface to understand which features are responsible for what actions.

The dashboard toolbar allows you to add new widgets, manage states, layouts, settings, aliases, filters, version control, and configure the time window using the corresponding icons in the toolbar.

Some of these icons (states, layout, settings, entity aliases, filters, version control, add new widget) are visible only in Edit mode. All other icons are visible in both View and Edit modes. You can hide these icons or configure the toolbar to be minimised by default using settings.

Edit Mode

To enter dashboard edit mode, simply open the dashboard you wish to edit and click the Edit mode button found in the upper right corner of the screen.

Once you’ve switched to edit mode, you access the dashboard toolbar to add new elements and access controls. Don’t forget to save your changes using the Save button, or if you decide to discard any unsaved edits, you can do so by clicking the Cancel button.

Add New Widget

All IoT dashboards are constructed using IndustryOS widgets. A widget is an element that displays a specific type of information or functionality on a dashboard. Widgets are used to visualise data, enable remote device control, manage alarms, and display static custom HTML content.

To add a widget to a dashboard:

1. Open your dashboard and switch to Edit mode
2. Click the + Add widget button at the top of the screen. If this is your first widget on the dashboard, you can also click Add new widget in the centre of the screen
3. Choose a widget bundle (for example, Charts). To quickly find your desired widget, use the search bar by clicking the magnifying glass icon and entering the widget’s name
4. Select a widget (for example, Time series chart) to open the Add widget dialogue
5. Specify the data source, add at least one data key, and click Add. Then Apply changes
6. The widget is now created

Each widget typically has specific settings and parameters that allow users to customise its behaviour and appearance according to their needs.

Time Window

The Time Window is a tool used to define time intervals when working with telemetry data. The time window is used by all time series and alarm widgets unless they are configured to use their own widget time window.

In the case of a time series widget, IndustryOS fetches telemetry with a timestamp that matches the time window. In the case of an alarm widget, IndustryOS fetches alarms with a created time that matches the time window.

Time Window Modes

The time window can work in two modes:

• Real-time mode - Widgets constantly receive updates from the server and automatically show you only the data that matches the time window for the current timestamp
• History mode - Widgets receive data only during the initial load and no updates are issued over WebSockets

Key Parameters

• Last - Displays real-time data for a specified time interval (e.g., the last 5 minutes, the last hour, or the last 24 hours)
• Range - Displays data for a fixed period, such as from 1 December 2024 to 7 December 2024
• Relative - Uses predefined intervals, such as the current day, the previous day, or the previous month

To display data for your desired time period, set the time range in the time window and click Update.

Aggregation

The data aggregation function is applied to time series data and does not apply to alarms. Currently, six aggregation functions are available:

• Min - Identifies the smallest value among all data in the selected time interval. Useful for displaying the minimum value, such as the lowest temperature recorded in an hour.
• Max - Identifies the largest value among all data in the selected time interval. This is useful for displaying the maximum value, such as the highest energy consumption level.
• Average - Calculates the arithmetic mean of all data in the selected interval. Useful for analysing average metrics, such as the average humidity over a day.
• Sum - Computes the total sum of all values in the selected time interval. This can be helpful for calculating the total volume of water or electricity consumed.
• Count - Counts the number of records in the selected interval. Useful for assessing the volume of data received or to count the number of events.
• None - Transmits raw data without applying any aggregation functions. Used when access to each unaltered value is required.

Data aggregation is useful when you do not want to retrieve all raw time series data to the user interface but prefer to pre-aggregate it at the database level. Using aggregation functions helps save network bandwidth and reduces the computational load on the client’s browser.

Grouping Interval

Group time series values by the specified time interval. This enables data analysis within a defined period and provides a more structured and convenient approach to handling large volumes of data.

For example, if a device sends temperature data every 10 minutes, but you need hourly average values, set the grouping interval to 1 hour and use the “Average” aggregation function. This will provide the desired result without additional processing on the client side.

Entity Aliases

Entity Aliases determine which entities (devices, assets, etc.) you would like to display on the dashboard. An alias can be thought of as a reference to one or more devices. These references can be static or dynamic.

An example of a static alias is the Single Entity alias. An entity is configured once in the alias dialogue box. All users see the same data if they have permission to access this device.

An example of a dynamic alias is the Device Type alias, which displays all devices of a certain type (e.g., “Thermometer”). This alias is dynamic because the list of devices depends on the user using the dashboard. If you are logged in as a Tenant administrator, this alias will resolve to all Thermometer devices. However, if you are logged in as a Customer user, this alias will resolve to Thermometer devices that are assigned/owned by that Customer.

Create Entity Alias

Let’s create a dynamic alias which displays all devices of a certain “Smart sensors” type:

1. Open your dashboard, enter edit mode and click the Entity aliases button in the upper right corner of the dashboard window. In the pop-up window click Add alias button
2. In the pop-up window enter alias name, select filter type and device type. Then click Add button
3. Click Save button to save the alias and save all changes

Filters

Entity filters allow you to specify a filter for the list of entities resolved by the entity alias.

Let’s look at an example. Suppose you have thousands of “Thermometer” devices, and you would like to display thermometers of a specific model and with certain battery levels. Let’s also assume that the thermometer model is stored as an attribute, and the battery level is stored as time series data. We will define a filter that checks if the sensor model is “DHT22” and the battery level is less than 20 percent.

Add Filter

1. Open your dashboard, enter edit mode and click the Filters button in the upper right corner of the dashboard window. In the pop-up window click Add filter button
2. In the pop-up window click Add key filter button
3. Enter key name, select key type and value type. Then add a filter that checks if the sensor model is “DHT22” and click Add
4. Add another key filter
5. Add a filter that checks if the battery level is less than 20 percent
6. Click Add button to add the new filter
7. Click Save and apply all changes

Filters are applied only to the “latest” value of the attribute or time series key. Don’t use this feature to “filter out” historical time series values.

Dashboard Settings

Dashboard settings allow adjusting and altering the overall look of the dashboard. You can change the title, logo, and customise the toolbar.

To start customising the dashboard, enter Edit mode, then click the gear icon in the upper right corner of the dashboard window to open the dashboard settings window.

Title Settings

If you want the title to be displayed on the dashboard, enable the “Display dashboard title” checkbox. The default text colour is black. Colour and transparency are easily adjusted using the Title colour parameter by clicking the coloured circle and choosing the desired colour for the title by moving the slider.

Toolbar Settings

The checkboxes “Display dashboard selection”, “Display entities selection”, “Display filters”, “Display time window”, “Display export” and “Display update dashboard image” are responsible for the visibility of the appropriate options on the dashboard toolbar panel.

The “Hide Toolbar” option will hide the toolbar from the dashboard page. Instead, on the upper right of the screen, you will find an “Enter edit mode” icon.

The “Keep toolbar opened” option is responsible for displaying the toolbar on the dashboard page. If disabled, the toolbar will be closed and a three-dots icon will appear in the upper right corner.

Dashboard States

The States feature exists to create a layered hierarchy in your dashboard. To use States properly, you need to assign a specific action to a widget that will help you quickly “travel” among the required states.

To manage dashboard states, enter edit mode and click the button with two-layered squares Manage dashboard states in the upper left corner of the dashboard window.

Since you haven’t created any states yet, you have only your “Root state”, namely your dashboard. Root state defines the main state of your hierarchy. After creating additional states, you can easily change a root state by clicking the “Pencil” icon (Edit dashboard state) and selecting the “Root state” checkbox.

Add Dashboard State

To add a new state:

1. Click on the “+” icon in the right upper corner of the window to open the Add dashboard state window
2. Assign a name, and the State ID will automatically generate based on that name, though you have the option to modify it
3. Click Add and then save all changes

You can navigate between states through a drop-down menu.

Giving a corresponding action to a particular widget allows travelling between states. To add an action, click the “pencil” icon (Edit widget) in the upper right corner of the widget to enter the widget configuration mode. Navigate to the “Action” tab and click the “+” icon to add a new action.

In the Add action window:

• Action source - A particular act that needs to be done to achieve an aim
• Name - A preferred title for the action
• Icon - A symbol for the action
• Type - The aim of the action (choose “Navigate to new dashboard state”)
• Target dashboard state - The newly created state to navigate to

Click Add, then Apply to save the changes.

Managing Dashboards

From the Dashboards page, you can perform operations such as exporting dashboards, making dashboards public, managing assigned customers, editing dashboards, and deleting dashboards using the corresponding icons next to each dashboard.

Export Dashboard

You can export a dashboard as a configuration file in JSON format. You can use this file to transfer your dashboard or widget configuration to another instance.

To export a dashboard:

1. Go to the Dashboards page
2. Find the dashboard you want to export in the list and click on the Export dashboard button located next to the dashboard’s name
3. The configuration file in JSON format with all settings will be saved on your PC

Alternatively, open the dashboard and click the Export dashboard button in the upper right corner of the screen.

Import Dashboard

You can import a dashboard from a JSON configuration file. This can be useful when you are migrating your dashboard configuration from another instance.

To import a dashboard:

1. Go to the Dashboards page and click on the “+” button in the upper right corner of the page and select Import dashboard from the drop-down menu
2. In the import dashboard window, upload the dashboard configuration JSON file and click Import
3. You have imported a dashboard. Open it to view the dashboard and all of its widgets

Make Dashboard Public

You can make a dashboard public and share a link to it with other users.

To make a dashboard public:

1. Go to the Dashboards page. Click the Make public icon next to the dashboard that you want to make public
2. Dashboard is now public. In the pop-up window, click Copy public link icon. You can now share the dashboard using this link, for example, by sending it via email

To make a dashboard private again:

1. Click the Make private icon next to the dashboard that you want to make private
2. In the confirmation dialogue box, click Yes

Note: To display data on a public dashboard, the associated entities must also be made public.

Manage Assigned Customers

You can assign a dashboard to your client. The customer will only have the ability to view the dashboard and won’t be able to perform any other operations on the dashboard.

To assign a dashboard to a customer:

1. Go to the Dashboards page and click the Manage assigned customers icon next to the dashboard that you want to assign to the customer
2. Select the customer(s) to assign the dashboard. Click Update
3. The dashboard is assigned to the selected customer

To unassign a dashboard from a customer:

1. Go to the Dashboards page and click the Manage assigned customers icon next to the dashboard
2. Remove the customer(s) from the assigned customer list. Click Update
3. Assigned customers list updated

Delete Dashboard

You can delete a dashboard using one of the following methods:

Method 1:

1. Go to the Dashboards page and click the Trash icon opposite the dashboard’s name you want to delete
2. Confirm deleting the dashboard in the dialogue box

Method 2:

1. Click the Dashboard details icon next to the dashboard that you want to delete
2. In the dashboard details, click Delete dashboard button
3. Confirm deleting the dashboard in the dialogue box

You can also delete multiple dashboards at once:

1. Mark one or multiple dashboards you want to delete. Click on the Trash bin icon in the top right corner
2. Confirm deleting dashboards in the dialogue box

Next Steps

• Widgets - Learn about widget types and configuration
• SCADA Symbols - Explore industrial visualisation symbols
• Data & Alarms - Understand the data displayed in widgets