WebHMI Docs

User Tools

Site Tools

alerts

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
alerts [2018/08/06 08:37] – emozolyakalerts [2022/10/10 08:46] (current) – [New alerts configuration] emozolyak
Line 1: Line 1:
 +{{ network:menu-icon-alerts.png?nolink&40|}}
 ====== Alerts ====== ====== Alerts ======
  
-----+===== New alerts configuration =====
  
 +In WebHMI there is the concept of an alert. An alert is a state of the system that requires human attention. WebHMI signals on all alerts visually (red status bar on the dashboards) and an audible signal about unqualified accidents. The alerts are kept in a special alerts log. 
 +
 +Starting from 3.6 fw version, __a new alert setup__ has beed implemented. For versions below 3.6 please refer to the next section. 
 +
 +When some alert triggers there will be pop-up window, like this - 
 +
 +{{ network:descent_alert_msg2.png?direct&400 |}}
 +
 +There will be the alert title, group (if it belongs to a group), start time, duration, acknowledge status and the link to details. 
 +In the new alerts there is a number of improvements:
 +  *more complex conditions for each alert. 
 +  *richer alert description with insructions  (extended text format, pictures)
 +  *operator can add comments after alert has been triggered
 +  *templates - for identical devices with the same alerts conditions, you can setup only one template 
 +
 +The alert setup link is here:
 +
 +{{ network:alerts_link.png?direct&400 |}}
 +
 +The example of an alert list:
 +
 +{{ network:new_alerts_list_commented.png?direct&400 |}}
 +
 +Here:
 +  -is the button to create an **alert object**
 +  -is the button to create an **alert group**
 +  -is the list of non-grouped alerts
 +  -is the **category** name for organizing the list. There are 2 groups in the example provided. 
 +  -it is a list of **grouped alerts**. The titles in bold text indicate group title. Only a group can be a template for another group of alerts. The template column tells if the group is a template or templates' descendant. 
 +  -is a list of **templates' descendants**. For descent alert groups you can tell the system substitution rules for the registers, in the same way as for dashboard templates.
 +
 +In the __Basic__ edit alert tab you set title, template, category and level (Info, Warning, Alert), wether to allow acknoledge and sound signal.
 +
 +{{ network:alert-edit-basic-tab.png?direct&400 |}}
 +
 +<WRAP center round important 60%>
 +Please note the sound will ring only while there are active and unacknowledged alerts. 
 +</WRAP>
 +
 +
 +In the __Condition__ tab, you define the condition which will trigger the alert. It can be specific bit of a register or its value (=, ≠, <, >, [a, b]((in range from a to b))). The multiple conditions are combined only with AND operator. So for OR operation or more complex conditions you can use Lua scripts. 
 +
 +{{ network:alert-edit-contition.png?direct&400 |}}
 +
 +In the __Information__ tab, there is a text editor with formatting options to create messages including one optional picture. This message will be shown if an operator press Details... link in the alert pop-up dialog. 
 +
 +{{ network:alert-edit-information.png?direct&400 |}}
 +
 +Information page in this case could be like this:
 +
 +{{ network:alerts.png?direct&400 |}}
 +
 +All alerts are stored in their log, which can be accessed from side bar or context menu link.The following filters are available for convinient looking-through:
 +  * Level - info, warning, alert
 +  * title - with find sub-string
 +  * group
 +  * status - active / fixed, acknoledged and not acknowledged
 +Every column has a sorting action and an omni-search box is provided as well to search in all alerts. 
 +
 +{{ network:new_alert_log_view.png?direct&400 |}}
 +
 +<wrap em>As of 4.0 fw version there is an alert comment dictionary </wrap>
 +I.e. an operator can quickly select on of the predefined messages to comment the alert or his action, etc. 
 +There is a field to select the dictionary for this:
 +
 +{{ network:alert_comment_selector_.png?direct&400 |}}
 +
 +Then when acknowleding or viewing the alert, an operator can quickly select the desired dictionary entry. 
 +
 +{{ network:alert_comment_selection.png?direct&400 |}}
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +===== Alerts configuration before 3.6 fw version =====
  
 In WebHMI there is the concept of an alert. An alert is a state of the system that requires human attention. WebHMI signals all alert visually (red status bar on the dashboards) and an audible signal about unqualified accidents. Emergencies are logged for later analysis. In WebHMI there is the concept of an alert. An alert is a state of the system that requires human attention. WebHMI signals all alert visually (red status bar on the dashboards) and an audible signal about unqualified accidents. Emergencies are logged for later analysis.
Line 10: Line 91:
 Any of alerts can be allowed to be acknowledged. This allows you to tell the system that the operator is aware of its occurrence. Also for the alerts you can set its level - Information, Warning, Accident. In the initial state, the "Alerts" side menu item is empty, crashes there will only appear after creating at least one register with alert bits in the project. Any of alerts can be allowed to be acknowledged. This allows you to tell the system that the operator is aware of its occurrence. Also for the alerts you can set its level - Information, Warning, Accident. In the initial state, the "Alerts" side menu item is empty, crashes there will only appear after creating at least one register with alert bits in the project.
  
-{{::setup_alerts2.png?direct&800|}}+{{network:setup_alerts2.png?direct&800|}}
  
 When an alert occurs, the system will turn the status bar to red. The line will blink periodically to attract attention. Also, if there are unqualified alerts, an audible alert will be issued every 15 seconds.  When an alert occurs, the system will turn the status bar to red. The line will blink periodically to attract attention. Also, if there are unqualified alerts, an audible alert will be issued every 15 seconds. 
  
-{{::alerts_in_status_bar.png?direct&800|}}+{{network:alerts_in_status_bar.png?direct&800|}}
  
 To view the current alerts, you can click on the text with the alerts in the status line. This will open a pop-up window with a list of current crashes. In this window you can see their list, the time of the occurrence of the alert, acknowledge the alert, see the login of the user who acknowledged the alert. To view the current alerts, you can click on the text with the alerts in the status line. This will open a pop-up window with a list of current crashes. In this window you can see their list, the time of the occurrence of the alert, acknowledge the alert, see the login of the user who acknowledged the alert.
  
-{{::alerts_list.png?direct&800|}}+{{network:alerts_list.png?direct&800|}}
  
 Also, using Lua programs, you can perform certain actions depending on the current alerts. For example, you can send SMS messages if there are alerts that have not been acknowledged for more than 10 minutes. Or any other action. An example of handling an alert list is [[http://docs.webhmi.com.ua/scripts#getcurrentalerts | here]] Also, using Lua programs, you can perform certain actions depending on the current alerts. For example, you can send SMS messages if there are alerts that have not been acknowledged for more than 10 minutes. Or any other action. An example of handling an alert list is [[http://docs.webhmi.com.ua/scripts#getcurrentalerts | here]]
Line 24: Line 105:
 Past alerts can be viewed in the alert log. Past alerts can be viewed in the alert log.
  
-{{::alert_log.png?direct&800|}}+{{network:alert_log.png?direct&800|}}
  
  
alerts.1533544623.txt.gz · Last modified: 2018/08/06 08:37 by emozolyak
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki