User Enrollment and Activation

Click on Sign Up.

Accept EULA and click next.

Verify your email address and click Next.

Enter the verification code has been sent to the provided email address and click on Next.

Enter your details and click next.

Eaton recommends to enable Two-factor Authentication option to prevent unauthorized access to the account.

The new user account has now been created. Press the log-in button, and an email notification will be sent to activate the account.

Click on Activate Account in your email.

Click on Set up to create a password.

Create a password that meets the requirements to log into the application. When finished, click Next.

Authentication setup is optional. Click Set up to configure your preferred authentication method, or click Continue to skip this step.

Once the registration process is finished the user would have access to a Realm or an Organization service. The user may have admin or standard user rights in the service depending on the role assignment. The permissions of the user within the service depend on the individual settings of the roles.

Realms

Realms form the highest hierarchical level in Brightlayer Machinery Remote Monitoring. A Realm can be customized, and it allows the owner to manage several Organizations.

Remark: To get access to a Realm a Realm license is necessary. For all users that do not hold a realm license but hold an organization license please move to the next chapter: Managing Organizations.

The following graphic shows the Realm Summary screen. The screen consists of 4 sections:

When selecting the home screen of a Realm usually the “Summary” tab is selected.

Realm Summary Screen

The Realm summary screen is giving an overview about the setup of the Realm. It also provides access to additional sub-sections that allow a further customization of the Realm. In particular the summary screen allows to:

• Upload customer logos
• Set customized URL
• View subscriptions available for this Realm
• Allows to suspend the Realm (depending on user rights)

Realm Customization Screen

This screen lets you set the application name and choose a branding color. You can also configure basic settings like language, date format, temperature unit and time zone. These settings will apply to all new users in this realm. However, each user can later change their preferences in their own profile settings.

The following image shows the Realm Customization screen. Scrolling the screen further down will also allow to set contact persons of the realm operator.

Realm Users Screen

This screen allows the realm administrator to add new users and assign roles to them. By selecting the user in the main screen, an admin can also delete or suspend the user by selecting the respective option in the context menu. Having created a new user, he needs to be assigned to an organizational level of the realm. This could be:

• The realm itself
• An organization within the realm
• A group within an organization that is part of the realm

By default the screen is showing all users on the Realm, listed with their assignment to organizations and groups and showing their roles. Clicking on the context menu will allow you to add new users or manage existing ones. To manage existing users they have to be selected before entering the menu by clicking the box in the first column of the user table. Existing users can be removed, disabled (or enabled if they had been disabled earlier).

When organizations are assigned to the realm, the user also needs to be assigned a role within those organizations. A detailed overview about roles and their permissions can be found in the chapter User Management.

Screen to invite a new user and assigning a role.

Realms and Orgs Screen

This screen allows users to manage the realms and organizations that are part of their realm. New realms can be added clicking on the “+” symbol in the “Realm” section of the window. The context menu allows to move the realms.

Organizations can be added clicking on the “+” symbol in the “Organizations” section of the window. The context menu allows to:

• view subscriptions

• move the organization

• delete the organization

Clicking on the “>” symbol would open the organization screen in another window of the browser.

Realm Dashboards

The Dashboards tab shows all dashboards that have been used.

The context menu allows to delete a dashboard or show the details of the dashboard in the dashboard details window:

In addition dashboards can be cloned to other realms or organizations. To do so, the target realm or organization has to be chosen from the Dashboard Library Menu on the top right of the window.

When the target realm or organization has been chosen, the dashboard can be cloned by clicking on the “»” symbol. The “Share Dashboard” window would open. Clicking on the “share” button would add the dashboard to the target realm or organization.

Remark: Only dashboards that are assigned to a fix data source can be shared. If no data source is selected for the dashboard the action might fail.

Realm Widgets

The Widgets tab provides an overview about the widgets that are used in the Organizations that are attached to the realm. Informations included are e.g.:

• assignment, type

• number of deployments

Realm Audit Logs

The audit log tab records all activities within the realm. It would give the administrator an overview about activities on the realm. Those activities could be system activities or user activities.

Users can show more information by clicking the buttons on the right side of each entry. The “Request” button shows the code that initiated the action, while the “Response” button displays the code that resulted from the action.

Organizations

Organizations are the core element of the Brightlayer Machinery Remote Monitoring platform. They contain all features to display and manage data as well as analytical funtions of the platform. Thanks to their hierarchical structure they also allow to organize different customer- or application groups into separate hierarchical layers.

The Organizational Summary Screen

The Organizational Summary Screen displays information for all organizational groups and devices, providing easy-to-navigate paths to display information.

1 - Organizational Hierarchy Menu

This menu allows to manage the hierarchy within the organization. Gateways and child devices can be managed in groups. Those groups can additionally be organized in hierarchies.

The organization management window

2 - Tabs Menu

The Tabs Menu provides access to the data for the Organization, Group, or Device, as selected in the Organizational Hierarchy Menu. Its content changes, depending on the selection in the Organizational Hierarchy Menu. When opening an Organization “All Groups” would be selected and the Tabs Menu would have the following content:

