Merge pull request #8 from industrial-edge/updates

Updated HowTo

README.md

@@ -1,6 +1,6 @@
-# Notifier application example
+# Notifier
 
-This example shows how to use the Industrial Edge App "Notifier" to create notifications in case of an event.
+This example shows how to use the Industrial Edge app "Notifier" to create notifications in case of an event.
 
 - [Notifier application example](#notifier-application-example)
   - [Description](#description)
@@ -10,8 +10,11 @@ This example shows how to use the Industrial Edge App "Notifier" to create notif
     - [Prerequisities](#prerequisities)
     - [Used components](#used-components)
     - [TIA Project](#tia-project)
-  - [Installation steps](#installation-steps)
+  - [Configuration steps](#configuration-steps)
   - [Usage](#usage)
+    - [Showing notifications](#showing-notifications)
+    - [Accepting notifications](#accepting-notifications)
+    - [Archived notifications](#archived-notifications)
   - [Documentation](#documentation)
   - [Contribution](#contribution)
   - [Licence and Legal Information](#licence-and-legal-information)
@@ -20,101 +23,120 @@ This example shows how to use the Industrial Edge App "Notifier" to create notif
 
 ### Overview
 
-This document describes how to manage globally available notifications generated in case of an event.
-These events can be watched by a mobile phone or a smartwatch.
+The Notifier, that is running on the Industrial Edge Device (IED), offers globally accessible notifications that are generated in case of an event. For this purpose, the app monitors the variables stored in the Data Service according to the notification rules you have configured. Notifications can be accepted by a user. This means that this user will take care of the trigger event.
+
+There are three types of notifications: 
+
+- **Alert**: Notifications of the highest priority to which a response is expected immediately.
+- **Warning**: Notifications of medium priority that inform the user of an important status or problem in the plant, for example, when a parameter limit has been exceeded.
+- **Information**: Information about low priority events, such as pending maintenance.
+
+If the Notifier has some connected clients (smart devices with Notifier app running), it sends push notifications to the clients in case of an event. Thus the staff on site is informed immediately about issues within the facility, which reduces reaction times and downtimes. Furthermore the staff is able to see, who took over which responsibility.
 
 ![0](docs/graphics/0_Overview.PNG)
 
 ### General task
 
-A filling process is monitored by the Industrial Edge. In case of certain events notifications are generated by the system using the Notifier.
-Data is read from the PLC using the S7 Connector and published to the IE Databus.
-Necessary values are collected and managed by the [Data Service](https://github.com/industrial-edge/data-service).
-The Notifier as well as Performance Insight (for KPIs) can use these data to create the following notification rules:
+A filling process is monitored by the Industrial Edge system. This example reads data from a PLC via the OPC UA Connector. The acquired data is published to the Databus, from where the Data Service is able to collect the data. Within the Data Service, the data points of interest are created and stored. The Notifier connects to the Data Service and allows the user to create the following notification rules on basis of these parameters:
+
+- Information: Production was stopped
+- Warning: High gas consumption
+- Alert: Error within production
 
-- Information: Production was started
-- Warning: Tank level falls below a defined level
-- Alert: Production quality falls below defined KPI level
+In case of these events, notifications are generated and send to a smart device with installed Notifier app.
 
 ## Requirements
 
 ### Prerequisities
 
 - Access to an Industrial Edge Management System (IEM)
 - Onboarded Industial Edge Device on IEM
-- Installed System Configurators for Databus and S7 Connector
-- Installed System Apps Databus and S7 Connector
-- Installed Apps Data Service, Performance Insight and Notifier
+- Installed System Configurators for Databus and OPC UA Connector
+- Installed System Apps Databus and OPC UA Connector
+- Installed Apps Data Service and Notifier
 - Edge device is connected to PLC
 - TIA portal project loaded on PLC
-- Google Chrome (Version ≥ 72) or Firefox (Version ≥ 62)
+- HTML5-capable Internet browser (in general it is advised to use Chrome, for Linux based systems it is recommended to use Firefox)
 
 ### Used components
 
-- Industrial Edge Management V1.2.0-36 / V1.2.16
-  - IE Databus V1.2.16
-  - IE Databus Configurator V1.2.29
-  - S7 Connector V1.2.26
-  - S7 Connector Configurator V1.2.38
-  - Data Service V1.1.1
-  - Performance Insight V1.2.1
-  - Notifier V1.2.0
-  - Notifier iOS V1.0.4
-- Industrial Edge Device V 1.2.0-56
-- TIA Portal V16
-- PLC: CPU 1511 FW 2.8.3
+- Industrial Edge Management OS V1.5.2-4
+  - IE Databus Configurator V2.1.0-3
+  - Common Connector Configurator V1.8.2-3
+- Industrial Edge Management App V1.12.10
+  - OPC UA Connector V1.8.1-6
+  - IE Databus V2.1.0-4
+  - Data Service V1.7.0
+  - Notifier V1.15.0
+- Industrial Edge Device V1.8.0-6
+- SIMATIC Notifier app for iOS V1.0.5
 
 ### TIA Project
 
 The used TIA Portal project can be found in the miscellaneous repository under "[tank application](https://github.com/industrial-edge/miscellaneous/tree/main/tank%20application)".
 
-## Installation steps
+## Configuration steps
 
-You can find the further information about the following steps in the [docs](docs/Installation.md)
+You can find the further information about the following steps in the [configuration](docs/Installation.md) documentation:
 
-- Configure PLC project
-- Configure PLC Connection (Databus, S7 Connector, Data Service)
-- Configure Performance Insight
-- Configure Notifier
-- Configure Notifier iOS
+- [Configure PLC Connection](/docs/Installation.md#configure-plc-connection)
+- [Configure Data Service](/docs/Installation.md#configure-data-service)
+- [Configure Notifier](/docs/Installation.md#configure-notifier)
+- [Connect smart devices](/docs/Installation.md#connect-smart-devices)
 
 ## Usage
 
-To run the application, follow these instructions:
+Once the Notifier is successfully configured and running on the IED and (optional) the Notifier app is installed on a smart device, the staff is able to receive notifications in case of an event. All notifications are displayed on the Notifier start page on the IED. The smart device shows only the notifications that were selected using the 'My notifications' filter within the Notifier settings. On both sides, the users can accept the notifications.
+
+### Showing notifications
+
+On the IED, open the Notifier app UI. On the "Notifications" start page you directly see the the incoming notificiations according to the rules you have created. There are two possible views available:
+
+- All notifications (all notifications are displayed)
+- My notifications (notifications according the filter settings for "My notifications" are displayed)
+
+![8_1_Notifier.png](/docs/graphics/8_1_Notifier.png)
 
-- Make sure that the  PLC is connected to the Edge device and TIA project is downloaded
-- S7 Connector, Databus and Data Service applications are running
-- Performance Insight and Notifier are running
-- Open the Notifier user interface
-- Start the filling application via the HMI
+Hint: Notifications can also be triggered by other apps, such as Performance Insight or Machine Monitor. In the detail text of the notification, the origin is displayed in the "Originating app" area.
 
-Simulate some 'faulty bottle' productions in the HMI
--> alert "Low limit violated" (KPI) appears in the Notifier
+On the smartphone, a push notification is received in case of a new notification.
 
-![5_3](docs/graphics/5_3_Notifier.PNG)
+![8_2_App.png](/docs/graphics/8_2_App.png)
 
-Wait till the tank level falls near 160l
--> warning "tank empty" appears in the Notifier
+If user groups are set up in the app, the users of a group are notified of the events in the specified order. If one user can not accept the notification, it is forwarded to the next one after the configured time.
 
-![5_4](docs/graphics/5_4_Notifier.PNG)
+You can also send the notifications displayed under "My notifications" by email, if this setting was activated in the configuration.
 
-Reset and start the filling simulation in the HMI
--> information "production started" appears in the Notifier
+![6_SMTP_3](/docs/graphics/6_SMTP_3.PNG)
 
-![5_5](docs/graphics/5_5_Notifier.PNG)
+### Accepting notifications
 
-Hint: Notifications can be triggered by other apps, such as Performance Insight.
-To identify where the notification originated, the detail text of the respective notification contains the Operating App area.
+By accepting a notification, you inform other users that you will take care of the issue.
 
-By accepting a notification, you inform  other users that you will take care of the issue. The acceptance of a notification cannot be undone.
-A notification is marked as "automatically resolved" in the Archive tab, when it has not been accepted by any user or the reason for triggering no longer exists.
+To accept a notification via the Notifier app UI, click "Accept" in the list of notifications. Here you can also reset the acceptance of a notification.
+
+![8_5_Notifier_Accepted.png](/docs/graphics/8_5_Notifier_Accepted.png)
+
+To accept a notification on the smartphone, click "Accept" in the detail view of a notification.
+
+![8_3_App.png](/docs/graphics/8_3_App.png)    ![8_4_App_Accepted.png](/docs/graphics/8_4_App_Accepted.png)
+
+### Archived notifications
+
+The "Archive" view within the Notifier app UI shows the notifications that have been automatically resolved or deleted.
+
+A notification is marked as "automatically resolved", when it has not been accepted by any user or the reason for triggering no longer exists.
+
+![8_6_Notifier_Archive.png](/docs/graphics/8_6_Notifier_Archive.png)
 
 ## Documentation
 
 You can find further documentation and help in the following links
+
   - [Industrial Edge Hub](https://iehub.eu1.edge.siemens.cloud/#/documentation)
   - [Industrial Edge Forum](https://www.siemens.com/industrial-edge-forum)
-  - [Industrial Edge landing page](http://siemens.com/industrial-edge)
+  - [Industrial Edge landing page](https://new.siemens.com/global/en/products/automation/topic-areas/industrial-edge/simatic-edge.html)
+  - [Industrial Edge GitHub page](https://github.com/industrial-edge)
 
 ## Contribution