Spin Value

- PI Vision Widget -

Revision History

Revision No.	Date	Author	Document ID	Description of changes
9.0	July 2025	RS	EW_SpinValue_v9.0_en.doc	-Compatibility PIVision 2024 -Added Get support-Added rest provider -Graphic restyle
8.0	August 2023	DC	EW_SpinValue_v8.0_en.doc	Compatibility PIVision 2023
7.0	August 2022	AM	EW_SpinValue_v7.0_en.doc	Compatibility PIVision 2022
6.0	October 2021	MDC	EW_SpinValue_v6.0_en.doc	Compatibility PIVision 2021
4.0	October 2020	OS	EW_SpinValue_v4.0_en.doc	Compatibility PIVision 2020
1.3.1	August 2020	OS	EW_SpinValue_v1.3.1_en.doc	First review

Document References

Document	Description
PI Vision Installation and Administration Guide	PI Vision™ user manual from AVEVA

Introduction

The widget SpinValue allows you to view and modify the numerical value of an AF Attribute.

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 Operating Procedures 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 - Spin Value Widget

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 2 - Context Menu

Functionality and use

To use the widget, the AF attribute must have a sub-attribute called Default that allows you to reset its value.
Once the configuration has been performed the widget appears as in the figure:

Figure 3 - Sample configured Widgets

The buttons on the sides are used to decrease or increase the value of the selected attribute. The reset button to return the attribute value to its default.

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 reset button	Show/hide the reset button.
Modify step	The widget buttons modify the attribute value by subtracting or adding this value.
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;
• Error text dimensions;
• Buttons size;
• Background color;
• Text color;
• Buttons color;
• Done button color;
• Error button color;
• Error message background color;
• Error message text color;

Figure 6 - 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 7 - 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 8 - 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-EWSpinValue.js
• sym-EWSpinValue-config.html
• sym-EWSpinValue-template.html

and in the folder ..\PIPC\PIVision\Public the following folders:

• Images that contains the control icon:
  • EWSpinValue.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 9).
Save the file and restart the IIS.

Figure 9 - web.config

Additional notes

For the proper functioning of the widget, it should disable the Cross-Site Request Forgery (CSRF) and explicitly enable PUT e POST methods in the PI Vision configuration database:

• Connect to the Connection database through the PI System Explorer
• Expand the element Osisoft
• Expand the element PI WEB API
• Expand the element PI Vision-srv
• Select the element System Configuration
• Select the attribute Cors Methods and add PUT, POST and BATCH methods separated by commas
• Select the attribute EnableCSRF and set the value to FALSE

Figure 10 - Configuration Database

At the end of the procedure, the PI Web API service has to be restarted.

Figure 11 - PI Web API service restart

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.