• Summary Tab - displays information about the Organization. By default the dashboard contains the timeline widget, the Group List widget and the Device List widget. The dashboard can be modified based on the user’s preference.
• Devices Tab - when selected, the Device Management Screen displays all devices set up within the Organization. In case controls have been configured and added to those devices, they would be displayed as well. Controls may only be available for specific device types (e.g. UPS).
• Timeline Tab - provides an overall summary of events for the Organization. Events would be alarms or a change of the connection status of devices within the Organization (online / offline). The timeline can be exported into a .csv file.

3 - Help Menu

Clicking the question mark icon in the upper right corner of the screen would open the Help Menu. It contains information on how to contact Eaton for help and the privacy policy.

4 - Settings Menu

This menu provides access to all organization settings and configuration. It could be accessed by clicking on the gear wheel in the top right corner of the screen.

• Organizational Management Settings - displays the Organization settings like Name, Code, Activation Code, 2FA and Contact Details. It allows to view the subscriptions, switch to another Organization or to create a new one. Deleting the current Organization may require User rights. If tags have been added to the devices in the Organization, those Device Tags can be viewed in a second tab.

  

• Group Management - add, edit, move, or delete Groups within an Organization.

• Notification Settings - Clicking this element will open the notification settings window. This window allows the user to set and configure notifications for 2 different alarm and event types:

  • The “Preferences” tab: In this tab the user can set his preferences for alarms, warnings and events created in Brightlayer. Those settings are User specific. Every user of the Organization has to set and modify these settings for himself.

  • The “Custom Notifications” tab: In this section notifications can be set and configured for alarms and warnings that are send from the application via MQTT. Those notifications can also be addressed to other users.

    For more information see section Alerts and Notifications

• User Management Settings - allows administrators to invite other users to the Organization, either as users or as an administrator. It also provides control over deleting, disabling, or enabling user accounts. For more information see section User Management.

• Dashboards & Widgets Settings - allows administrators to see, edit, clone, delete or associate dashboards to device or groups. In addition, all widgets that are used in those dashboards can be edited, renamed, cloned, or deleted.

  Important: Dashboards can only accociated to Devices. It is not possible to associate dashbaords to groups. Dashboards of the Type “Source” are added to a device automatically, when it is created. These dashbaords can also not be associated to another device.

  Only additional dashboards can be associated to devices. It is necessary that the device already has a dashboard assigned to it before a second dashboard can be associated with the device.

  In the “Associate Devices” screen, the devices that have the same data type as the dashboard, can be selected. When applying the selection, the dashboard will be added to those devices.

  

  After associating the dashboard to the device it can be selected with the “Select Dashboard” option in the 3-dot-menu of the device Summary Screen.

5 - User Menu

The User Menu can be accessed by clicking on the User avatar in the upper right-hand corner of the Main Organization Screen providing an option to view or edit profile settings or to log out of the application.

The first section of the user profile page includes general profile information, such as email, phone number, country, an option to enable multi-factor authentication, and a location to upload an image.

The second section is the role that the User holds within the Organization.

The third section displays customizable language, time zone, and date format options.

6 - Timeline Widget

The timeline widget provides an overview about all alarms and events within the selected organization. The top section of the widget shows the severity rollups. This is a summary overview about all Alarms, Warnings, Offline devices and Info Events. This section is followed by the list of alarms and events. By clicking on an alarm or event the event details screen will be opened to provide more information about the alarm / event. To see the full list of alarms / events click on “View all events” on the bottom of the widget or open the Timeline tab.

Timeline Widget configuration

Each widget can be customized to better meet the expected appearance and content depending on the use of the dashboard it is part of. Two sections exist to configure a widget:

• In the “Configuration” tab the data source for the widget is defined. By default the Configuration setting would be “Not linked to any group or device”. This setting should be the best solution for the majority of cases, as the widget would capture the data from the Organization-, Group- or Device-Dashboard it is located in.

• In the Display Preferences the events to be displayed can be chosen. It could also be decided if the severity rollups (summary of all events in the first row of the widget) would be displayed or not. Further on the maximum number of events to be displayed can be decided.

  More information about Widget configuration can be found in the chapter Widgets.

7 - Group List Widget

The Groups List Widget provides a view of Groups or Child Groups within an Organizational hierarchy and allows users to view all Groups within an Organization. In the settings of the widget the maximum number of groups in this organization can be defined in the widget configuration.

Clicking on “View all groups” opens another window that is showing only the groups on the highest hierarchy level

Clicking on the “>” icon on the right side of the group name would show all sub-groups in the hierarchy including their status, number of devices, etc.

Group Widget configuration

In the Display Preferences the number of groups to be displayed can be chosen. The option “View all groups” can be switched on or off.

8 - Device List Widget

The Device List Widget provides a fast overview over the status of all devices that are part of an organization or group. It shows if a device is online or offline and displays if alarms are pending and how many alarms are active with a device. To see all the details of a device, click on the “>” icon (2) on the device and the Device Management Screen will open. The Device List Widget may only show a selection of up to 25 of the existing devices within a group or organization. To see all devices in this group / organization, click on the Devices tab or the “View all devices” button (1).

