Dashboard Service

Overview

The following sections will walk you through all functionalities of Brightlayer Dashboard

For your convenience find an overview on the content of this document below.

Dashboard Tenant Tiers

Dashboard Tenant Tiers

Capability	Start	Flex	Flexplus
Dashboard application and standard widgets
Smart rule (alarming)
Non-shared environment
Dashboard branding	Eaton	Individual	Individual
Streaming Analytics
Long term data storage in Data Lake

Brightlayer Dashboard Start

• Economic solution
• Eaton branding
• Low cost access to powerful IoT-system
• Starter kit users
• Data storage options in application (up to 10 years)
• Basic support function

Brightlayer Dashboard Flex

• Individual branding
• Data storage options in application (up to 10 years)
• Direct access to BLIM ticketing system. Preferred support access. Technicians that have been trained on the Brightlayer tools may get access to directly open tickets on the Brightlayer support system. Support can also be requested via the local Eaton support teams in your country.

Brightlayer Dashboard Flexplus

• This level of dashboard tenant tier extends the functionality of a Flex tier. All features that are available in a Flex tier are also available in Flexplus tier.
• Data offloading into Data Lake. Easy access to historical data via Business Intelligence tools.
  • Especially for higher data volumes and longer storage periods it may be more cost effective to store data in a Data Lake and not in the operational storage of Brightlayer IM.
  • The operational storage and the data explorer tool are ideal for analyzing historical numeric data and specific time periods. For data types like char or text and for SQL queries Business Intelligence tools offer very broad capabilities to search for and analyze data. The offloading mechanism of the Flexplus tier allows to store data in external Data Lakes for highly professional, historical and big data analysis.
  • Within one hour of integrating measurements, events and alarms into the Dashboard tool, all your data is available in the external data lake.
  • The Dremio tool controls the access to your data on the Data Lake. It provides a huge variety of possibilities to connect your Business Intelligence tools or any other Software to easily access your data in the Data Lake (https://docs.dremio.com/cloud/client-applications/). (Additional tools and software like Business Intelligence tools are not part of Eaton’s offer. Eaton could help you to select the right tool for your business purpose).
  • The Eaton support team would set up the offloading mechanism, the Data Lake and the Dremio tool.
  • It would also be possible to integrate Frames of your Business Intelligence tools into your Brightlayer IM dashboards by using the HTML widget.

UI Elements and Features

Home Dashboard Service

The Home screen of the Brightlayer Dashboard Service is your access to all possibilities of structuring and analyzing your data via dashboards that are organized in groups and structures.

Main screen elements

The general structure common to all Brightlayer Dashboard applications includes the following screen elements:

Element	Description
Navigator	On the left you find the navigator. At the top of the navigator the name and logo of the application is displayed, indicating which application you are currently using. Below you find a list of entries leading to the various pages of the application. The entries are grouped into menus and menu items. You can collapse or expand menus in the navigator by clicking the menu name. Clicking the small arrow at the very left of the top bar will hide/or unhide the navigator. Per default, it is visible.
Page	"Page" actually refer to the main area in the application. The content provided here depends on the menu item selected in the dashboard. The structuring of the content differs from page to page. Data may for example be displayed in a list with a row for each object or you may find it being presented in a grid in which objects are represented by cards.
Top bar	Page title At the left of the top bar the title of the active page is displayed, if any. Plus button Most application pages show a Plus button at the top bar. A context menu opens after clicking on it providing further functionalities. The context menu is created dynamically, i.e. it depends on the active page which commands are provided. User button On the right side of the top bar you will find the User button with your user name. Clicking it will open up a context menu with commands related to your account settings. Other buttons/ information may be available in the top bar depending on the application and the page being displayed.
Top menu bar	Depending on the active application and the active page, a secondary bar is displayed below the top bar providing further functionalities like an Info link to show additional information about a group or a Data explorer link to start the data explorer application.

On smaller screens, the layout is slightly different. The navigator is hidden and can be accessed by clicking the arrow icon on the top left. Only the active tab is displayed.

Info: Brightlayer Dashboard provides tooltips when you hover over a particular screen element. When you use Brightlayer Dashboard on touch devices, tooltips are shown when you touch a screen element for a longer time.

Search functionality

Full text search

Brightlayer provides a full text search, available through the search field at the right of the top bar in the UI.

The search result includes groups, devices and child devices. On entering a search term into the textbox, Brightlayer returns all devices containing this term in any property (name, model, any fragment).

The search functionality is based on the MongoDB full text search.

Entering multiple words separated by a blank returns all objects that match any of the words. For example, entering

My Demo Device

will return objects containing “My”, “Demo” or “Device”.

If you want to search for objects matching an exact phrase enclose it in quotation marks:

"My Demo Device"

You can also exclude words by putting a hyphen before the word to search the inventory for objects containing e.g. “My” or “Demo” but not “Device”:

My Demo -Device

Case is ignored. The following search texts return the same result:

My Demo Device
my demo device

Real-time behavior of Brightlayer Dashboard

In Brightlayer Dashboard, changes are not updated in real time, i.e. new, removed or renamed devices or groups will not be updated immediately.

If you have several windows open in Brightlayer Dashboard and you unassign a device from a group, you will immediately see it removed from the group in the current dashboard, but if you change to the other window you won’t see the changes.

You will only see the changes after a refresh or another request (expanding a group in the navigator for example).

User options and settings

Clicking the User button at the top right will open a menu which provides access to user settings for the dashboard service.

The User menu contains the following items:

The majority of user settings are controlled by the authorization server and can not be modified by the user. To change the language select your language of choice from the dropdown list. It is recommended to logout and login again to make sure the changes become effective in all applicable fields.

Managing groups and devices

Introduction

Customers and their projects can organized hierarchically with the asset management system on the left side of the homescreen.

The asset hierarchy is composed of two types of objects:

• Groups: Objects which group single devices or other groups. New sub-groups can be created in the group menu after clicking on the group. Clicking on “Add group” would open a menu to enter the group name. Confirming the input would result in the creation of a new group.

• Devices: Devices which are linked into the asset hierarchy. Before you can use devices in the Brightlayer Dashboard application, they need to be connected to Brightlayer. This is done in the Gateway configuration. If you do not have access to the Gateway configuration please contact your Administrator for support.

To position a device in the group, you have to “assign” the device to the respective group.

Info: Currently a new virtual devices can only be created by the local Eaton service team! Eaton Care Germany

Asset hierarchy vs device hierarchy

In the Brightlayer Dashboard application, you construct your asset hierarchy by creating group objects and by linking devices into the hierarchy. The asset hierarchy depends on the IoT devices used. There are many types of IoT devices, but these three types are very common:

• Smart devices are self-contained devices that include sensors, actuators and a communication module. They are typically connected to a single asset. Examples for Smart devices are the Digital Twin for the motor solution or single sensors. Usually a smart device would have several data points.

• Virtual devices are groups of single data points of an application. E.g. to reduce data traffic and implementation effort it may make sense, to combine single datapoints (tags) into a virtual device.

• Gateway devices establish the communication from other devices to the Brightlayer Suite but do not include sensors or actuators.

The following section explains how to work with smart devices and gateway devices in the Brightlayer Dashboard application.

In the Dashboard application, you can organize smart devices into groups, as the arrows indicate in the above diagram.

Gateway devices are as well represented as top level devices in the Device Management application. Their attached devices are shown as child devices. These child devices can be organized in different groups. Devices that belong to one Gateway device could be assigned to different groups. This is typical as you may have only one Gateway device but several applications in one site (e.g. machines, pumps, etc.). As you may want to organize the different machines in separate groups, the devices can be assigned independently of the Gateway device.

Dashboard assets vs business assets

The mapping of objects in the Dashboard asset hierarchy is a virtual hierarchy.

If you manage mobile machines within the Brightlayer platform, then each mobile machine is represented via its individual tracking device communicating with Brightlayer.

To manage factory / production / operation sites, it is most common that a group of sensors inside a site represents the site as a group communicating with the Brightlayer platform.

Navigating assets

In the asset hierarchy, Brightlayer distinguishes between top-level groups and subgroups, so called sub-assets.

In the navigator, top-level groups are shown in the Group menu at top-level. Sub-assets are shown under its top-level group. Moreover, sub-assets are shown in the Sub-asset tab of the particular group.

When selecting an object in the asset hierarchy, details on the selected object are displayed at the right.

To navigate further in the asset hierarchy, use the navigator or select an object in the Sub-Asset tab. To navigate up in the asset hierarchy, use the breadcrumb entry below the name of the asset.

Asset details

Several tabs are available for each object, dependent of the object type:

If dashboards have been created for an object, they will also be added as a tab. See Working with Dashboards for details.

To create a group

1. Select the desired parent group.

2. Click on the sub-asset menu.

3. Click on “Add group” at the top menu bar, on the right side of the bar type in a new group name

4. Click next to assign the devices in the second step.

5. Click on “Create” to create the new group.

Assign devices to a group subsequently

Before you can add a device to an asset hierarchy, the device must be connected to the Brightlayer platform. Connecting devices to the platform is done in the gateway configuration.

To assign a device to a group, complete the following steps:

1. In the Navigator, select a group from the Groups menu and go to the Child Assets tab. In the Child-Assets tab, all devices assigned to the corresponding group are displayed.

2. Click Assign Devices on the right side of the top menu bar.

3. In the subsequent dialog, you can enter search criteria for the devices you want to add to the group. A list of matching devices is displayed.

4. Select the devices you want to add. Click Assign to add the devices to the group.

The devices will be shown as sub-assets in the Sub-assets tab.

To edit a group

1. To edit the name of a group, navigate to the Subassets tab and click next to the group icon.
2. Edit the name and optionally leave some notes.
3. Click Save to apply your settings.

To delete a group

To delete a top-level group from the navigator, follow these steps:

1. Click Groups in the navigator.
2. In the Groups page, click the delete icon at the right of the group.

To delete a group from the Sub-assets tab of another group entry, follow these steps:

1. Navigate to the Sub-assets tab.
2. Click the delete icon at the right of the group entry.

To unassign a device from a group

1. Navigate to the Sub-assets tab of the group.
2. Click the unassign icon at the right of the device you want to unassign.

Unassigning a device does not remove the device, sub-devices or any associated data. The device is only removed from its location in the asset hierarchy. It can be assigned to this group or other groups later.

Data explorer

In the data explorer, data points, i.e. measurements or sensor data, can be visualized.

The data explorer is available for all assets or just for a particular asset.

• Navigate to a particular asset and switch to the Data explorer tab to visualize all data points of this particular asset and its sub-assets.

In the data explorer, you see a list of available data points on the right. For details on how to add data points see Adding data points.

On the left, in the main card, you see its visualization.

Changing data explorer visualization

To change the visualization in the data explorer, you can modify several properties.

Time range

You can change the time range being shown. By default, you see the values for the last hour.

To change the time range on the X-axis,

• Select a different time range from the dropdown list in the top menu bar.
• Enter a custom time range into the From and To fields in the data explorer.
• Drag the X-axis and move it to left or right to move the time period.
• Double-click into the data explorer to zoom out.

Info: Real-time updates will be switched off if you set a time range in the past.

Aggregation

You may aggregate the data being displayed to get an efficient overview over larger time periods.

By default, aggregation is set to “None”. This value may be changed in the Aggregation field in the top menu bar. Available values are “Minutely”, “Hourly” or “Daily”, depending on the selected time range.

When aggregation is activated, the timestamp which is displayed in data point graphs or data point tables changes slightly to improve transparency:

• If no aggregation is selected the date, hour, minute and second are shown:
  27 Jan 2020 17:26:55
• If minutely aggregation is selected, the second indication will not be shown:
  27 Jan 2020 17:27-17:28
• If hourly aggregation is selected, the minute and second indication will not be shown:
  27 Jan 2020 05:00-06:00
• If daily aggregation is selected, only the day will be shown:
  27 Jan 2020-28 Jan 2020.

Realtime updating

By default, realtime updating is enabled which means that the data being shown is updated as new data flows into the system from the connected devices.

To turn realtime updating on or off, click Realtime in the top menu bar. A green light indicates, that realtime updating is enabled.

Data point visibility

For each datapoint, its visibility can be switched on or off by using the slider left from the data point name.

Adding data points

To add a data point to the data explorer, click Add data point at the bottom of the Data points card.

In the top of the dialog, select a device from the asset hierarchy. Only the asset hierarchy below the objects selected in the navigator is visible.

The bottom of the dialog shows all data points of the selected object. Select the data points you want to show in the data explorer. Click Add to add all selected data points to the list of data points.

To remove a data point from the data point list, click the menu icon and select Remove from list.

Customizing data point properties

You can customize the visualization of a particular data point to your preferences. To do so, expand the data point entry in the data point list.

The following fields my be modified:

Y-axis behaviour

Per default, the first data point is positioned to the left y-axis and the remaining data points to the right. This behavior can be changed by modifying the respective value “Y-axis” for a particular data point (to “Left” or “Right”, see above).

Each data point is shown on its own y-axis, unless the following condition is met:

• Two data points having the same minimum and the same maximum value.

In this case, both data points share the same y-axis. This y-axis only shows the unit (or multiple units, in case they are different). The label is not shown.

Adding alarms or events

In addition to data points you can also add alarms or events to the data explorer.

In the Alarms/ Events card, click Add alarm/ event to add an alarm or event.

In the upcoming dialog, you can select an alarm or event from the list of recent alarms and events. Click Add, to add your selection.

Expand an event, to modify its properties.

Click the menu icon and in the context menu select Remove, to remove the entry from the list.

As with data points, you can turn the visibility of an alarm/ event in the data explorer on and off by moving the slider.

Creating widgets from the data explorer

If you want to keep your current configuration in the data explorer for later usage, save it as a widget.

Send as widget to dashboard

To create a widget from the data explorer of a particular asset, click More… in the top menu bar and select Send as widget to dashboard from the context menu.

In the upcoming dialog, select one of the dashboards available for the current object and click Select to add the data explorer widget to the selected dashboard.

Info: To use this function, first a dashboard has to be created. For details on dashboards, refer to Working with Dashboards.

Exporting measurement data

You may download measurement data as CSV files. The exported data shows the following information, divided into columns:

• Time when the specific measurement was taken
• Source of the measurement
• Name of the device being used
• Fragment series (for example ’etn_SpeedMeasurement')
• Value of the measurement
• Unit used for a particular measurement (for example “C”, “km/h”, “sec”)

To export measurement data, click the More… button in the top menu bar and select  Download as CSV.

The download will be generated, as shown in the upcoming dialog. This may take a while, depending on the number of data points added to the data explorer. Once the loading has been completed, click Download.

Dashboards

Dashboards provide you with a customized visualization of your data by using a set of widgets. Widgets can display maps, images, graphs, tables and other graphic representations of data.

Brightlayer Dashboard comes with a number of preset widgets, see Widgets collection for details.

To create a dashboard

Select the group or the device in the navigator for which to create a dashboard.

Click the Plus button in the top bar and from the context menu select Add dashboard.

The dashboard editor opens.

In the Tab section of the dashboard editor, provide the following information:

• An icon which is shown next to the dashboard name in the navigator.
• A menu label to be used as the name of the dashboard.
• The location of the dashboard in the navigator, with “10000” being ordered first and “-10000” last

If you enable Apply dashboard to all devices of type the dashboard will be shared with all devices of this type.

In the Layout section you can select a theme for the dashboard (one of “Light”, “Dark”, “Transparent” or “Branded”) and a default header style for the widgets (one of “Regular”, “Border”, “Overlay”, or “Hidden”). Moreover, you can change the default widget margin (default value is 15 px).

If you enable the option Translate widget titles if possible, the widget title will be translated every time the language is changed.

Info: The widget titles will be translated only if a valid translation is available.

In the Preview section at the right, a preview of the selected layout settings is immediately displayed to visualize your selections.

Click Save to create and open the dashboard.

Since there will be no widgets on the dashboard yet, you will see an Add Widget button instead.

To add a widget to a dashboard

1. Click the Add widget button (in case of an empty dashboard) or click Add widget in the top menu bar.

2. In the Add widget dialog, select a widget.

   

3. Next, configure the widget. According to the selected widget, various parameters may be specified under Configuration. For details on each widget refer to Widgets collection.

4. In the Appearence tab, you can customize the content and header style for the widget individually, in the same way as specifying the layout of the dashboard.

   

5. Click Save to add the widget to the dashboard.

Modifying widgets on a dashboard

Widgets may be rearranged on the dashboard. By dragging and dropping you can move the widget to another position.

By dragging the arrows on the bottom right corner of a widget, you can resize it.

To edit the properties of a widget on a dashboard, click the cogwheel icon at the top right corner of the widget and from the context menu select Edit.

To delete a widget from a dashboard, click the cogwheel icon at the top right corner of the widget and from the context menu select Remove.

Widgets can only be modified, if the dashboard is unlocked. To lock/unlock a dashboard, use the slider with the lock icon on the top menu bar.

Info: On touch devices like smartphones or tablets some functions may not be supported.

To edit a dashboard

To edit a dashboard, click Edit in the top menu bar.

The dashboard editor will open up. For details on the fields, refer to To create a dashboard.

To delete a dashboard

To delete a dashboard from an object, click More… in the top menu bar and from the context menu select Delete dashboard.

Widgets collection

The Brightlayer Dashboard application includes preset widget types. Each widget type provides different parameters to configure and different data to be displayed.

The following section describes, in alphabetical order, each available widget type and its configuration properties.

Alarm list

The “Alarm list” widget shows a list of alarms, filtered by objects, alarm severity and alarm status.

Parameters to configure

Data point graph

The “Data point graph” widget shows a data point (measurement) in a graph. The visualization is the same as in the data explorer.

The easiest way to create a “Data point graph” widget is to navigate to the data explorer, click the More… button in the top menu bar and select Send as widget to dashboard.

Refer to Visualizing data using the data explorer for further details on the parameters to be configured.

Data point list

The “Data point list” widget shows data points (measurements), one in each row, with current values and data point properties.

Parameters to configure

Data point table

The “Data point table” widget configuration is similar to the “Data point graph” widget, but instead of visualizing the data as a line-chart, data is visualized as a table.

The “Data point table” widget displays data based on selected data points, time interval and aggregation.

Out of range values, based on configured yellow and red ranges, are highlighted in the table.

Digital Twin (Motor Solution)

The ‘‘Digital Twin (Motor Solution)’’ widget is providing a quick overview of all relevant data points, parameters and alarms of the connected device. The widget is usually connected to a specific CMS-device (Connected Motor Solution) these devices are generated during Gateway configuration.

To use the widget, first add the widget ‘‘Digital Twin (Motor Solution)’’ to the dashboard. After successful adding, the following view is displayed:

Field	Description
Main	The Main tab shows 5 data points that can be selected in the edit menu. In a pie chart the runtime, idletime and triptime of the connected motor are displayed. Hovering with the mouse over the segments of the pie chart shows the absolute values of the 3 data points in hours (02:45:44 h). Editing the Main tab: Before data can be displayed, a device has to be connected. Once the device is connected the data points that should be shown on the main tab could be collected with the toggle switches . A CMS-device provides error messages from the application. Depending on the value of the error message tag, alarms can be generated. To activate this function the "Activate / De-activate Error Messages" button has to be set to "active".
Data	In the Data tab every data point of the CMS-device can be displayed.  Editing the Main tab: With a toggle switch data points can be selected and deselected from being shown on the Data tab window. Smart alerts can be created for every data point by adding absolute values into the ''High Warning'' and ''High Alert'' fields. The "High Alert" value always needs to be higher than the "High Alert" value. If just one Alarm is required, the value has to be set in the ''High Alert'' field. After setting the values the alarm function has to be activated by clicking the button at the end of the line.
Alarms	In the Alarm tab, all alarms of the device are displayed. The error code, the error name, the date and error time are visible for the user.
Parameter	In the Parameter tab all parameter data points of the CMS-device can be displayed. Data points can be selected / de-selected in the edit menu.
Device	In the device tab, all information of connected devices can be displayed. Data points can be selected / de-selected in the edit menu.

Creating a Smart Alarm in the Digital Twin widget

Select the data tab in the Digital Twin widget and open the “edit” menu. Smart alarms could be generated for each data point in the list. Two alarms are possible per data point: “High Warning” and “High Alert”. For example insert for Temperature the value 80 (High Warning) and the value 100 (High Alert). Activate the Alarm via the button (“Active”/“Inactive”) on the right. An alarm will be generated when the temperature is at 80 and a second alarm when the temperature is at 100.

Info: If you only need one alarm, make sure you put the value into “High Alert”.

Editing and Deleting Smart Alarms

The Digital Twin widget is using Smart Rules to generate and manage the smart alarms. A number of smart rules is created for both alarm functions of the Digital Twin.

Info: Smart Alarms should be edited and deleted by using the function in the edit mode of the Digital Twin widget. Changing or modifying smart rules that have been automatically generated by the widget would most probably lead to a malfunction of the alarm and the widget. Before deleting a widget from a dashboard that had smart alarming activated, it is highly recommended to de-activate all alarms that have been activated in the widget. Otherwise Smart rules may not be deleted correctly.

Event List

The “Event List” widget lets you monitor events for a selected device

Additionally, a specific date range can be set and the events can be monitored in realtime.

Image

The “Image” widget lets you display a single image to be selected from your file system by browsing. Images can be uploaded in file sizes of up to 300kb.

Info Gauge

The “Info gauge” widget visualizes one data point in form of a radial gauge and multiple data points as labels.

You can select one data point for the gauge, and multiple data points shown with labels on the left side.

You must enable at least one data point in each section to create the “Info gauge” widget.

HTML

The “HTML” widget shows user-defined content. The content can be formatted using HTML.

Parameters to configure

• Target assets or devices: Select the objects for which optional HTML expressions are evaluated.

• HTML code

  The following variable can be used inside the HTML content:

  • {{device.name}}: The name of the device.

“Device” refers to the target device, as selected in the widget configuration parameter.

Linear Gauge

The “Linear gauge” widget visualizes data points in form of a linear gauge. Min and max target values are shown on the gauge as well.

Info: If a label is not properly readable, you can help yourself by increasing the min and max value of the data point to move the label into the readable range.

You must enable at least one data point to create the “Linear gauge” widget.

Map

The “Map” widget shows the location of a device or all devices of a group.

Info: Currently the GPS data of a device in the Map widget can only be set by the local Eaton service team! Eaton Care Germany

You can drag the map and move its content, and you can zoom in and out by using the Plus and Minus buttons.

The icons representing the devices are color-coded. The color used follows these rules:

• Red = At least one CRITICAL alarm
• Orange = At least one MAJOR alarm
• Yellow = At least one MINOR alarm
• Blue = At least one WARNING
• Green = No alarm

Click a device icon, to open popup with the following information:

• The device name. When clicked, the application navigates to the device.
• The date at which the device last reported its location, if available.
• A slider to show/hide the device tracks for the previous and current days.

Info: If none of the target device(s) has a known location, then the widget shows a world map without icons.      

Pie chart

The “Pie chart” widget displays data points (measurements) with current values in a pie chart presentation.

Parameters to configure

Radial Gauge

The “Radial gauge” widget visualizes data points in form of a radial gauge.

You must enable at least one data point to create the “Radial gauge” widget.

SCADA

The “SCADA” widget provides a graphic representation of the status of a device.

Info: All SVG files are sanitized in order to remove malicious code.

Info: Currently the images in the widget can only be set by the local Eaton service team! Eaton Care Germany.

Create a SCADA widget

To use the “SCADA” widget, follow these steps:

1. Select a dashboard and click Add widget in the top menu bar.
2. Select the “SCADA” widget and edit the title of the widget.
3. Choose the device that should be shown in the widget in the Target assets or devices section.
4. Upload an SVG file with the graphic representation of the device. SVG files are vector graphics that have to be specifically prepared with placeholders for the status information, see section Preparing SVG files for the SCADA widget.
5. Assign placeholders to devices. Note that multiple devices can be taken as source.
6. You now need to assign each placeholder to a property of the device. Hover over each placeholder and select Assign device property or Assign fieldbus property. In the upcoming dialog box, basic device properties or fieldbus properties (i.e. status coils and registers) can be chosen. Select the desired property and click Select.
7. After assigning all placeholders, a preview of the widget with the current values of the properties is shown. Click Save to place the widget on the dashboard.

Preparing SVG files for the SCADA widget

The SCADA widget accepts SVG files which use AngularJS directives, for example ng-if, ng-show, ng-style, ng-repeat, ng-click, for dynamic data presentation.

Moreover, JavaScript event attributes (like onclick, onmouseover) can be used in SVG files uploaded to SCADA widgets.

Data from devices (like latest measurements and other properties) are provided via placeholders. There are also predefined helper functions which can be used.

For creating SVG files most SVG editor can be used, e.g. one can use any of these editors:

• BOXY SVG is an easy to use, quality Chrome extension.
• Inkscape is a powerful desktop application available for all major platforms.

Placeholders

For a placeholder to be recognized by the SCADA widget, it must occur at least once in double curly braces with no other expression, for example {{placeholderName}} (in a comment, attribute’s value, or element’s content - see example). Once annotated, the placeholder can be used within other expressions, for example {{placeholderName * 3.1415}}, ng-class="{ active: placeholderName > 100 }" or ng-if="placeholderName === 'VALUE'".

Predefined functions

The following predefined functions are available for use in expressions:

• goToGroupDetails(groupId) – takes the group ID and redirects the user to the group details view, e.g. <... ng-click="goToGroupDetails(groupId)">,
• goToDeviceDetails(deviceId) – takes the device ID and redirects the user to the device details view, e.g. <... ng-click="goToDeviceDetails(deviceId)">,
• getActiveAlarmsStatusClass(alarmsStatus) – takes the alarm status object and returns a CSS class that can be used for styling: none, warning, minor, major, critical, e.g. <... ng-class="getActiveAlarmsStatusClass(alarmsStatus)">.

Example

svg
<?xml version="1.0" encoding="utf-8"?>
<svg width="600px" height="600px" viewBox="0 0 600 600" xmlns="http://www.w3.org/2000/svg">
  <!-- Annotate placeholders in comments: -->
  <!-- {{batteryValue}} -->
  <!-- {{alarmsStatus}} -->

  <style>
    .critical {
      fill: red;
    }
  </style>

  <!-- or in an attribute: -->
  <text data-placeholder="{{batteryValue}}"
    class="text"
    x="50"
    y="200"
    width="200">
    <!-- pass placeholder's value to a predefined function to get alarms status CSS class: -->
    <tspan ng-class="getActiveAlarmsStatusClass(alarmsStatus)" style="font-size: 45pt;">
      <!-- or in an element's content: -->
      {{batteryValue}}

      <!-- a placeholder can be also a part of expression, e.g.: -->
      {{batteryValue * 100}} %
    </tspan>
  </text>
</svg>

More examples can be found on page How To Show Values in a Scada Widget.

Silo

The “Silo” widget displays data points (measurements) with current values in a silo presentation.

Parameters to configure

Smart rules

To create a smart rule

Smart rules can be created in the Smart rules tab of any group or a device.

1. Click Add smart rule in the top menu bar.
   
2. Select a smart rule template from the list. Note that this list might differ based on your access rights.
3. In the resulting dialog box, use the toggle to select if the rule will be enabled or disabled, see To enable/disable a smart rule for details.
4. Next, configure the rule parameters. The parameters differ from rule to rule, for details see the individual rule descriptions in Smart rules collection.
5. Click Create to create the smart rule.

lf the new rule has been set to “Enabled” and has not been activated for specific objects only, the rule will be active for all devices and groups. See next section on how to deactivate a smart rule for specific objects.

Smart rules can be instantiated multiple times.

To deactivate or activate a smart rule for a group or device

A smart rule can be activated (switched on) and deactivated (switched off) for a single object (group device). For example, if a device is generating too many threshold alarms, you can deactivate the rule for this single object. The rule is still active for all other objects.

Navigate to the Smart rules tab of the group or device and enable/disable the respective rule using the toggle.

To edit a smart rule

Click the menu icon at the right of an entry and then click Edit.

For details on the fields see To create a smart rule.

To duplicate a smart rule

1. Click the menu icon at the right of an entry and then click Duplicate.
2. Modify at least the name.
3. Click Save & close to save the smart rule and return to the smart rule list.

To delete a smart rule

Click the menu icon at the right of an entry and then click Delete.

To debug a smart rule

For easier debugging, there is a direct link from a smart rule to the corresponding event processing module.

Click the menu icon at the right of an entry and then click Inspect to use this link.

To enable/disable a smart rule

If a smart rule is set to Enabled in the edit dialog it is “turned on” (i.e. its underlying module gets deployed) so that the rule is available for devices and groups.

If it is set to Disabled it is “turned off” (i.e. its underlying module is not deployed).

In addition to globally enabling/disabling a smart rule, a smart rule can be in active or inactive state for particular objects (groups or devices). If active, the rule will process events for these groups and devices.

Info: A smart rule created in the Smart Rules page of a particular group or device is automatically activated for the respective target asset (and its children).

To explicitly activate or deactivate a rule, navigate to the Smart rules tab of the particular group or device and set the Active/Inactive toggle to Active or Inactive respectively.

An example use case for deactivating a smart rule for a single object could be that a particular device is generating too many threshold alarms. The rule can be deactivated for this device only, but still be active for all other objects.

In case of a group, you activate/deactivate the smart rule with the toggle for the whole group. You can then separately select the children to which the rule should apply via the dropdown box below the toggle.

Important: A rule which is activated for a particular object only works if the rule is also enabled.

Example: Defining explicit thresholds

To define a threshold rule follow these steps:

1. In the navigator, select the desired group or device to apply a threshold to.
2. Switch to the Data explorer tab.
3. If the data point that should raise the threshold is not visible by default, select Add data point and add a data point.
4. Click the menu icon at the end of the row of the respective data point and select Create smart rule.
5. Select the smart rule “On measurement explicit threshold create alarm”.
6. Fill in the red range minimum and red range maximum value. When the measurement value enters or leaves the RED range, an alarm is created or respectively cleared. For details, see the description of the rule “On measurement explicit threshold create alarm” in the Smart rules collection.
7. Under Create Alarm you can optionally edit the alarm type and the alarm text.
8. Under Target assets or devices you can select the object this rule will be applied to.
9. Click Create to create the smart rule.

The rule will automatically be set to active and alarms appear if they arise.

Chain rule execution

Smart rules can create a new data item on the platform. For example, the threshold rule creates new alarms. This new data can be handled further by selected smart rules, for example, by an “On alarm send e-mail” rule.

Using this mechanism, it is possible to create a chain of smart rules.

Info: If you create a rule chain keep in mind how much data will be created and avoid overload or excessive amount of data.

Smart rules collection

Brightlayer Dashboard includes preset global smart rule types.

Each global smart rule type provides different parameters to configure.

The following section describes each available type and its configuration properties.

On alarm send e-mail

Functionality

When an alarm is created, an email is sent.

Parameters

The rule uses the following parameters:

Determine alarm type

The Smart Rule is configured according to the steps listed in the table above. Following how to find the alarmtype is explained. The easiest way to find out the alarm type of a data point is to open the Data Explorer, select the respective data point and then copy the type used.

The type of the data point in the form etn_CmsData > temperature is always the same as the alarm code in Brightlayer Dashboard.

For alarms that are created in a smart rule itself, the name can be freely defined in the respective smart rule. See the Create alarm on missing measurement data section for more information.

The threshold values, when an alarm is triggered, can also be defined in widgets such as the Info Gauge widget. The respective alarms will then relate directly to the types of datapoints.

Notice:

• Make sure that the alarm has been created and not duplicated.

• Without the alarm type, the Smart Rules will not work

• Check if the device is in maintenance mode. If so, the generation of an alarm will be suppressed.

• Look in your spam directory.

Calculate energy consumption

Functionality

Creates consumption data point based on data from an electric-, gas-, water- meter.

Parameters

The rule uses the following parameters:

The unit of the consumption measurement is always per hour (i.e. if the measurements are in “kg” the consumption will be in “kg/h”).

The rule takes the last two measurements for a specified time, calculates the difference in value and time and then calculates the consumption per hour.

Example

The rule is configured to calculate every 20 minutes. The following measurements are coming in: 100 kg at 11:59 and 200 kg at 12:14. At 12:20 the rule is triggered, taking the last two measurements. It calculates value and time difference. The consumption measurement created at 12:20 will therefore be 400 kg/h. If no new measurement was created in the last period a measurement with consumption 0 will be created.

On missing measurements create alarm

Functionality

If no new measurement data has been received for a specified time, an alarm is created.

Parameters

The rule uses the following parameters:

Info: The rule checks once a minute if the configured time interval was exceeded. Therefore it can take up to one minute to create the alarm after the time interval was exceeded. To check if the time interval was exceeded there must be at least one incoming measurement after the activation of the rule.

On measurement explicit threshold create alarm

Functionality

When the measurement value enters or leaves the red range, a CRITICAL alarm is generated or cleared.

The severity of alarm is determined as follows:

• If the measurement value moves into red range, then the severity is CRITICAL.

• If the measurement value moves into GREEN range, no alarm is created.

Parameters

The rule uses the following parameters:

Troubleshooting

• Verify that the alarm was created and not duplicated from somewhere.

• Check if the device is in maintenance mode. In this case no new alarm will be created because of suppression policy.

• Check if an alarm was already cleared by the next scheduled measurements with resulting value in a green range.

Info: If you clear an alarm, you state that the alarm is resolved. A new alarm is not raised unless the device changes its state and exceeds the thresholds again.

Smart rule variables

In certain rule parameters, variables can be used. When a rule is triggered, the variables are replaced by their actual values. You can use this mechanism to insert device names or alarm text into various outputs (email). You can include any information of the triggering event (like the alarm) and its source device.

The following table lists example variables:

Info: In case the variable does not exist or is misspelled, the generated content is displayed.

Tools

Brightlayer Dashboard offers a set of tools that provide additional services to your Dashboard Flex and Flexplus tenant. Access to these tools is protected by user rights.

Branding

With the Branding tool, you can fully customize the look of your Dashboard tenant to your own preferences. You can configure various parameters like logos, colors and font types used throughout the Dashboard service. These changes have no influence on the look & feel of the Brightlayer Portal.

The Branding tool can be accessed by entering the following URL (please replace with the name of your tenant):

https://<your-tenant-name>.dbt.machinery-monitoring.com/apps/blim-branding/index.html#

The parameters are configured at the left side of the tab while at the right you can immediately see your selections applied to a preview extract.

For a more detailed preview of your settings, click Open preview in the top menu bar to check the look and feel of your branding settings on your Dashboard tenant. You may interact and even switch applications in the preview. Every change that you make in the Branding tab will immediately be applied to the Preview page.

When you are done or want to store your settings, click Save at the bottom of the Configuration section to save your branding settings to your tenant.

Saving the settings will not yet apply them to the current tenant. To do so, click Apply in the top menu bar.

Click Reset in the top menu bar to reset the branding of the current tenant and to the default settings. The custom settings will still be saved but are no longer applied.

Configuration parameters

In the Configuration section, the following branding parameters can be configured.

General

Under General, you can edit the title which will be used in the browser tab.

Main logo

Under Main logo, specify the following items:

• The favicon - will be displayed in the browser’s address bar. Click Choose file to select a file from your file system. The supported favicon format is “.ico”.
• Your branding logo - will be shown during application loading. Click Choose file to select a file from your file system. The supported formats are “.png” and “.svg”.
• The brand logo height.

Navigator logo

Under Navigator logo you can provide the navigator logo and set the navigator logo height located on top of the navigator panel.

Font

In the Font section you specify the font settings for your branded version.

You can select your base and headings font stack, and select an option for the navigator font stack (either same as base or same as headings font). You may also add a link to existing remote fonts to be used.

Colors

In the Colors section you specify the colors to be used in your branding version.

The following parameters can be specified by providing a hex, rgb or rgba value:

• Main brand color.
• Secondary brand color - the default value is “#07b91A”.
• Dark brand color - mainly used for two-color icons. The default value is “#0B385B”.
• Light brand color - mainly used for two-color icons. The default value is “#5FAEEC”.
• Text color - the default value is “#444”.
• Link color - the default value is the same as the main brand color.
• Main background color - the default value for this item is “#FAFAFA”.

Top bar

In the Top bar section you specify the parameters for the top bar.

The following parameters can be specified by providing a hex, rgb or rgba value:

• Background color - the default value is “#FFFFF”.
• Text color - the default value is “49595B”.
• Button hover text color - the default value is the main brand color.

Navigator

In the Navigator section you specify the parameters for the navigator.

The following parameters can be specified by providing a hex, rgb or rgba value:

• Background color - the default value is “2c3637”.
• Logo wrapper background color - the default value is “Transparent”.
• Title color - the default value is “FFFFF”.
• Text and buttons color - the default value is “#FAFAFA”.
• Separator line color - the default value is “#FAFAFA”.
• Text color of the current item in the navigator - the default value is “#FAFAFA”.
• Background color of the current item in the navigator with the main brand color as default.

Misc

In the Misc section you specify the “Button Border-Radius” by providing a value in pixel (px).

Cookie banner

In the Cookie banner section you specify the settings for the banner with the cookie usage information. If not disabled here, the banner is shown for all users of the current tenant and all subtenants until a user clicks Agree and proceed.

Disabling the cookie banner, also disables the product experience tracking by Gainsight for the current tenant and all subtenants.

The following parameters can be specified:

• Title - cookie banner title
• Text - cookie banner text with a general statement on the cookie usage and the use cases for it
• Link to privacy policy - a link to the page with the privacy policy

Streaming Analytics

The Streaming Analytics tool can be accessed by entering the following URL (the tool is currently only available to Eaton administrators):

https://<your-tenant-name>.dbt.machinery-monitoring.com/apps/streaminganalytics/index.html#