predictive maintenance user manual · the dashboard consists of different tiles. these are...
TRANSCRIPT
Predictive Maintenance User Manual Release 3.4 Version 3.4 Datum 01.03.2018
II
Table of Contents
1 INTRODUCTION ..................................................................................................................... 1
2 PREDICTIVE MAINTENANCE WEB APPLICATION ............................................................. 2
2.1 Login ................................................................................................................................... 2
2.2 Themes ............................................................................................................................... 3
2.3 General usage .................................................................................................................... 4
2.3.1 Sections ........................................................................................................................... 4
2.3.2 Sorting Lists ..................................................................................................................... 4
2.3.3 Searching ......................................................................................................................... 5
2.3.4 Selecting list items ........................................................................................................... 5
2.3.5 Time ................................................................................................................................. 6
2.3.6 Input Validation ................................................................................................................ 6
2.4 Dashboard .......................................................................................................................... 8
2.4.1 New Devices Tile ............................................................................................................. 8
2.4.2 Alert Overview Tile ........................................................................................................... 8
2.4.3 Device Activity State Tile .................................................................................................. 9
2.4.4 Map Tile ........................................................................................................................... 9
2.5 Devices ..............................................................................................................................10
2.5.1 Device List ......................................................................................................................10
2.5.2 Add Device ......................................................................................................................11
2.5.3 Add device type ...............................................................................................................12
2.5.4 Edit Device ......................................................................................................................12
2.5.5 Disable / Enable Device ..................................................................................................13
2.5.6 Live Data .........................................................................................................................14
2.5.7 Device Groups ................................................................................................................14
2.5.8 Create Device Group .......................................................................................................14
2.5.9 Edit Device Group ...........................................................................................................16
2.5.10 Delete Device Group ...................................................................................................16
2.5.11 Map .............................................................................................................................17
2.6 Live Data............................................................................................................................19
2.7 Analytics............................................................................................................................21
2.7.1 Diagram ..........................................................................................................................22
2.7.2 Key Indicators .................................................................................................................22
2.7.3 Distribution ......................................................................................................................23
2.7.4 Trendanalysis ..................................................................................................................23
2.7.5 Anomaly ..........................................................................................................................25
2.7.6 Raw Data ........................................................................................................................26
III
2.7.7 Export Data .....................................................................................................................27
2.7.8 Map .................................................................................................................................28
2.8 Rules ..................................................................................................................................29
2.8.1 Alert Processing ..............................................................................................................29
2.8.2 Rule Properties ...............................................................................................................30
2.8.3 Rule List ..........................................................................................................................30
2.8.4 Add Rule .........................................................................................................................31
2.8.5 Edit Rule .........................................................................................................................34
2.8.6 Delete Rule .....................................................................................................................35
2.8.7 Disable / Enable rule .......................................................................................................35
2.8.8 Alert List ..........................................................................................................................35
2.9 Settings .............................................................................................................................37
2.9.1 Usage Data .....................................................................................................................37
2.9.2 User Management ...........................................................................................................39
2.10 Help Area ...........................................................................................................................43
2.11 User Profile .......................................................................................................................43
2.12 Log out ..............................................................................................................................45
IV
List of Figures
Figure 2.1: Predictive Maintenance Web Application entry point .................................................... 2
Figure 2.2: Theme "Telekom" ......................................................................................................... 3
Figure 2.3: Theme "Machine" ......................................................................................................... 3
Figure 2.4: Sections ....................................................................................................................... 4
Figure 2.5: Column with ascending sort order ................................................................................ 5
Figure 2.6: Column with descending sort order .............................................................................. 5
Figure 2.7: Unsorted column .......................................................................................................... 5
Figure 2.8: Search field above lists ................................................................................................. 5
Figure 2.9: Selection check boxes .................................................................................................. 6
Figure 2.10: Number of selected items ........................................................................................... 6
Figure 2.11: The Dashboard ........................................................................................................... 8
Figure 2.12: Device List .................................................................................................................10
Figure 2.13: Selection of at least one device enables additional buttons .......................................10
Figure 2.14: Adding a new device .................................................................................................11
Figure 2.15: Edit Device ................................................................................................................13
Figure 2.16: Device Groups tab in the Device List .........................................................................14
Figure 2.17: Create a new Device Group ......................................................................................15
Figure 2.18: Edit a Device Group ..................................................................................................16
Figure 2.19: Delete group confirmation ..........................................................................................17
Figure 2.20: Map view ...................................................................................................................17
Figure 2.21: Running device ..........................................................................................................18
Figure 2.22: Disabled device .........................................................................................................18
Figure 2.23: Bing map controls (pan, zoom and map style) ...........................................................18
Figure 2.24: Dropdown-menu on Live Data View...........................................................................19
Figure 2.25: History chart examples ..............................................................................................19
Figure 2.26: Gauge chart examples...............................................................................................20
Figure 2.27: Value examples .........................................................................................................20
Figure 2.28: Filtering the Analytics section ....................................................................................21
Figure 2.29: Diagram report ..........................................................................................................22
Figure 2.30: Key Indicators report .................................................................................................22
Figure 2.31: Distribution of Data ....................................................................................................23
Figure 2.32: Linear Regression .....................................................................................................24
Figure 2.33: Quadratic Regression ................................................................................................24
Figure 2.34: Anomaly report ..........................................................................................................25
Figure 2.35: Example of the normal operating range of a sensor and where anomalies occur.......25
Figure 2.36: Data report ................................................................................................................26
V
Figure 2.37: Export Data Report ....................................................................................................27
Figure 2.38: Map that displays the location of the devices .............................................................28
Figure 2.39: Alert Processing in the Predictive Maintenance Web Application ...............................29
Figure 2.40: Rule List ....................................................................................................................31
Figure 2.41: Create Rule dialog .....................................................................................................32
Figure 2.42: Exemplary rule (an alert will be triggered when the temperature of the selected device
exeeds 70 °C) ........................................................................................................................33
Figure 2.43: Rule Edit dialog (partial view) with Geo-fence trigger .................................................34
Figure 2.44: Alert list .....................................................................................................................36
Figure 2.45: Usage Data View .......................................................................................................38
Figure 2.46 Delete measurements modal ......................................................................................38
Figure 2.47 Confirm delete measurements modal .........................................................................38
Figure 2.48 User list ......................................................................................................................39
Figure 2.49 Add user .....................................................................................................................40
Figure 2.50 Edit user .....................................................................................................................41
Figure 2.51: User Profile ................................................................................................................44
VI
List of Tables
Table 2.1: Default device type properties ......................................................................................12
Table 2.2: Report types according to value types ..........................................................................21
Table 2.3: Properties of a rule .......................................................................................................30
Table 2.4 Profile fields ...................................................................................................................42
Table 2.5 Profile Fields ..................................................................................................................45
1
1 Introduction
This is the user manual for the Predictive Maintenance Platform. It describes the operation
of the predictive maintenance web application.
2
2 Predictive Maintenance Web Application
The Predictive Maintenance Web Application provides access to the devices that have
been registered on the Predictive Maintenance Platform. It allows the management and
monitoring of devices as well as analysis on the data that is received from the devices.
The application is optimized for a screen resolution of 1920 x 1200 pixel and Google
Chrome. There might be some minor presentation issues when using other browsers or
resolutions. This does not affect the functionality of the application.
2.1 Login
During the registration process the users are provided with the account data to log in. To
log in the user has to navigate to the Predictive Maintenance Website and click the link
("Click here to login"). This triggers a redirection to the Microsoft log in page. On the first
login it is mandatory to change the initial password to a new one. On successful authenti-
cation the user will be redirected to the application's Dashboard.
Figure 2.1: Predictive Maintenance Web Application entry point
NOTE:
For safety reasons a password is only valid for 90 days. After that period the user will be
asked to change the password at the next login.
3
2.2 Themes
The application can be used with different themes that can be selected by the user in the
profile settings. In general, the same functionality is accessible in the same way for all
themes. Therefore, all screenshots in this document are only made for one theme ("Tele-
kom") and the view's design may differ depending on the selected theme.
Figure 2.2: Theme "Telekom"
Figure 2.3: Theme "Machine"
4
2.3 General usage
This chapter describes the operation of specific sections of the application in detail.
2.3.1 Sections
The links to the different sections of the application can be found on the left hand of the screen. These sections divide the application into several topics (Dashboard, Devices, Live-Data, Analytics, Rules and Settings) and contain the available information and opera-tion options respective to the topic. The currently opened section is always highlighted.
Figure 2.4: Sections
2.3.2 Sorting Lists
Application wide the list views can be sorted by clicking on the column name. This will sort
the list by the values of the column in ascending order. Clicking again will flip the direction
and sort in a descending order.
5
Figure 2.5: Column with ascending sort order
Figure 2.6: Column with descending sort order
Unsorted columns are marked with an icon showing two light gray arrows. The lists can be
sorted by one column at a time only, meaning that sorting a list by another column will
remove any other sort order.
Figure 2.7: Unsorted column
2.3.3 Searching
A search box above a list provides a full text, case insensitive partial search over the
whole displayed table. Typing into this search box will immediately reduce the amount of
results by only displaying matching items. Pressing ENTER (↵) or clicking the magnifica-
tion glass is not necessary. It is possible to type in multiple search strings which are sepa-
rated by space character. Only items that match both strings will be displayed.
Please note that only the displayed table is searched for the value entered and not all da-
ta available on the server.
Figure 2.8: Search field above lists
2.3.4 Selecting list items
Items in lists are preceded with a check box to select one or multiple entries. The column
header also contains a check box to select all or none of the items in the list.
6
Figure 2.9: Selection check boxes
The number of selected items is displayed above the list next to the search box.
Figure 2.10: Number of selected items
2.3.5 Time
UTC time rather than local time is used all over the Predictive Maintenance Web Appli-
cation.
2.3.6 Input Validation
The user input is validated in the UI wherever needed. The input validation ensures that
all entered data is in the right format and length. Additionally it ensures that mandatory
fields, marked with an asterisk (*), are not empty. Beyond that the input validation may
check if the entered values are unique if needed. If the input validation fails the user will
be informed about the reason and the corresponding input field is highlighted red. Before
saving data the input validation has to be passed.
2.3.7 Storage for telemetry data
The user has a soft limited storage of 80GB, if he did not book any storage extending op-tion. If the user is storing more than 80GB of data the oldest one will be deleted (FiFo = First in, first out). Additionally every data, which is older than 6 months, will be deleted in the same way.
2.3.8 Long Term Analytics Storage
Long Term Analytics Storage (LTAS) is an option which can be booked by the customer.
This option allows the user to store data longer than 6 months. The customer has to pay
for each used GB of data. When booking this option the user is able to create reports for
data which are older than 6 months in the analytics area.
7
Additionally it’s possible to store more than 80GB. If the customer wants to use more than
80GB he should contact the support.
8
2.4 Dashboard
Figure 2.11: The Dashboard
The Dashboard is the entry point of the web application and provides an overview of the
most important events and current states of the devices.
The Dashboard consists of different tiles. These are rectangular areas which each contain
information of a specific type (like alert information or the state of the devices).
The default tiles are “New Devices”, the “Alert Overview”, the “Map” and the “Device Activ-
ity State” (see Figure 2.11: The Dashboard).
2.4.1 New Devices Tile
The New Devices tile shows a list of devices that have been added to the system lately.
The devices will be shown on this tile as long as their details have not been changed by
the user. Clicking on a device redirects to the device list filtered to the clicked device's
name. A click on show details will redirect to the unfiltered device list.
2.4.2 Alert Overview Tile
The Alert Overview gives an overview of the alerts that have been triggered recently. The
different colours show the severity of alerts:
critical alert (red)
regular alert (orange)
early alert (yellow)
The number of alerts is counted for the depicted period of time.
9
2.4.3 Device Activity State Tile
The Device Activity State tile gives an overview of the activity state of the devices. Cur-
rently the devices can be either enabled or disabled. The pie chart shows the proportion of
enabled and disabled devices.
2.4.4 Map Tile
The Map tile shows the defined home location of a device as well as the status of the de-
vice. A device is represented by a pin on the map that changes its appearance depending
on whether it is enabled, disabled or an alert was raised during the last 24 hours. In case
of an alert the pin shows only the highest alert that occurred.
10
2.5 Devices
2.5.1 Device List
This page shows all registered devices. By clicking one of the checkboxes the according
device can be selected. It is also possible to select multiple devices.
Figure 2.12: Device List
Depending on the amount of selected devices, additional buttons above the Device List
become visible. These buttons offer additional functionality (Activate or Deactivate the
selected device(s), show the Data Usage, show the Live Data or Edit the selected de-
vice). When no device is selected there is only one button visible to Add a new device.
Figure 2.13: Selection of at least one device enables additional buttons
11
2.5.2 Add Device
NOTE: Only admin user can edit devices.
The button Add Device is shown when no device is selected in the list.
A new device can be added to the system by clicking the Add button. A dialog opens and
the device's data has to be entered.
Mandatory inputs are
device name
device ID
device type (If your device provides different data than the default device type, you
need to define a device type as a prototype template of your devices)
Optional inputs are
device manufacturer
home location of the device (up to 6 decimal places can be entered)
Clicking the Save button will add the device to the system. Clicking the Cancel button
aborts the current operation. If the device has been successfully added to the system a
connection string is given to the user. This string contains all necessary information for
establishing a connection to the system and has to be set on the device.
Figure 2.14: Adding a new device
12
2.5.3 Add device type
The application is preconfigured with a default device type, which allows devices to send
the data as shown in the table.
Name Value
Temperature [°C]
Humidity [%]
Air Pressure [bar]
Velocity [m/s]
Acceleration [(m/s)²]
Jerk [(m/s)³]
Current [A]
Voltage [V]
Length [m]
Distance [m]
Luminosity [lum]
Filling Degree [%]
Weight [kg]
Table 2.1: Default device type properties
If the default device data doesn’t match the data which is provided by your device you
need to create your own device type. The detailed description of how to configure the de-
vice type can be found in the configuration manual for Predictive Maintenance (Chapter 5
- Device Types).
2.5.4 Edit Device
NOTE: Only admin user can edit devices.
The button Edit Device is shown when one device is selected in the list.
To edit the attributes of a device it has to be selected. Clicking the Edit button in the De-
vice List will open the Edit Device Dialog in which the properties of the device can be
changed. Note that only some values like the name, the manufacturer and the home loca-
tion can be changed.
13
Clicking the Save button commits the changes to the device registry.
Clicking the Cancel button aborts the operation and dismisses all changes.
The device name has to be set and the entered name has to be unique. All other inputs of
this dialog are optional.
When a device group is entered the device will be automatically added to the respective
group. If that group does not exist it is automatically created.
Figure 2.15: Edit Device
2.5.5 Disable / Enable Device
NOTE: Only admin user can disable / enable devices.
The button Enable / Disable is shown when one or more device are selected in the list.
If a device is disabled in the Predictive Maintenance Web Application its data will no
longer be processed but the device will not be disabled physically.
14
To disable a device it has to be selected in the Device List followed by a click on the De-
activate button. The button works as a toggle button. The Device will be disabled imme-
diately and the button text changes to Activate.
To re-enable a device a click on the Activate button is sufficient.
When more than one device is selected containing both enabled and disabled devices, a
click on the button will Deactivate all selected devices.
2.5.6 Live Data
The button Live Data is shown when one device is selected in the list. It is enabled only if
live data for the device is activated.
When the button is clicked the user is redirected to the view Live Data (see 0) for the se-
lected device.
2.5.7 Device Groups
By defining Device Groups it is possible to group a set of devices logically. For each
group one or more rules can be specified rather than for the individual devices.
Viewing and management of Device Groups can be done in the section Devices and the
included tab Groups.
Figure 2.16: Device Groups tab in the Device List
The Device Groups List shows a list of all currently defined device groups.
Device Groups can be selected using the same check box metaphor as in all other list
views. If one or more groups are selected, it is possible to delete them by using the Delete
button above the list.
2.5.8 Create Device Group
NOTE: Only admin user can create device groups.
By clicking the Add button in the top right corner a new device group can be created. The
button is only available if none of the groups is selected, otherwise the Delete button
(and/or Edit button) will be shown. Clicking the Add button will open a pop up to enter the
15
name of the new device group. This pop up shows a list of devices that can be added to
the new group. This list can be filtered by entering a name into search field.
The group name has to be set and the entered name has to be unique. All other inputs of
this dialog are optional.
Figure 2.17: Create a new Device Group
Devices that have been added to the new group are shown in the upper part of the dialog
and can be removed from the group by clicking on the ( ) icon.
After finishing the selection of devices, the group can be saved by clicking the Save but-
ton or all changed can be discarded by clicking the Cancel button.
NOTE:
A device can only be assigned to one group. If a device already belongs to another group
and is assigned to a new group the device is automatically removed from the existing
group.
If all devices of an existing group are assigned to a new one, so that there are no devices
left in the existing group, the existing group will also be removed automatically.
16
2.5.9 Edit Device Group
NOTE: Only admin user can edit device groups.
By clicking the Edit button in the top right corner a device group can be edited. The button
is only available if exactly one group is selected. A pop up for editing the group will be
opened when the button is clicked. The group can now be edited in the same way as cre-
ating a new group (see Create Device Group).
The group name is mandatory and may not be empty. All other inputs of this dialog are
optional. The list may not be empty.
Figure 2.18: Edit a Device Group
2.5.10 Delete Device Group
NOTE: Only admin user can delete device groups.
17
Selecting one or more groups in the device group list will enable the Delete button. Click-
ing that button will show a confirmation popup that summarizes the upcoming delete op-
eration to ensure that the groups are selected properly and the delete operation is desired
to be performed. The operation can be discarded by clicking Cancel or it can be proceed-
ed by clicking Delete.
Figure 2.19: Delete group confirmation
2.5.11 Map
The Map can be accessed by clicking on the Home Locations tab in the Device section.
Figure 2.20: Map view
This map displays the home locations (the positions the devices have been registered
with). The dots are color coded. Currently two different states are available ("Running" or
"Disabled") and depicted in the map using two different icons. “Running” means that the
device is enabled and sending data and “disabled” means that the device has been disa-
bled and is not sending any data.
18
Figure 2.21: Running device
Figure 2.22: Disabled device
The Map can be panned by left-clicking and dragging or by clicking on the pan icon.
It can be zoomed by using the mouse wheel or by clicking on the zoom icons.
In general the Map provides the same controls as each bing map. The control icons are
accessible through the tool bar at the top right corner of the Map.
Figure 2.23: Bing map controls (pan, zoom and map style)
19
2.6 Live Data
The section Live Data shows a dashboard view showing the most current data from the
devices. Every time when new data is available the system updates the view automatical-
ly.
Since the dashboard shows the data from a specific device only, a device has to be se-
lected using the dropdown box on the top of the page.
Figure 2.24: Dropdown-menu on Live Data View
The available types of measuring visualization are
History chart (showing the course of a specific measuring type over a defined
amount of time, the color of the chart can be configured)
Figure 2.25: History chart examples
20
Gauge chart (showing the most current value of a specific measuring type withing
a fixed range, visualized by a 180°-arc, the color of the chart can be configured)
Figure 2.26: Gauge chart examples
Value (showing the most current value of a specific measuring type)
Figure 2.27: Value examples
If no specific Dashboard exists, you see a default Dashboard. The detailed description of how to configure a custom dashboard can be found in the con-figuration manual for Predictive Maintenance (Chapter 3 - Dashboard).
21
2.7 Analytics
The Analytics Page can be used to get a deeper insight into the sensor data of the de-
vices using different report types. The report types that can be selected depend on the
measurements that were sent from the device. The measurements (e.g. temperature, ma-
chine state, operation mode) are sent in a defined value type (e.g. float, integer, boolean).
According to this value type for each selected measurement only a subset of report types
are available.
Report type Availabe for value type
Diagram float, integer, boolean
Key Indicators float, integer, boolean
Distribution float, integer, boolean
Trendanalysis linear float, integer
Trendanalysis quadratic float, integer
Anomaly float, integer
Raw Data all available value types
Map geo data
Table 2.2: Report types according to value types
By selecting one or more devices, a certain time period, a measurement and one of the
available report types below the filter area the according report visual will be displayed.
To load a report it is necessary to select a device first. Afterwards, depending on the de-
vice's metadata, measurements and report types can be selected.
By default, the time period is set to the current time and the first available measurement
and report type are selected.
Figure 2.28: Filtering the Analytics section
22
2.7.1 Diagram
The report Diagram graphically displays the measured values of the selected devices and
time ranges as a line diagram.
Figure 2.29: Diagram report
2.7.2 Key Indicators
The Key Indicators report presents an overview of certain statistical features (like aver-
age, maximum, standard deviation, etc.) for the selected measurement.
Figure 2.30: Key Indicators report
23
2.7.3 Distribution
The Distribution report provides box plots (box-and-whisker-diagram) that show the dis-
tribution of the data. Statistically significant values (that lay inside / outside the median
region or can be considered as outliers) can be visually recognized.
Figure 2.31: Distribution of Data
2.7.4 Trendanalysis
The Trendanalysis reports demonstrate the trend of a certain measurement and make a
prediction about the future values. They predict a future trend based on the previous
measurements and provide a range of possible minimum and maximum values to account
for uncertainty in the prediction. The trend is calculated using a linear or quadratic regres-
sion of all measurements displayed in two different reports for linear and quadratic regres-
sion. If multiple devices are chosen, the corresponding calculation and visuals are made
using all data for all devices. Therefore, even if multiple devices are selected, only one
trend line will be calculated, and it will use the combined dataset containing all selected
devices.
The diagrams show the measurement values of the device for a given amount of time. But
it also gives a forecast on values that are expected in the future. These future values are
predicted to lie inside the value corridor shown as a blue area. The black dotted line in the
center of the corridor is the trend which has been calculated for the data.
24
Figure 2.32: Linear Regression
Figure 2.33: Quadratic Regression
25
2.7.5 Anomaly
The Anomaly Detection report displays the values for the measurement and indicates
where anomalously high or low measurements have been detected.
Figure 2.34: Anomaly report
The diagram shows the sensor recordings in colours grouped by the individual device, the
maximum and minimum values of the normal operating range in green dashed lines, and
anomalous values are highlighted in red. Measurements are deemed to be anomalous if
they exceed the normal operating range. To maximum value of the normal operating
range is calculated as two standard deviations more than the mean value, whereas the
minimum value of the normal operating range is calculated to be two standard deviations
less than the mean value.
Figure 2.35: Example of the normal operating range of a sensor and where anomalies occur.
The mean value and standard deviations are calculated over all selected data in the dia-
gram, and will be recalculated if the filters are applied to the input data. If multiple devices
are chosen, the corresponding calculation and visuals are made using all data for all de-
vices. Therefore, the normal operating ranges (and corresponding anomalous values) will
be calculated using the combined dataset from all selected devices. This means that if two
26
device sensors typically operate at different ranges, they should be plotted separately to
more accurately represent when a particular device reports anomalous values.
2.7.6 Raw Data
While the other reports give visual representations of the measurements, the Raw Data
report shows the raw telemetry data in a table.
Figure 2.36: Data report
The columns can be sorted by clicking on the column's header. A small black arrow ( )
indicates the sort order. Pointing upwards means ascending order, pointing downwards
means descending order.
27
2.7.7 Export Data
The Export Data report shows the raw telemetry data like the raw data report but includ-
ing all available measurements for the selected devices. The measurement filter will be
ignored. By using the more option button, displayed like “…” in the right corner of the data
table, all data can be exported to a csv file. For using this option just click on Export data.
Figure 2.37: Export Data Report
Please note that it is only possible to export the first 30.000 datasets of displayed data. If
more datasets should be exported the number of datasets should be reduced to steps of
30.000 by using lower time ranges.
28
2.7.8 Map
The Map report displays the location of the selected devices in the selected time range.
Figure 2.38: Map that displays the location of the devices
29
2.8 Rules
Rules are used to define certain conditions for the values that are sent from the devices to
the application. When a violation of a rule is detected an alert will be generated.
The configuration of rules takes place in the Rules List tab in the Rules section.
Rules can be defined for just a single device or for a group of multiple devices. Group
rules are a way to define rules that are valid for a larger number of devices. Instead of
defining a rule for a number of devices individually, the group rule mechanism allows to
define the rule once and simply add all devices the rule should be applied to.
Rules can be defined freely for any device measurement. Keep in mind though to leave
the measurement some valid space – otherwise the device would be in a situation where
it generates rule outputs all the time.
2.8.1 Alert Processing
Figure 2.39: Alert Processing in the Predictive Maintenance Web Application
The Predictive Maintenance Web Application uses a concept of device groups, rules
and alerts to give the user a possibility to define actions as a reaction to certain situations.
In a first optional step, the devices can be grouped into logical device groups. A device
group simply combines devices that are monitored by the same rule.
After organizing the devices into logical device groups, rules are defined. Each rule relates
to one or multiple measurement types (as temperature, humidity, battery level, etc.) and
uses an operator (as =, < or >) to express a condition that is monitored. At the arrival of a
new measurement for the device the measurement is compared to a threshold value.
30
If the rule is violated (the condition defined in the rule is no longer true) the rule produces
an alert. An email address may be configured to which alert email are sent.
2.8.2 Rule Properties
A rule in the Predictive Maintenance Web Application has the following properties:
Property Description
Target “Device” or “Group” indicates whether the rule is configured for a
single device or for a group of devices.
Device Name /
Group Name
Name of the device or the name of the device group.
Criticality Determines the importance of the alert generated by the rule. Can
be one of these values: “Early Alert”, “Alert”, “Critical Alert”.
Data Type The telemetry type which is monitored by the rule.
Operator Determines how the current value is compared to the threshold.
Threshold Defines the limit for the rule. If the data field is greater / equal / lower
(depending on the operator) than the threshold, the rule will gener-
ate an alert.
Notify via This field is used to specify how the alert is notified. Currently only
email can be selected. Email addresses can be entered here. If
needed, additional recipients can be added.
Message The message that is sent to the recipients has a fixed predefined
subject and text. It is possible to add an additional custom text to the
message.
Notify Every This is the rule’s notification interval. If the device measurement ex-
ceeds the rule's threshold an alert is generated only if the last alert
generated by this rule is older than defined by this time span.
Rule Name Can be used to give the rule a recognizable name.
Table 2.3: Properties of a rule
2.8.3 Rule List
The Rule List displays all the rules that are currently defined. It can be used to view exist-
ing rules and it is the place where new single device and group rules can be defined.
Depending on the amount of selected rules, additional buttons above the Rule List be-
come visible. These buttons offer additional functionality (Activate or Deactivate the se-
lected rule(s), Delete the selected rule(s) or Edit the selected rules). When no rule is se-
lected there is only one button visible to Add a new rule.
31
Figure 2.40: Rule List
2.8.4 Add Rule
NOTE: Only admin user can create rules.
The button Add is shown when no rule is selected in the list.
By pressing the Add button (only available if none of the rules in the list is selected) the
Add Rule dialog will be opened and a new rule can be created.
It has to be at least selected one device or one group as target when creating a new rule.
For every selected trigger it is mandatory to enter a threshold value. Value and unit of the
notification interval are mandatory inputs as well. The rule name has to be set and the
entered name has to be unique.
32
Figure 2.41: Create Rule dialog
33
Using this dialog the rule properties that are described in 2.8.2 can be defined and config-
ured.
In the Select Target section it is configured if the rule should be applied to a single device
or to a device group. Therefore the dropdown box offers the options Device and Group.
The following dropdown box offers all available devices or groups depending on the selec-
tion of the preceding dropdown box.
In the Trigger When section the conditions of the rule are set. After selecting the desired
measurement to be observed in the first dropdown box and the desired operator in the
second dropdown box the threshold value has to be entered. It is possible to add up to 6
triggers for a single rule by clicking on Additional trigger.
Figure 2.42: Exemplary rule (an alert will be triggered when the temperature of the selected device exeeds 70 °C)
NOTE:
Every rule can only have one geo-fence trigger.
A geo-fence rule will raise an alert if the device leaves the specified radius.
The severity of the rule can be set at the Classify Alert section. Available values for the
severity are Early Alert, Regular Alert or Critical Alert.
To activate notifications upon rule violations via email an email address has to be entered
in the Notify Via section. By clicking on Additional Assignee it is possible to add more
email addresses the notification will be sent to. The email contains a standard text that
describes which condition lead to the violation. Additionally a custom text in the Add Mes-
sage field can be entered.
In the Notify Every section a time interval can be specified that delimits the amount of
sent messages for that interval for this rule to one. Setting the notification interval to a
positive integer value and selecting the desired unit (Minutes or Hours) prevents the sys-
tem to send more than one email for that interval.
A name for the rule may be set in the Rule Name section.
By clicking the Save button the rule will be persisted whereas by clicking the Cancel but-
ton the rule will be dismissed.
34
2.8.5 Edit Rule
NOTE: Only admin users can edit rules.
The button Edit is shown when one rule is selected in the list.
Clicking that button opens the Edit Rule dialog. The usage of that dialog is the same as
when creating a new rule. Once done editing the rule has to be submitted by clicking the
Save button. Clicking Cancel will discard all changes that have been made to that rule.
It has to be at least selected one device or one group as target when editing a rule. For
every selected trigger it is mandatory to enter a threshold value. Value and unit of the noti-
fication interval are mandatory inputs as well. The rule name has to be set and the en-
tered name has to be unique.
Figure 2.43: Rule Edit dialog (partial view) with Geo-fence trigger
35
2.8.6 Delete Rule
NOTE: Only admin users can delete rules.
The button Delete is shown when one rule is selected in the list.
Deleting one or more rules is triggered by selecting the desired rules to be deleted in the
Rules List and clicking the Delete button above the list. Before execution of the operation
a confirmation dialog will show up that summarizes the pending delete operation.
2.8.7 Disable / Enable rule
The button Disable / Enable is shown if one or more rules are selected that have the
same state (either all of them are disabled or enabled). By clicking the button the selected
devices are then, depending on their current state, either disabled or enabled.
NOTE: Only admin user can disable / enable rules.
The button Enable / Disable is shown when one or more rules are selected in the list.
If a rule is disabled in the Predictive Maintenance Web Application it will no longer be
active so that no alerts will be raised upon a violation of the rule.
To disable a rule it has to be selected in the Rule List followed by a click on the Deacti-
vate button. The button works as a toggle button. The rule will be disabled immediately
and the button text changes to Activate.
To re-enable a rule a click on the Activate button is sufficient.
2.8.8 Alert List
Rule violations raise alerts that are listed in the Alerts tab. The list can be filtered by en-
tering a search value into the text field above and the size of the list is configurable (10,
50, 100 or 250 rows).
NOTE:
The filter field does not search through all alerts that have ever occurred; it only filters the
entries that are currently shown.
36
Figure 2.44: Alert list
37
2.9 Settings
The settings section contains the tabs Overview and User Management.
2.9.1 Usage Data
The tab Usage Data provides information on the usage data that is shown in the con-
tained table.
Above the table it is possible so view the history of the usage data. By changing the date
the related usage data will be displayed.
On top of the view there is indicated which product is currently booked.
The calculated and displayed values are
the amount of sensorvalues sent from the devices to the application per day
the burst amount of existing users per month
the amount of report calls (page loads in the analytics section)
the amount of devices
the size of used storage
The amount of sensorvalues is the sum of all sensorvalues that are sent from all active
devices to the application.
The burst amount of existing users is the maximum amount of users that are registered to
the application. This amount corresponds to the number of users (+1) that are shown in
the list of application users at that time. The maximum will be determined within the period
of the current month.
The amount of report calls is the number of page loads in the Analytics Section. The coun-
ter is incremented by 1 when opening the analytics section. Using the filters in the analy
The amount of devices shows the count of currently registered devices (activated and
deactivated) to the application.
The size of used storage shows the overall amount of storage capacity that is used by the
application and its data.
The data is measured and stored once every 2 hours. Only latest measurement is dis-
played.
38
Figure 2.45: Usage Data View
2.9.1.1 Deleting Measurements
To delete the stored measurement data click on the checkbox next to the storage entry
within the usage data table. A loading indicator and an information is shown when a dele-
tion either planned or in progress and the button for the measurement data deletion modal
is disabled.
Within the modal it is possible to trigger the deletion of a tenant's measurement data. It is
possible to select a time range and a list of devices for the deletion process.
Figure 2.46 Delete measurements modal
Clicking on the "Delete" button will lead to a confirmation text. Confirming the deletion will
enable the deletion process to start.
Figure 2.47 Confirm delete measurements modal
39
NOTE:
There are 2 behaviors which have to be mentioned:
Deleting for specific devices: 1 or many devices are selected. Only the measure-
ment data for selected date and devices is deleted. This case only deletes the data
for the user's namespace. Measurements stored in the blob storage will not be
deleted.
Deleting with an empty device list: Triggering the deletion process with an empty
device list enables the user to delete all the data for the selected date range. This
case deletes the data for all namespaces within the tenant. Measurements stored
in the blob storage will also be deleted during this process.
2.9.2 User Management
To get to the User Management the item at the bottom of the menu bar has to be clicked.
This user management and therefore the menu item is only available for admin users.
2.9.2.1 List of Application Users
The user management's main view shows a list of all users that are registered to the ap-
plication.
On this page it is possible to create new users or edit and delete existing ones. The but-
tons on top of that view are available conditionally depending on the number of users that
are currently selected by the checkboxes:
0 users selected: only the Add button is shown
1 user selected: the Delete button and the Edit button are shown
2 or more users selected: the Delete button is shown
This functionality of the buttons and the opened dialogs are described in the following sec-
tions.
Figure 2.48 User list
40
2.9.2.2 Create User
Clicking on the Add button opens a modal window where the desired user data can be
entered. All fields marked with an asterisk (*) are mandatory. In this dialog the fields
username, role, login name (including the domain) and the email address are mandatory.
Figure 2.49 Add user
After clicking the Save button, the user will be created and an email with the initial pass-
word will be send to the entered email address. When logging in for the first time it is rec-
ommended to change the password.
41
2.9.2.3 Edit User
Clicking on the Edit button opens the profile editor to change the values of the profile da-
ta.
All fields marked with an asterisk (*) are mandatory. In this dialog the fields name, role,
login name (including the domain) and the email address are mandatory.
Figure 2.50 Edit user
Some of the fields like the login name cannot be changed. The table below shows an
overview of the available fields and their changeability.
Name Changeable Description
Login Name* NO The authentication name
42
Table 2.4 Profile fields
Clicking on the Save button at the top right to persist the changes.
2.9.2.4 Delete User
When one or more users are selected the Delete button above the table becomes visible.
Clicking that button opens a confirmation window that shows the login name of the user(s)
selected to be deleted. The operation can be cancelled by clicking No whereas clicking
Yes initiates the deletion of the user. Either way, the confirmation dialog is closed and the
(updated) view of users tab is shown.
NOTE:
The deletion of a user can not be undone.
It is not possible to delete your own user account.
Domain* NO The domain for the login name
Username* YES The display name of the user
Mail* YES The mail address of the user, to which the new
password will be send at reset password
First Name YES The first name of the user
Last Name YES The last name of the user
Department YES The department of the user
Street YES The street of the user
Postal Code YES The postal code of the user
City YES The city of the user
State YES The state of the user
Country YES The country of the user
Phone YES The phone number of the user.
Mobile YES The mobile number of the user
43
2.10 Help Area
The Help Area is on top of the page. It is possible to access the information by clicking the
'?' symbol. A link to the User-Manual and the availability of the service hotline can be
found in the callout box.
2.11 User Profile
The User Profile dialog can be accessed by clicking on the link (username) on the top of
the page. It is possible to set the language and the design as well as various other values.
Mandatory fields are marked with an asterisk (*). In this dialog the username, the email
address, the language and the design inputs are mandatory.
NOTE:
The language and theme selection is only stored in the browser and not on the server.
Therefore the settings may seem to be reset when changing the browser or deleting its
cache.
44
Figure 2.51: User Profile
45
The user profile contains the following fields:
Table 2.5 Profile Fields
2.12 Log out
A log out from the Predictive Maintenance Web Application can be performed by clicking
the Logout button at the top right of the page. The user is logged out immediately.
Name Changeable Description
Login Name* NO The authentication name
Roles* NO Admin or Read only can be selected. Only Ad-
min users have rights to create, edit and delete.
The role can only be changed if by admin users.
Username* YES The display name of the user
Mail* YES The mail address of the user, to which the new
password will be send at reset password
First Name YES The first name of the user
Last Name YES The last name of the user
Department YES The department of the user
Street YES The street of the user
Postal Code YES The postal code of the user
City YES The city of the user
State YES The state of the user
Country YES The country of the user
Phone YES The phone number of the user
Mobile YES The mobile number of the user
Tenant ID No The tenant identifier of the user