The configuration of the Device List Widget follows the same rules as the configuration of the Group Widget.

The Device Management Screen

Each device provides a device management screen that consist of 3 main areas: The device screen banner, the tabs and the summary screen dashboard area. The dashboard area of a device can be customized by selecting the edit dashboard option in the context (3 dots) menu.

Device Screen tabs: The following tabs are available to manage the device:

1. Device Screen Banner - changes colors, indicating the different status levels of the connected device.

   • Light blue - Offline Mode
   • Blue - Online Normal Mode
   • Orange - Online Warning
   • Red - Online Alarm

2. Timeline - see Timeline widget description

3. Details (or Details widget) - shows information about the actual values provided by the data channels from the device. The widget also allows to set Threshold Alarms for all channels of the data type “Trend”.

Setting theresholds for a channel in the device details:

Clicking on the bell / pen icon for a specific channel, would open the threshold and alarm screen for this channel. Values can be determined for 4 different alarm types: low critical, low warning, high warning, High critical. Every threshold has to be activated with the toggle switch on the right side of the screen. To create notifications for thoses alarms, please refer to the chapter Alerts and Notifications.

3. Properties (or Properties widget) - this screen (widget) shows all properties of a device. By clicking on the pen icon for a property, the following actions can be taken:
   1. The device can be assigned to another group
   2. Tags can be added to the device
   3. The device name can be changed
   4. The location can be set by either choosing an address or setting the location with the longitude / latitude data.
   5. A description can be added to the device
   6. The device installation data can be modified

4. Gateway devices – In this tab a gateway device can be assigned to the device.
5. Settings (or Settings widget) – this screen (widget) shows all settings of a device. Settings can not be changed and may not be available for all device types.
6. Trends - This tab shows the trend widget with the pre-populated channels of the device. The displayed data can be modified the same way as in the trend widget.

Group Management

Groups not only allow to cascade devices into logical sub-groups to reflect real assets and structures (e.g. machine group, factory, region, country, etc.). As each Group has its own user management the access to certain elements of data within an organization can also be managed by using Groups.

Group hierarchy can be structured up to 8 tiers, allowing for flexible and detailed organization of machines and devices.

Creating a Group Within an Organization

1. Click on the Add a Group option on any one of the four areas on the summary screen:

   • “Add group” would open the dialog to add a group immediately

   • “View all groups” or selecting “Groups” in the settings menu would open the Groups Management window.

     

2. Enter in a name and then select the parent organization where the new Group will reside. Click Next.

   

3. Move any existing Groups to the newly created Group (if applicable).

   

4. Assign users to the newly created Group.

   

5. Choose between the default image or upload a new photo to help identify the Group. Click Add Group when finished.

   

6. The newly created Group has now been created under in the Organization and can be viewed on the application Organizational Hierarchy Screen.

   

Group User Management

To give users access to just one Group of the organization, the user needs to be added using the user managment screen of the Organization. After opening the Organization User Management screen select “Add User”. The credentials of the user have to be added. The user role can not be “Organization Admin”! If the user is assigned the “Organization Admin” role he would automatically have access to all Groups. After selecting the “Manager” or “Viewer” role, the user can be assigned to a Group that exists in the organization. After selecting the Group, the new user can be invited.

For more information about users and roles see chapter User Management.

User Management

User Management allows administrators to add, invite, or remove users from an organization, and assign roles to those users. Custom roles can also be created within the User Management screen. Use Invite User to grant access to a new organization or realm. Use Update User Role to modify permissions for groups within an organization the user already has access to.

Accessing the User Management Screen

To access the User Management Screen, click on the Settings Menu then Users (Configure Users and Roles).

Clicking on “Users” would open the User Management Screen. This screen lists all users that have access to this Organization. Clicking on the context menu (3 dots) shows the options for this screen. If no users are selected (by ticking the box in front of their name) only “Add Users” is available. After selecting at least one user from the list, more options would be activated (Disable, Enable, Delete, Resend invitation). Users can also be edited by opening the User Profile window.

Editing Roles

Clicking on the tab “Roles” would open the Role Management screen. The screen contains the 3 system roles (Organization Admin, Manager, Viewer). Those roles can not be edited or modified.

To add a new role, click on “+ Add Role” in the upper right corner of the screen. The edit role window would open.

At first a Role Name has to be provided. Role names have to be unique within an Organization. A description can be provided. Afterwards the privileges of the Role have to be determined. Each privilege in the left drawer would offer settings and rights to the user. Example: Automations and Notifications. It can be determined if automations can be viewed, created, edited or deleted. The same for Notifications.

Once all privileges have been set, the role can be saved. Afterwards the role is available to be assigned to new or existing users.

Managing Users

The User Management main screen provides access to all functions that are necessary to manage users. To edit a User, click on the “>” icon on the right hand side of the user entry in the User Management screen. Doing so would open the User Profile window.

