events
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
events [2020/11/27 11:55] – [Event Condition] emozolyak | events [2022/01/26 09:47] – [Report constructor] emozolyak | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{ network: | ||
====== Events ====== | ====== Events ====== | ||
Line 21: | Line 22: | ||
Setup / Events menu is for adding events into a project. | Setup / Events menu is for adding events into a project. | ||
- | {{ :: | + | {{ network: |
'Add event' button is located in the top-right page corner: | 'Add event' button is located in the top-right page corner: | ||
- | {{ :: | + | {{ network: |
==== Event Basic settings ==== | ==== Event Basic settings ==== | ||
Line 34: | Line 35: | ||
***Parent event** This event recorded only if a high-level, or parent event is running now. I.e. this event nests in a parent event with all its data. | ***Parent event** This event recorded only if a high-level, or parent event is running now. I.e. this event nests in a parent event with all its data. | ||
- | {{ : | + | {{ network: |
=== About parent and child events === | === About parent and child events === | ||
Line 44: | Line 45: | ||
*For child events no report entry will be created in the side menu. | *For child events no report entry will be created in the side menu. | ||
- | {{ :: | + | {{ network: |
==== Event Condition ==== | ==== Event Condition ==== | ||
Line 50: | Line 51: | ||
After a 3.3 version, WebHMI has simpler condition setting - if some register' | After a 3.3 version, WebHMI has simpler condition setting - if some register' | ||
- | {{ :: | + | {{ network: |
Of course, the event conditions sometimes | Of course, the event conditions sometimes | ||
Line 62: | Line 63: | ||
=== Lasting vs. one - shot events === | === Lasting vs. one - shot events === | ||
- | The events may have or do not have duration in time. For lasting events (that is more common application) you set special checkbox. <wrap hi>Has duration in time</ | + | The events may have or do not have duration in time. For lasting events (that is more common application) you set special checkbox <wrap hi>**Has some duration in time**</ |
- | For day, week etc. totals you can latch neccessary data in an one-shot event. For such an event condition must be true for ONLY one scan. Otherwise the records will be added in every scan while event condtion is true. See the [[ events# | + | For day, week etc. totals you can latch neccessary data in an one-shot event. For such an event condition must be true for ONLY one scan. Otherwise the records will be added in every scan while event condtion is true. See the [[ events# |
==== Event Actions ==== | ==== Event Actions ==== | ||
The ' | The ' | ||
- | {{ :: | + | {{ network: |
- | | + | ***Save to report** - enables selecting |
- | | + | |
***Report title** - It is the Report title when it's viewed or accessed from API, etc. | ***Report title** - It is the Report title when it's viewed or accessed from API, etc. | ||
***Menu item name** It is how the ' | ***Menu item name** It is how the ' | ||
- | ***Save data** | + | ***Save data** |
+ | *__Once per Event__ | ||
+ | *__Every X seconds__ . All data will be saved at regular interval, i.e. there will be multiple records with their respective timestamps. This option is used when you want to build a graph based on the event data in [[level2: | ||
- | == Selecting | + | === Selecting |
- | If you press **+Add Register to report**, the following dialog will appear: | + | Besides a common register selection list, there are 3 extra values in the list: |
+ | | ||
+ | | ||
+ | | ||
+ | {{ network:register_selector_with_white_bgnd.png? | ||
- | {{ :: | + | *//Register Ey.x// - Thе Ey.x notation can be used to refer this data in the [[webhmi_internal_registers?s[]=internal&s[]=registers# |
+ | *you can select first value or last, maximal, minival, average. | ||
+ | *For the reigsters with time or duration format set, the format field will be promtped as time format (H:i etc.) | ||
- | It is possible to pick up 4 options: | + | |
- | | + | ***Show on timeline** - the checkbox makes the event to be shown in the timeline viewer. |
- | | + | |
- | | + | |
- | *//Any register from Registers list// - when you select a register from your project, then you can re-type | + | |
- | {{ :: | + | |
- | + | ||
- | The rows of selected register have **Register E1.0, 1.1, ... ** string left to it. These E-registers are indexed from 0 and further in ascending order (**x** is an index), **y** is the event identifier that is assigned | + | |
| | ||
- | **Show on timeline** - If you select this checkbox, you can see evetn on timeline with set color. See below | + | ===== Viewing events data===== |
- | **Add log message** - If you select this checkbox, a message with set priority | + | When there are configured |
- | ===== Viewing events data===== | + | {{ network: |
- | The side bar **Reports** | + | - Report access |
- | {{ :: | + | - __Refresh__, |
+ | - __Calendar__ to pick desired time interval | ||
+ | - __Search__ omnibox | ||
+ | - __Table header__. The columns names are action titles set in //Actions// tab. There are sort arrows as well. | ||
+ | - This is a row with __unfinished__ | ||
+ | - __Highlighted__ event | ||
+ | - Row with normal data. | ||
+ | - Link to the __wrapped (daughter, or nested) event__ | ||
+ | - Link to the event __report__, configured in the Report builder. | ||
- | Since the "Show on timeline" | + | === Highlighting events === |
- | {{ :: | + | You can mark some row in the table (having error, alert etc.). There is a ' |
- | ===== Other event usage options ===== | + | {{ network: |
+ | Then the rows will be highlighted like #7 in the list above. | ||
- | Besides above application, | + | === Calculating column totals === |
- | === Export | + | For the columns of the event view table, you can add totals in the table' |
+ | {{ network: | ||
- | {{ ::download_event_cropped.png? | + | {{ network:totals_example_2.png? |
+ | |||
+ | === Setting up permissions === | ||
+ | |||
+ | You can set permission for the users who may access event view table. | ||
+ | {{ network:permissions_new.png? | ||
+ | |||
+ | ===== Report constructor ===== | ||
+ | |||
+ | There is a report constructor similar to the [[screens? | ||
+ | |||
+ | {{ network: | ||
+ | Like in screen editor, you pick widgets and arrange them on the canvas. | ||
+ | {{ network: | ||
+ | |||
+ | Below notes on the widgets for the report constructor are given: | ||
+ | |||
+ | == Graph widget == | ||
+ | |||
+ | The graph widget is drawn based on the graph __already existing__ in the project. You just pick one of the graph from a list: | ||
+ | {{ network: | ||
+ | For the time range, event start / end times are used. | ||
+ | |||
+ | == Gannt widget == | ||
+ | It's similar to that of the screen widget. You can select only child event as data source for the diagram. | ||
+ | {{ :: | ||
+ | |||
+ | The summary shows duration of all events: | ||
+ | {{ : | ||
+ | |||
+ | == Register value == | ||
+ | |||
+ | Register value widget is similar to that in the screen editor, except for register selection: you can only pick up one of the event' | ||
+ | |||
+ | {{ network: | ||
+ | |||
+ | You can add options to add text label, change font size for both value text and text label, display measurement units and scale: | ||
+ | |||
+ | {{ network: | ||
+ | |||
+ | For a scale, you set start, end point and its color: | ||
+ | {{ network: | ||
+ | |||
+ | If you want the value be centered with the scale, choose __windows centered__ option in the Appearance tab: | ||
+ | |||
+ | {{ network: | ||
+ | |||
+ | Please note that in the edit mode the value is refered to as " | ||
+ | {{ network: | ||
+ | |||
+ | == Values table == | ||
+ | Values table widget is identical to that one in the screen editor except for register selector (only from event' | ||
+ | |||
+ | {{ network: | ||
+ | |||
+ | == Bar char, hystogram, pie chart == | ||
+ | |||
+ | These are identical to the screen editor widgets, except for the register selector. | ||
+ | |||
+ | == Text widget == | ||
+ | It is simple html editor, please refer to the video below. For the actions - you can type action address in the form of Ey.x or use action picker. | ||
+ | |||
+ | {{network: | ||
+ | |||
+ | |||
+ | |||
+ | ===== Other event usage options ===== | ||
+ | |||
+ | Besides above application, | ||
=== Get event data from external applicaion via API === | === Get event data from external applicaion via API === | ||
Line 118: | Line 199: | ||
=== Send event data to Level2 === | === Send event data to Level2 === | ||
- | There is a report builder in the Level2 system as well which uses data taken from WebHMI as a source. More on this [[creating_advanced_reports_in_level2? | + | There is a report builder in the Level2 system as well which uses data taken from WebHMI as a source. More on this [[level2:creating_advanced_reports_in_level2? |
=== Creating a timeline based on time from the event === | === Creating a timeline based on time from the event === | ||
- | === Customized report view on screens and dashboards === | + | When you set __Show |
+ | {{ network: | ||
- | getting historical | + | === Advanced customized reports based on events, screens, lua and api === |
+ | |||
+ | The Report constructor for events may not be convinient in some cases: | ||
+ | *the processes last long time (days, weeks, monthes, years etc) and event logging may be interrupted by some maintenacne or other occastions which is not acceptable (this will split the event) | ||
+ | *you need to generate report which unites | ||
+ | *the system consist of many logical units which would require to make a lot of duplicating reports | ||
+ | |||
+ | In this cases, still a desired report can be obtained from particular events, lua, api and screen/dashboard editor. | ||
+ | You can use the following approach: | ||
+ | *use screen/ | ||
+ | *use lua script which would make api call to webhmi' | ||
+ | *use javascript to change screen widget properites - start / end time for graph, changing parameters etc. | ||
+ | |||
+ | <WRAP center round info 80%> | ||
+ | Please refer to the following application [[events_in_machine_monitoring | note]]. | ||
+ | </ | ||
===== Notes on event usage ===== | ===== Notes on event usage ===== | ||
- | ==== Editing events in the running project | + | === Editing events in the running project === |
- | <WRAP center round important | + | <WRAP center round important |
Due to 'on the fly' method of recordig events, WebHMI project restart will cause an event being recorded to | Due to 'on the fly' method of recordig events, WebHMI project restart will cause an event being recorded to | ||
" | " | ||
Line 137: | Line 234: | ||
- | ==== One - time events | + | === One - time events === |
- | <WRAP center round tip 60%> | + | <WRAP center round tip 80%> |
- | With one-time event, i.e. those not having 'event has duration' | + | With one-time event, i.e. those not having 'event has duration' |
</ | </ | ||
Line 160: | Line 257: | ||
</ | </ | ||
- | ==== Lasting events with different start and end condition | + | === Lasting events with different start and end condition === |
Be carefull with different start and end condition for lasting events. Becuase when they intersect, i.e. end conditino happens while start condition is true, you will get multiple events at once. | Be carefull with different start and end condition for lasting events. Becuase when they intersect, i.e. end conditino happens while start condition is true, you will get multiple events at once. |
events.txt · Last modified: 2024/08/05 13:02 by emozolyak