Maintenance Data Entry
- PI Vision Widget -
Revision History
| Revision No. | Date | Author | Document ID | Description of changes |
|---|---|---|---|---|
| 9.0 | June 2025 | RS | EW_MaintenanceDataEntry_v9.0_en.doc | -Compatibility PIVision 2024 -Added Get support-Added rest provider -Graphic restyle |
| 8.0 | August 2023 | AM | EW_MaintenanceDataEntry_v8.0_en.doc | Compatibility PIVision 2023 |
| 7.0 | August 2022 | AM | EW_MaintenanceDataEntry_v7.0_en.doc | Compatibility PIVision 2022 |
| 6.0 | October 2021 | MDC | EW_MaintenanceDataEntry_v6.0_en.doc | Compatibility PIVision 2021 |
| 4.0 | October 2020 | OS | EW_MaintenanceDataEntry_v4.0_en.doc | Compatibility PIVision 2020 |
| 1.2.1 | September 2020 | VS | EW_MaintenanceDataEntry_v1.2.1_en.doc | Review |
| 1.1 | April 2019 | GI | EW_MaintenanceDataEntry_v1.1_en.doc | Added display for the historic timestamp |
| 1.0 | March 2019 | GI | EW_MaintenanceDataEntry_v1.0_en.doc | First version |
Document References
| Document | Description |
|---|---|
| PI Vision Installation and Administration Guide | PI Vision™ user manual from AVEVA |
| EW_TreeEvent | TreeEvent widget user manual |
Introduction
The Maintenance Data Entry widget allows you to evaluate an attribute connected to a PI Point and display its history, in addition to displaying the values entered, it is possible to see the corresponding authors, historicized in another PI Point.
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 |
|---|
Operating Principles And Use
To insert the Maintenance Data Entry widget in a PI Vision display it is necessary to first select the control icon, and then the elements to be displayed and then drag them into the display.
Figure 1 - Pi Vision Menu
When the mouse button is released, the displayed widget is ready to be configured.
Later, recalling the context menu with the right mouse button, it is possible to do customizations and configurations.
Figure 2 - Context Menu
Functionality and use
The Widget allows you to write on two attributes which are associated with two PI points.
It is necessary to create two string type attributes (configured in not read only mode) and connect them through DataReference to two string type PI Points created on purpose.
It is necessary to indicate a prefix for the names of the two PI points.
Figure 3 - Attributes
In the figure below it is possible to see an example of configured Widget.
Figure 4 - Sample configured Widgets
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 5 - Language selection
Configurations
Figure 6 - Configurations
| Setting | Description |
|---|---|
| TreeView Interaction | Make the widget interact or not with the TreeView widget. |
| Prefix | The prefix of the attribute the user wants enhanced. |
| Author | The author of the enhancement. |
| Text | The text of the attribute. |
| REST Provider | Allows the user to select between default or custom protocol for api requests. |
Table 1 - Configurations description
Appearance Settings
In the Appearance settings section it is possible to change the value and color of:
- Title;
- Title color;
- Text size;
- Show heading;
- History height;
- Background color;
- Table header text color;
- Table text color;
- Table header background color;
- Table background color;
Figure 7 - 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 8 - 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 9 - 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-EWMaintenanceDataEntry.js
- sym-EWMaintenanceDataEntry-config.html
- sym-EWMaintenanceDataEntry-template.html
and in the folder ..\PIPC\PIVision\Public the following folders:
- Images that contains the control icon:
- EWMaintenanceDataEntry.png
- Libs with the libraries used:
- EWClasses.js
- moment.js
Then, open the web.config file inside the PIVision folder (..\PIPC\PIVision) and check that debug is set to "true" (Figure 10).
Save the file and restart the IIS.
Figure 10 - web.config
Additional notes
For proper operation of the widget must disable the Cross-Site Request Forgery (CSRF) and explicitly enable the PUT and POST methods in the Vision IP configuration database:
- Connect to the Configuration Database using the PI System Explorer
- Expand the OSIsoft element
- Expand the PI element WEB API
- Expand the PI element Vision-srv
- Select the System Configuration element
- Select the attribute Cors Methods and add if no PUT and POST methods separated by commas
- Select the EnableCSRF attribute and set the value to FALSE
- Select the attribute IgnoreCacheControlForBulkRequests and set the value to TRUE.
If the attributes are not present, you must create them manually.
Figure 11 - Configuration Database
At the end of the procedure you must restart the PI Web API and PI Web API Crawler services.
Figure 12 - Restart PI API Web Services
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.