The windos shows the users name, status (active or disabled), phone number, country and the assigned role. To modify the role assignment click on the context menu button (3-dots) to open the Edit User Details window. This window allows to modify the users name and e-mail address as well as the role assignment and the assignment to Groups within the Organization (see Group User Management)

Adding Users follows the same principle. Open the context menu (3-dots) in the top right corner of the User Management screen and click on “Add User” . The Add User window will open. After adding the new users name and e-mail address the user has to be assigned a role within the Realm, Organization or Group. Afterwards the new user would be invited by e-mail.

Remark: The link in the e-mail is only valid for 24 hours after sending the e-mail. After that period the link will return an error message and the invitation has to be re-send.

Device Management

To send data from a real application (e.g. machine) to Brightlayer the following steps have to be followed to do so:

• Adding a Device Ontology to Brightlayer

• Adding a Gateway Device to an Organization

• Creating Child-Devices to the Gateway Devices

• Managing Device Data

• The Device Management Screen

Adding a Device Ontology

Before adding a new device the data that is supposed to be provided by the device to Brightlayer needs to be defined. To do so, an Ontology profile needs to be created in Brightlayer. This Ontology profile contains a number of data Channels. Each Channel represents a data tag that is send from the application to Brightlayer. The following information has to be provided for each Channel:

• Name: is the name of the Channel within the system. In all further process steps the channel will be identified by this name

• Description: is an additional tag that can be used to further describe the channels usage within the project.

• DisplayName: is how the channel would be displayed in widgets and on dashbaords.

• DataType: is the data type of the channel like Boolean, Float, Integer, Date, String, etc.

  Remark: Some channels are used for special functionalities like commands or alarms. Those channels have to follow special rules with regards to the data type. Once defined, the data types of a channel can not be modified later on if the Ontology profile has been deployed to Brightlayer. Therefore it is important, that the data type of the channel is following the intended functionality described in this chapter of the documentation.

• Unit: defines the unit that would be applied to the incoming data. This would be “A” for ampere or “mA” for milliampere.

• Category: offers two options:

  • “Input” for data send from the application to the machine manager. Typically used for “Trend” data (see next bullit)
  • “Output” for data send from the machine manager to the application. Typically used for “Control” Channels (see next bullit)

• Type: defines how the data would be handled in Brightlayer. Three types are available while one channel could also have more than one type. It is not possible, though, to combine the types Control and Trend:

  • Alarm: those channels are used to send alarms from the application to Brightlayer.

    Remark: An alarm channel needs to have an integer data type (e.g. int8, int16). For more details about setting up alarm channels see paragraph Alarm Channels.

  • Control: a channel that would allow to send data from Brightlayer to the application.

    Remark: A control channel needs to have a numeric data type (e.g. integer, float, etc). It could not be boolean. For more details about setting up control channels see paragraph Control Channels.

  • Trend: a channel that can be displayed in a trend chart. All data that should be stored continously in the system and that is targeted to be used for data analysis should be send as trend data type.

    Remark: Trend data should be send to Brightlayer within a Trend message type. Trend data should not be send as a Realtime message. Sending Trend data as Realtime messages may lead to a wrong display within widgets.

• Min/Max: defines the minimum and maximum values that can be expected in this channel. These values help to choose the right scaling for widgets like Gauge and Trend widgets.

• Default: This parameter is mainly important for Control Channels. When a Control Channel is triggered, the value in the “Default” parameter would be send to the application. The value needs to be within the limits of the data type. E.g. if the data type is “int8” the default value can’t be “4000”.

Alarm Channels

Alarm channels are intended to send alarms from the application to Brightlayer. Such channels can either create “Warnings” or “Critical” alarms. With the Notification feature of Brightlayer custom notifications can be created for all alarms / warnings within an alarm channel. One alarm channel can integrate several alarms and warnings. Each alarm / warning is indicated by a number (integer value) that is send from the application.

Example:

Attention: Before switching from one alarm to the next alarm, the channel has to be reset!

In the example mentioned above: Sending a “1” would trigger a warning and display the text “Pump temperature high”. Sending a “2” would not trigger an Alarm! The application would have to send a “0” to reset the warning. Afterwards the “2” can be send and would trigger the alarm with the text “Pump temperature critical”.

Control Channels

Control Channels are used to send commands from Brightlayer to the application.

Important: Cloud commands need to be used with high precaution. The designer of the overall application remains responsible for the safety and security of the application. Cloud commands must not lead to any unsecure situations with the application that would bear the risk of injury or death to any of the workforce within the operational environment of the machine.

The trigger to send data to the application can be done via the User Interface using the Command Widget. Channels, that could be configured in this widget, must have the type “Control” otherwise they are not shown and can not be selected in the Command Widget.

For every Control Channel a button can be configured in the Command Widget. Once in operation, on clicking the button in the Command Widget, the value that is defined in the “Default” parameter for this channel in the Ontology Profile would be send to the application with an MQTT message.

See spreadsheet above with an example for an Ontology profile: The “xAuto” Channel (display name is “Auto_SW”) has been added to a Command Bar widget. When a user (who has the user rights for those operations) clicks on this button, the value “1” would be send to the application (as “1” is set as the Default parameter in the channel).

