Alarm Table
- PI Vision Widget -
Revision History
| Revision No. | Date | Author | Document ID | Description of changes |
|---|---|---|---|---|
| 9.0 | July 2025 | RS | EW_AlarmTable_v.9.0_en.doc | -Compatibility PIVision 2024 -Added Get support-Added rest provider -Graphic restyle |
| 8.0 | August 2023 | FP | EW_AlarmTable_v.8.0_en.doc | Compatibility PIVision 2023 |
| 7.0 | August 2022 | AM | EW_AlarmTable_v.7.0_en.doc | Compatibility PIVision 2022 |
| 6.0 | October 2021 | MDC | EW_AlarmTable_v.6.0_en.doc | Compatibility PIVision 2021 |
| 4.0 | October 2020 | OS | EW_AlarmTable_v.4.0_en.doc | Compatibility PIVision 2020 |
| 2.2 | October 2018 | GT | EW_AlarmTable_v.2.2.doc | Document restyle |
| 2.1 | December 2017 | PC | TQS_AlarmTable_v.2.1.doc | Review and change information about the interaction with the Gantt widget |
| 2.0.1 | November 2017 | BA | EW_AlarmTable_v.2.0.1_en.doc | Review |
| 2.0* | November 2017 | GI | EW_AlarmTable_v.2.0.doc | Manual Revision * change of revision number for alignment with Widget version |
| 2.0 | November 2017 | GT | TQS_AlarmTable_v.2.0.doc | Restyle widget configuration Change installation procedure |
| 1.0 | September 2017 | GT | TQS_AlarmTable_v.1.0.docx | First review |
Document References
| Document | Description |
|---|---|
| PI Vision Installation and Administration Guide | PI Vision™ user manual from AVEVA |
| EW_Gantt | Gantt widget user manual |
| EW_TreeEvent | TreeEvent widget user manual |
Introduction
Alarm Table widget for PI Vision allows the display of the AF elements associated with alarms and the display of data relating to its sub-elements. Also, combined with the Gantt widget, shows the Event Frames related to the selected item.
Figure 1 - Alarm Table
The PI Vision of AVEVA is available from 2017 and allows viewing real-time data from PI Data Archive and data organized in assets from the AVEVA Asset Framework (PI-AF). In order to achieve PI Vision displays, simply access https://webServer/PIVision (indicating the correct name of the webserver machine).
The most recent versions of most HTML5 compatible browsers are supported on computers, tablets and phones running Android and iOS.
In PI Vision the configuration of the elements is quite intuitive and is characterized by a simple drag-and-drop of the control into the display.
Definitions, Acronyms And Abbreviations
Acronyms and definitions that are used in the current manual are listed below.
| Term | Definition |
|---|---|
| EF | Event Frame |
| AF | Asset Framework |
Operating Principles And Use
To insert the Alarm Table, select the corresponding icon and navigate to the asset that you want to view to proceed with the drag in the display area.
Figure 2 - PI Vision Menu
When the mouse is dragged, a table populated with pre-selected data is displayed; from here you can proceed to the configuration of the widget to get the final display.
Later, calling the context menu with the right mouse button, customizations and configurations are possible.
Figure 3 - Contextual Menu
Functionality and use
The Alarm Table is divided into two sections:
- The first is relative to the selected element;
- The second one is related to all the sub-elements of the selected element that contain the Alarm attribute.
The columns of the table indicate:
- The alarm status:
- Red if the number of alarms is greater than zero;
- Green if the number of alarms is equal to zero;
- Black if the corresponding attribute is not found
- The description of the element,
- The timestamp,
- The value of the attribute that indicates the number of signals in alarm.
Figure 4 - Pi Vision Page
The Alarm Table widget allows you to pass a selected element as a parameter to the Gantt Widget and vice versa. In this way, in the Gantt Widget it will be possible to display the EF related to that element, as shown in Figure 5.
Figure 5 - Gantt Navigation from Alarm Table
Customization and configuration
The widget configuration allows to change the appearance in terms of colours, text size and language visualization.
Language
The section Language allows users to choose the language with which the user visualizes labels and configuration parameters.
Figure 6 - Language selection
Configurations
Figure 7 - Configurations
| Setting | Description |
|---|---|
| Server Web API | Textual input for the path of the server webAPI. |
| Monitored Attribute | The Monitored Attribute section indicates the name of the element attribute with the information to be displayed in the table. |
| Element Name | Show/hide the name of the element. |
| REST Provider | Allows the user to select between default or custom protocol for api requests. |
Table 1 - Configurations description
Monitored Attribute
The Monitored Attribute section indicates the name of the element attribute with the information to be displayed in the table.
The attribute, of integer numeric type and representing the number of signals in the alarm, must be configured in the AF elements whose alarms you want to display. In order to view the timestamp in the AlarmTable widget in PI Vision, the attribute in AF must be associated with a PI point. Furthermore, in AF, the alarm attribute of the parent element must represent the sum of the alarm attributes of the child elements.
Figure 8 – Monitored attribute
Appearance Settings
In the Appearance settings section it is possible to change the value and color of:
- Title;
- Title color;
- Text size;
- Table max height;
- Background color;
- Table header background color;
- Table header text color;
- Table background color;
- Table text color;
Figure 9 - Appearance settings
Colors selection
To configure the different colors simply select the color drop-down menu and choose the gradation on the first horizontal scrollbar, the possible point of the color palette and indicate with the second horizontal scrollbar the eventual transparency level. To confirm, select the button
.
Figure 10 - Choice of color
Contacts
Get Support button (read Get Support documentation)
Link to e-matica.com (click on the icon)
Link to widget online documentation (click on link)
Figure 11 - Contacts
Installation
Following are the installation requirements and procedure.
Requirements
In order to install the product, minimum requirements are listed in the table below:
| Software | Version | Note |
|---|---|---|
| PI Vision | 2024 (*) | Requirements are linked to the PI Vision correct functioning |
Table 2 - Installation prerequisites
(*)This widget is also compatible with PI Vision 2023, 2022, 2021, 2020 and 2019.
We suggest using Google Chrome for full compatibility with the widget.
Installation procedure
The installation procedure involves the copy of different folders and files in the predefined PI Vision path.
In particular it is necessary to copy the following filed in the folder ..\PIPC\PIVision\Scripts\app\editor\symbols\ext:
- sym-TQSAlarmTable.js
- sym-TQSAlarmTable-config.html
- sym-TQSAlarmTable-template.html
and in the folder ..\PIPC\PIVision\Public the following folders:
- Images that contains the control icon:
- TQSAlarmTable.png
- Libs with the libraries used:
- EWClasses.js
Then, open the web.config file inside the PIVision folder (..\PIPC\PIVision) and check that debug is set to "true" (Figure 12).
Save the file and restart the IIS.
Figure 12 - web.config
Additional notes
The Alarm Table works by receiving certain parameters as input; these are passed through the Tree Event widget which must be present in the same display.
The widget itself can be used in cooperation with the Gantt to display the Event Frames associated with the element.
Furthermore, in order to correctly display the widget it is necessary that the AF elements all have a common attribute at each level of the hierarchy.
Notes And References
For more information about Vision PI refer to documentation on AVEVA © portal.
For information about the web service to refer to the specific documentation.
To use the Tree Event, refer to the document EW_TreeEvent.