Label
- PI Vision Widget -
Revision History
| Revision No. | Date | Author | Document ID | Description of changes |
|---|---|---|---|---|
| 9.0 | July 2025 | RS | EW_Label_v.9.0_en.docx | -Compatibility PIVision 2024 -Added Get support-Added rest provider -Graphic restyle |
| 8.2 | March 2024 | MDC | EW_Label_v.8.2_en.docx | BugFix |
| 8.1 | December 2023 | MDC | EW_Label_v.8.1_en.docx | Management of string values, enum sets and datetimes |
| 8.0 | August 2023 | FM | EW_Label_v.8.0_en.docx | Compatibility PIVision 2023 |
| 7.2 | January 2023 | AR | EW_Label_v.7.2_en.docx | Add of Time Management feature to choose the time reference for the value displayed. |
| 7.1 | December 2022 | MDC | EW_Label_v.7.1_en.docx | New assets visualization available |
| 7.0 | August 2022 | AM | EW_Label_v.7.0_en.docx | Compatibility PIVision 2022 |
| 6.0 | October 2021 | MDC | EW_Label_v.6.0_en.docx | Compatibility PIVision 2021 |
| 4.0 | October 2020 | OS | EW_Label_v.4.0_en.docx | Compatibility PIVision 2020 |
| 1.0 | August 2020 | OS | EW_Label_v.1.0_en.docx | First review |
Document References
| Document | Description |
|---|---|
| PI Vision Installation and Administration Guide | PI Vision™ user manual from AVEVA |
Introduction
The widget Label allows you to view the numeric value or the string of an attribute, it is an evolution of the “Value” object (std OSI) as it allows you to add a title, to format the lines and the font differently.
Figure 1 - Label widget as evolution of PI Vision’s Value widget
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 |
|---|---|
| AF | Asset Framework |
Operating Principles And Use
To insert the widget Label 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.
The figure below shows the icon:
Figure 2 - PI Vision Menu
By releasing the mouse button, the display widget is ready to be configured.
Later, by recalling the context menu with the right mouse button, customizations and configurations are possible.
Figure 3 - Context Menu
Functionality and use
Once inserted and defined, the widget is present in the display.
The functionality of the widget is to return the value of the selected attribute at a specified time.
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 4 - Language selection
Configurations
Figure 5 - Configurations
| Setting | Description |
|---|---|
| Server Web API | Textual input for the path of the server webAPI. |
| Show path | Show/hide path of the attribute. |
| Show label | Show/hide label of the attribute. |
| Show time stamp | Show/hide time stamp of the attribute. |
| Show UOM | Show/hide units of measure of the attribute. |
| Number of decimals | The number of decimals to show. |
| Time range management | It allows you to choose the reference timestamp at which the value is taken. (more info below) |
| REST Provider | Allows the user to select between default or custom protocol for api requests. |
Table 1 - Configurations description
Time range management
There are 4 different working modes for the time management:
- Fixed time;
- Start time display;
- End time display;
- Custom period;
Figure 6 - Time range management
Figure 7 - Fixed time
Figure 8 - Custom period
Appearance Settings
In the Appearance settings section it is possible to change the value and color of:
- Title;
- Text color;
- Title size;
- Path size;
- Label size;
- Time stamp size;
- Font style;
- Background color;
- Path color;
- Label color;
- Time stamp 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-EWLabel.js
- sym-EWLabel-config.html
- sym-EWLabel-template.html
and in the folder ..\PIPC\PIVision\Public the following folders:
- Images that contains the control icon:
- EWLabel.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 12).
Save the file and restart the IIS.
Figure 12 - web.config
In order to use custom fonts it is mandatory to modify the folder that you can find at ..\Program files\PIPC\PIVision\Public\Font and add the .ttf file of the desired font. The name you give to the file has to be the same as the one you use in the PI Vision dashboard to call the font.
Figure 13 - Font files (.ttf) location
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.