Creating the new Ontology profile

Once the channel data has been provided to the Eaton Brightlayer Service team the Ontology profile will be created. Once the profile has been created there are two (2) informations that will be returned to the User:

• The Ontology profile ID is the unique identifyer for the Ontology profile in the Brightlayer systems. It is used to create Child-Devices. After creating the child-devices with that ontology profile, dashboards can be created to display all the channel data that is send to the child-device.

• A “TagID” is provided for every channel as a unique identifier for the channel in the Brightlayer system. This TagID can be used in several ways, e.g. for API calls, to send commands or retreive information from dedicated channels of a device.

Adding a Gateway Device to an Organization

Brightlayer allows to connect any kind of gateway device. The gateway device needs to be able to connect to an Azure IoT Hub using the “Connection String” method. In this chapter we are describing the process of connecting a generic gateway or any other device that can send data via MQTT (e.g. a PLC) to Brightlayer. In case you are using an Eaton Gateway that supports self-registration features, please refer to the manual of the gateway on how to connect it with the Brightlayer platform.

On the Organizational Summary screen there are multiple ways to open the “Add device” window. The context menu offers an options to add a device. Alternatively you can choose the (+) icon on the top right of the Device Overview list.

The following steps would add a new gateway device to the Organization:

1. In the “Add device” screen chose “Gateway” in the “Device type” field.
2. Open the “Device Model” dropdown. You should find the “TP Generic Gateway”. If the Gateway is not in the list, please contact the Eaton support team for help. They would add the gateway to your Organization / Realm.
3. You could add the gateway to the Organization Root (default setting) or choose one of the existing Groups to add the gateway to it.
4. A proposal for a Device Name will be made. You can keep that proposal or change the device name.
5. A GUID / UUID has to be assigned to the gateway. This will be the unique identifyer for the gateway in the Brightlayer system. GUID / UUID number can be generated free of charge from here: www.guidgenerator.com
6. Tags can be provided for the gateway. Those tags may help to identify / find the gateway. Examples could be “Germany”, “Munich”, “Leopoldstrasse”. It is not compulsory to add tags.
7. A description can be added as well.
8. Click on “Save device”.

After saving the device to the Organization the “Submission Successful!” screen is shown. Do not click on “Ok” before the Connection String that is contained in the screen has been copied! This can be done by simply clicking on the “Copy to Clipboard” button.

The Connection String needs to be copied to your gateway device. Please follow the instructions of your gateway device on how to connect to an Azure IoT Hub and where to place the Connection String.

To establish a secure connection it may be necessary to add a certificate.

Creating Child-Devices to the Gateway Devices

The “TP Generic Gateway” would just provide some status data to Brightlayer (online, offline, alarms). To send data, based on the Ontology profile, it is necessary to set up Child-Devices to the Gateway device. Those child-devices need to be created with a - so called - Device Tree Message.

The Device Tree Message should be send from the newly created gateway. The message itsself needs to contain the DeviceID of the gateway and it needs to specify the data for the child-device(s).

For each child-device a new GUID / UUID needs to be created and needs to be send with the device tree message. The other information that needs to be provided for each child-device is the ontology profile ID. With this assignment the dashboards can be created for those child-devices that display the data defined in the ontology profile.

// D2C: DeviceTree
// The "a" property shall be set to "DeviceTree"
// The "del" property shall be set to false if the adopter wants us to keep the missing devices. This is optional. If not given, it is treated as true and all missing child devices will be deleted.
// The "to" property shall be set to a value within which the message gets from the IotHub to the Ingestion Service, it will be processed. A minimum value will also be set for the same. This is optional, If not given, no value is set for to property.
  "d":{
    "d":"83157f2f-ce13-4c10-abf5-2a67241f317b",         // required, represents the device instance UUID. You should persist this UUID on the device. It should never change.
    "profile":"72358726-1ed0-485b-8beb-6a27a27b58e8",   // required, represents the device profile UUID. You must register this device profile in advance.
    "name":"MyDeviceName",                                // required, represents the display name of this device.
    "serial":"MySerial",                                // optional, free text
    "asset":"MyAsset",                                    // optional, free text
    "mac":"00:0a:95:9d:61:19",                            // optional, free text
    "ds":[                                                // Optional, represents the child devices.
      {
        "d":"24c9c06a-acff-41c2-997f-aa3e5c7e41f0",
        "profile":"7a71983e-f9e5-4104-bc2c-7c576802084c",
        "name":"MySubDeviceName"
      }
    ]
  }
}

Managing Device Data

Once devices have been created, either gateway devices or child-devices, they would appear in the Organizational Hierarchy Menu of the Organization. Clicking on the device symbol in that menu would open the Device Management Screen:

More information about working with device data can be found in the section: The Device Management Screen.

Dashboards

Dashboards are the core of Brightlayer Remote Monitoring. When adding widgets to those dashboards the data, that is send to Brightlayer, can be displayed in various ways. For new devices there are several options to automatically add dashboards to them or associate dashboards to several devices.

