Switch
- PI Vision Widget -
Revision History
| Revision No. | Date | Author | Document ID | Description of changes |
|---|---|---|---|---|
| 9.0 | June 2025 | RS | EW_Switch_v9.0 | -Compatibility PIVision 2024 -Added Get support-Added rest provider -Graphic restyle |
| 8.0 | August 2023 | DC | EW_Switch_v8.0 | Compatibility PIVision 2023 |
| 7.0 | August 2022 | AM | EW_Switch_v7.0 | Compatibility PIVision 2022 |
| 6.1 | June 2022 | MDC | EW_Switch_v6.1 | Label and background size changes |
| 6.0 | December 2021 | MDC | EW_Switch_v6.0 | First version |
Document References
| Document | Description |
|---|---|
| PI Vision Installation and Administration Guide | PI Vision™ user manual from AVEVA |
Introduction
The Switch widget allows you to change the value of a Boolean tag/attribute directly from the PIVision.
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 widget, select the corresponding icon and navigate to the asset to be displayed and drag all the attributes in the display area.
Figure 1 - PI Vision Menu
When the mouse is released, the widget symbol appears, which, when clicked, displays the dragged Boolean tags / attributes.
Figure 2 - EW Switch
By clicking on the switch button it is possible to change the value of the boolean tag:
Figure 3 - Edit boolean tag / attribute value
It is possible to display a confirmation question (with customizable text in the widget configuration) before changing the value:
Figure 4 – Confirmation question
By selecting the context menu with right click, it is possible to access to the widget configuration box:
Figure 5 - Contextual Menu
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 |
|---|---|
| **Element | Attribute label** |
| Clear Labels | Allows the user to clear all the labels. |
| Show Description | Show/hide the description of the attribute. |
| Element Name | Show the name of the element. |
| Need confirm | Show/hide the confirm box when changing attribute value. |
| Confirm question | The question when the confirm box appears. |
| Confirm button | The name of the confirm button. |
| Cancel button | The name of the cancel button. |
| 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 size;
- Background width;
- Background height;
- Text color;
- Background color;
- Switch on color;
- Switch off color;
- Switch color;
- Open/close color;
- Confirm box text color;
- Confirm box background color;
- Confirm box confirm button color;
- Confirm box cancel button color;
Figure 8 - 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 9 - 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 10 - 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-EWSwitch.js
- sym-EWSwitch-config.html
- sym-EWSwitch-template.html
and in the folder ..\PIPC\PIVision\Public the following folders:
- Images that contains the control icon:
- EWSwitch.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 11).
Save the file and restart the IIS.
Figure 11 - web.config
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.