Creating new Dashboards for Devices

When creating a device, the Device summary screen would not contain any dashbaord. To create a dashboard, select the device in the left drawer (1) and click on “Add Dashboard” (2).

On the next window a name and descirption for the dashboard will be requested. Usually “System Dashboard” should be chosen for dashboards that are planned to be used in life applications.

Attention: There is a toggle switch on the bottom of the screen allowing to set this dashboard as the default system dashboard for the mentioned device type. It is recommended to switch this option to “on” if you wish to use this dashboard for several devices of the same type. After creating the dashboard it will automatically be assigned to all devices of the device type mentioned in the text. Even when creating new devices of this type, the dashboard will be assigned.

The following step of editing and saving the dashboard is described in the chapter Editing Dashboards.

After saving the dashboard it would be visible on the Summary Screen of the device. Following this first dashboard assignment there are several more options that can be done with dashboards. Any additional settings with dashboards could be done in the Organization Settings in the “Dashboards & Widgets” setting.

Editing Dashboards

When creating an Organization or a group, the home screens of those entities already contains a default dashboard. The following workflow also applies to Device Summary Screens that already have a dashboard assigned to it.

The context menu (3-dot) offers 3 options:

• Edit Details: This would offer the Dashboard Details Screen. This screen shows the dashboard name, data source and assignment. It also shows if the dashboard is the Source Dashboard for the device type mentioned in the Data Source Field. On the right hand side of the screen, the widgets that are included in the dashboard are listed.

• Select Dashboard: Several Dashboards can be assigned to a device. If there is more than one dashboard assigned to the device, the dashboard, to be displayed on the Summary Screen.

• Edit Dashboard: Choose this option to change the dashboard and its content.

Once the Edit Dashboard screen has opened, the default dashboard can be copied and saved with another name using the “Save As” button in the top right corner of the screen. This is the first step to create a new dashboard and keep the existing one.

As a next step either the existing dashboard or the new dashboard can be edited. To edit the new dashboard the “Select Dashboard” option has to be chosen in the context (3-dots) menu. Afterwards the editing mode would be started by choosing “Edit Dashboard” in the same menu.

The following options are possible:

Modifying existing widgets

• Moving the “mouse over” the icon in the top left corner of each widget would turn the mouse pointer into a hand. By clicking and holding you could drag and drop the widget to another position on the dashboard. Depending on the available space, other widgets would also change their position in that case.
• Clicking and holding the bottom right icon on the widget would change the size of the widget. This may also have influence on other widgets on the dashboard.
• “Edit” in the context menu would open the widget configuration page
• “Rename” in the context menu would allow to rename the widget
• “Remove” in the context menu would delete the widget from the dashboard.

Adding new widgets

Clicking the “Add Widget” button would open the “Add Widget” screen and show the selection of widgets that can be added to the dashboard.
After selecting on of the widgets from the list there may be widgets of the same type that have been used for other dashboards within the same organization. Those widget templates are listed below the “Existing Widget” headline. Alternatively a new widget can be created

In the following screen the data source, gateway type and device type need to be assigned to the new widget. Choose “machine” and the ontology profile you would like to connect.

In case of a new widget you need to provide a name and you can provide a description. It also has to be decided if this widget would be a system widget and available to other users in the organization or just to the current user.

Attention: It is not possible to mix System Dashboards with User Widgets! When creating a User Widget it can only be used on User Dashboards, not on System Dashboards. This action would cause an error message and would not be executed.

Once the new name is saved, the widget configuration window opens. This window has 2 sections:
The configuration section on the left side has 2 tabs, “Configurations” and “Display preferences”. The preview service on the right side of the screen shows a preview of the widget. The preview is generated with the currently selected configuration and data source.

Configuring the widget

In the first line of the “Configuration” tab, the data source has to be selected. By default the widget shows the data of the device or group the dashbord is assigned to. Therefore the toggle switch on the right side of the text “Link to a specific device or devices” is switched off. This is the recommended setup for all widgets. Only when you want to show e.g. data from a device on a dashboard belonging to another device or from a device that is not located in the same group, the respective device(s) data could be mapped to this widget. An example would be an overview map, that should show all devices within an organization, while the devices are sorted into separate groups. In this case all required devices in the organization could be mapped to the widget.

The toggle switch to link a widget to specific groups or devices may be difficult to find on some screens.

Important: In case several applications (machines, child-devices) should use the same dashboard, it is possible to “clone” an existing dashbaord and assign it to other devices or groups. In this case it is important that the widgets of those dashboards are not linked to a specific device. Otherwise the widgets may not show the expected data after cloning and re-assigning.

Configuration tab:

• The Data Source field would allow to change the data source e.g. in case that several ontology profiles are avaialble. By clicking on the pencil symbol the data source screen is opened.
• Based on the selected data source all available channels will be displayed. By ticking the box, the channels will be added to the widget.
• The Selected Channels field would allow to drag the channels into the desired order.

Display preferences tab

• The “Display preferences” differ from widget to widget. A description of all preferences per widget can be found in the widget list.

Preview

• The organization or group where the dashboard is located may contain several devices of the same kind. The preview device shows, the data of which device is selected for the preview. If another device’s data should be previewed, other available devices could be selected by clicking on the pencil symbol.

After clicking the button the available options are displayed and can be selected

Widgets

Hello hello

This chapter gives an overview about the available widgets and the way they are configured.

The following widgets have been explained in other sections of the documentation. Clicking on the link will open the description of the widget. Editing the widget and adding it to a dashboard would follow the standard procedures as described in the chapter editing dashboards.

• Group list widget
• Device list widget
• Timeline widget
• Details widget
• Properties widget

The following widgets are described in this chapter

• Command Bar widget
• Trends widget
• Charts widget
• Map widget
• Gauge widget

Command Bar widget

The Command Bar widget is targeted to provide a possibility to users (that have the right permissions) to send commands to the application.

Important: The channels, allowing to send commands, have to be pre-defined in the ontology profile. When the channels are marked as “Control” in the ontology profile they will show up and can be selected in the widget configuration process.

Important: Cloud commands need to be used with high precaution. The designer of the overall application remains responsible for the safety and security of the application (machine). Cloud commands must not lead to any unsecure situations with the application (machine) that would bear the risk of injury or death to any of the workforce within the operational environment of the machine.

Command Widget configuration

• Data source: Choose the ontology file that is the source for showing the channel to be displayed in the controls widget. Only channels of type “Control” could be displayed in the Command Bar widget.
• Select Controls: All controls, found in the data source, are displayed. The controls, required for this widget, can be selected.
• Select Controls Section: Define the order of the controls by dragging them onto the right position. Select a color for the button.

Trends widget

The trends widget shows the historical data that has been sent from the application to Brightlayer. All channels in the ontology profile with the type “Trend” could be displayed in this widget. The displayed data can be modified in the following way (without accessing the widget configuration):

• Setting time series: In the upper right corner of the widget the time series of displayed data can be chosen. Possible options are 24h/15 days/31 days. The default setting of this parameter can be selected in the widget configuration. To see historical data beyond the 31 days chose “View full trendviewer” on the bottom of the widget.
• Units: If data is available in different units, those units can be changed and selected with this dropdown.
• Channels: The channels that have been selected in the widget configuration are displayed by default. Clicking on the tick box under the chart, channels can be de-selected or re-selected.

Trend widget configuration

• Data source: Choose the ontology file that is the source for showing the channel to be displayed in the widget. Only channels of type “Trend” could be displayed in the trend widget.
• Select Channels: All trend channels, found in the data source, are displayed. The channels that should be displayed in the widget, can be selected.
• Select Channels Section: Define the order of the channels by dragging them onto the right position.

Display preferences for the trend widget

• Choose the default period to be displayed (24h/15days/31days)
• Choose the chart type (area / line)
• Choose the maximum number of channels to be displayed.

Difference between “Area” and “Line” Chart

When the chart type is set to “Area” the data will be displayed in the way it is coming in. That means, when no data is provided the curve goes down to “0”. The “Line” setting would not reset the value to “0” this setting will draw a line between the last value that has been send and the latest value that has been sent.

When changing to the Full Trend Viewer it has to be considered that this tool will normally display the data in “Line” format.

Full Trend Viewer displaying data in “Line” format.

Charts widget

The chart widget allows to show the actual value of up to 10 channels in one widget. In the widget itself the units to be displayed can be chosen. Clicking on “View full chart” opens the full chart window which would allow to export the current chart view.

Configuring the chart widget
The configuration would be similar to the configuration of Trends Widget.

Display preferences for the the chart widget
On top of selecting the maximum number of channels to be displayed, the chart type can be chosen: Bar chart for horizontal orientation, column chart for vertical orientation.

Map widget

When the location of a device has been set in the device properties the device location can be shown on the map widget. The widget would also allow to select different backgrounds, zoom-in, zoom-out, showing the own location and full screen mode. When clicking the device icon the device management screen of the chosen device would open. The device configuration would allow to show the icon in different colors, when alarms or warnings are pending with this device.

Configuring the map widget
When added to a dashboard the map widget would – by default – display the immediate child groups of the group dashboard on which the widget is placed. If the widget is not displaying the desired data, it is recommended to link it to specific groups or devices.

The toggle switch to link a widget to specific groups or devices.

After clicking the button the available options are displayed and can be selected.

Display preferences for the map widget
On top of the pinning and “view full map” options the alarm types to be displayed by changing the pin color can be chosen. Choose all alarm types that should be displayed by toggling the respective switch.

Selecting alarms to be displayed in the map widget.

Gauge Widget

The gauge widget is a powerful tool to show values of a channel in a visually appealing way. It also allows to show the current value in relation to the min. / max. values of the channel. For a meaningful visualization with the gauge widget it is recommended to assign min. / max. values to the channel in the ontology profile. Only one channel can be displayed in a gauge at a time. To display several channels in one widget you may choose the trend widget or the charts widget.
You may choose different gauge types in the display preferences. If threshold values have been created for the channel they could be displayed in the gauge. For some gauge types a scale could be added.

Display preferences for the gauge widget
Choose one of the four gauge types (solid, KPI, speedometer, horizontal). Thresholds and scale will be displayed best on speedometer and horizontal gauge.

Display preferences for the gauge widget

Alarms and Notifications

Different types of Alarms

Brightlayer supports two (2) different types of alarms:

• Brightlayer / Cloud generated alarms. Those alarms are generated when a channel value raises or drops beyond a threshold that was set in the Details widget of a device. Example: If you plan to monitor the temprature of an oven and the oven always needs to operate in a temperature range between 200°C and 220°C. In this case a warning could be generated at 220°C indicating that the oven is on the edge of the desired temperature range. In addition an alarm can be set at 225°C to alert that the oven is operating outside of the desired temperature range.

• Application (machine) generated alarms Those alarms are generated when Brightlayer receives a value on a Channel that has the type “Alarm”. The values, that trigger alarms or warnings for a Channel have to be determined in the Ontology profile. Example: An Alarm channel was defined in the ontology that is called “Machine status”. The text strings for each status can also be configured individually in the ontology profile. The channel can be configured to do the following:

  • When a “0” is send to “Machine status” all warnings and alarms are cleared.

  • When a “1” is send to “Machine status” a warning can be generated with the text: “Machine manual stop”.

  • When a “2” is send to “Machine status” an alarm can be generated with the text: “Machine unexpected stop”.

  • When a “3” is send to “Machine status” an alarm can be generated with the text: “Machine power loss”.

Notification Preferences

The Notifications page allows a user to set up individual preferences for receiving notifications of device events via email and SMS text messages. This includes the warnings and alarms mentioned above.
Three categories of notifications can be enabled or disabled.

1. Alarms- Alarms, Incidents, Device Faults
2. Warning Events- Threshold Warnings, Device Warnings
3. Device Events- Status Changes, Informational Events

Important: The notification preferences can only be set by every user for himself. Other users or admins can not change the notification preferences for another user.

Important: The notification preferences have to be set for every Organization the user has access to. Notification preferences are not automatically copied to other Organizations the user may have access to!

Custom Notifications

In contrary to the Notification Preferences, Custom Notifications can be set for the active user but for other users as well.

Important: Custom Notifications can only be generated for channels with the type “Alarm”. Therefore those notifications can be deployed for application generated alarms, only.

How to create Custom Notifications:

1. Click on Custom Notifications in the top left corner of the page.
2. Click on the Add Custom Notification button at the bottom of the page or the three dots on the right hand side of the page to add a Custom Notification.

3. After selecting device types, click next and select the Group or Organization.

4. Select the Device Type.

5. Choose the Device

6. Select the specific event types for the notification.

NOTE: Enable the Advanced feature in the top left corner to set a custom notification delay.

7. Select the User that will receive the notifications.

8. Give the Notification a name and enable email or text notifications. Click Add Notification.

9. The notification is now created and active

Data Export

All data that is send from the application to Brightlayer with data type “Trend” can be exported to be used for data analytics reports. To select and export data, Trend widget would be used. Every Trend widget can be used for data export. Though, a Trend widget on a dashboard may only have access to the data of one specific device or a set of devices within a group.

Trend widget for comparison

If you would like to e.g. compare the data of one specific channel (e.g. energy consumption) for a set of different devices, it may be useful to add a separate Trend widget to a central dashboard and link it to the devices you want to compare.

Once the Trend widget has been added to the dashboard, the device assignment can be opened by clicking the toggle switch.

Device and Groups can be selected.

The channel(s) that should be compared can be selected.

You may need to increase the number of channels to be displayed in the widget. By default this is set to “6” channels. The maximum number of channels that can be displayed in the trend widget is 10!

Afterwards the widget configuration can be closed.

Exporting data with the Trend widget

On the bottom of the Trend widget the “Full Trend Viewer” could be opened. The Full Trend viewer has the following sections:

1. Date(s) selector With this selector the start and end date of the data export can be selected.

2. Default time frame This section allows to select a default time frame to be displayed in the chart and exported. The options are 24 hours / 15 days / 31 days. Choosing these settings will always show the data from the current day (hour) looking backwards. If you wish to show historical data (e.g energy consumption 3 month ago during one week) the dates need to be selected with the Date selector.

   Important: When the default time frame is set to “24h” the date selector will only allow to choose one day. The default time frame needs to be set to “15d” or “31d”. Only then the Date selector would allow to choose a time period.

3. Export button Click here to set the export preferences and start the export.

4. Channel selection If only a subset of the available channels should be exported, channels can be selected or de-selected in this section.

Export preferences

Once the time period and the channels to be exported have been selected, the export preferences can be selected by clicking the “Export” button.

The data can be exported in the following format (to be selected in the drop down):

• CSV

• Excel

• PDF

The exported data can either be downloaded or dirctly send by e-mail. If “E-Mail” is chosen, a user has to be selected from a drop down after the selection. Once all those settings have been done, the “Export” button will become active and the data can be exported.