Skip to main content

Multi Manual Data Entry

- PI Vision Widget -​

Revision History​

Revision No.DateAuthorDocument IDDescription of changes
9.2June 2025RSEW_MultipleManualDataEntry_9.2_en.docAdded select REST provider
9.1May 2025RSEW_MultipleManualDataEntry_9.1_en.docAdded feature Get Support
9.0March 2025ALEW_MultipleManualDataEntry_9.0_en.docCompatibility with PIVision 2024 and new widget style introduced
8.4March 2024MDCEW_MultipleManualDataEntry_8.4_en.docAbility to hide "New value" column
8.3February 2024MDCEW_MultipleManualDataEntry_8.3_en.docBugfix
8.2November 2023MDCEW_MultipleManualDataEntry_8.2_en.docBugfix
8.1November 2023MDCEW_MultipleManualDataEntry_8.1_en.docBugfix
8.0August 2023FMEW_MultipleManualDataEntry_8.0_en.docCompatibility PIVision 2023
7.4June 2023MDCEW_MultipleManualDataEntry_v7.4_en.docUOM visualization
7.3May 2023MDCEW_MultipleManualDataEntry_v7.3_en.docPossibility of not managing milliseconds
7.2February 2023MDCEW_MultipleManualDataEntry_v7.2_en.docBugFix
7.1October 2022MDCEW_MultipleManualDataEntry_v7.1_en.docAsset management in configuration
7.0August 2022AMEW_MultipleManualDataEntry_v7.0_en.docCompatibility PIVision 2022
6.0October 2021MDCEW_MultipleManualDataEntry_v6.0_en.docCompatibility PIVision 2021
4.0October 2020OSEW_MultipleManualDataEntry_v4.0_en.docCompatibility PIVision 2020
2.16October 2020OSEW_MultipleManualDataEntry_v2.16_en.docPossibility to choose the value of an attribute from AF Table
2.15.1August 2020OSEW_MultipleManualDataEntry_v2.15.1_en.docRevision and manual restyling
2.15April 2020MDCEW_MultipleManualDataEntry_v2.15.docWriting on stream and not on attribute
2.14April 2020MDCEW_MultipleManualDataEntry_v2.14.docChange response images; Configurable response icon size;
2.13March 2020MDCEW_MultipleManualDataEntry_v2.13.docBugFix Collections
2.12March 2020MDCEW_MultipleManualDataEntry_v2.12.docInput text size
2.11February 2020PCEW_MultipleManualDataEntry_v2.11.docBugFix
2.10January 2020PCEW_MultipleManualDataEntry_v2.10.docEnlarged input data box; Collection support; Possibility to hide the data field in configuration; Button proportions based on the size of their text; Sensitivity to standard asset switching
2.9December 2019PCEW_MultipleManualDataEntry_v2.9.docBugFix
2.8December 2019PCEW_MultipleManualDataEntry_v2.8.docBugFix
2.7November 2019PCEW_MultipleManualDataEntry_v2.7.docBugFix
2.6October 2019PCEW_MultipleManualDataEntry_v2.6.docSynchronization with the display time; Ability to hide the current value; Ability to hide the name of the attribute; Expiry date support;
2.5September 2019PCEW_MultipleManualDataEntry_v2.5.docReset button with default subattribute; Performance increase
2.4July 2019PCEW_MultipleManualDataEntry_v2.4.doc"+" Character support in the attribute name
2.3June 2019PCEW_MultipleManualDataEntry_v2.3.docBugFix and even multi-language interface
2.1March 2019GIEW_MultipleManualDataEntry_v2.1.docRevision and manual restyling
1.1February 2018GTTQService_MultipleManaualDataEntry_v1.1User Management guide Improved
1.0January 2018GTTQService_MultipleManaualDataEntry_v1.0First version
Document References​
DocumentDescription
PI Vision Installation and Administration GuidePI Vision™ user manual from AVEVA

Introduction​

The Multiple Manual Data Entry (MMDE) widget allows users to enter, via a PI Vision web page, a new value in an AF attribute and possibly perform a recalculation analysis, calling up a dedicated Web Service.

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.

TermDefinition

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 involved by the Manual Input in the display area.

Figure 1 - PI Vision Menu​

Then by selecting the contextual menu you can access the specific configuration of the widget.

Figure 2 - Contextual Menu​

Functionality and use​

Widget use is very intuitive. On a PI Vision display it shows a form containing:

  • 3 cells corresponding to:
    • The Current Value displayed and not editable
    • The New Value, editable, for the insertion of the new value
    • The Date and Time, editable, for the insertion of the date and time of the new value
  • confirmation input button
  • enable recalculation button (visible only if the user configures the web service recalculation)

Figure 3 - Widget Data Entry​

Inserting value in AF​

In the row labeled New Value, the user can specify the new value of each of the attributes displayed in the widget.

Once the compilation is completed, the confirmation button writes in AF. If the attribute is configured with PIPoint data reference and ReadOnly flag = False, writing is also performed on the tag.

Recalculation​

If the widget is also configured for recalculation using web services, another button is displayed next to the previous one, to enable recalculation with the configuration of additional parameters.

Figure 4 - Enable button Recalc​

You can specify the recalculation start/end interval either by filling in the field manually or by using the calendar and clock buttons located next to the editable labels.

Figure 5 - Enabling Recalc​

The execution of the recalculation takes place only when the user proceeds with the confirmation using the appropriate button. Otherwise, it is possible to leave the activity with the Cancel button.

Customization and configuration​

The widget configuration allows you to change the look in terms of colors, text size, and display language.

Language​

The section International allows users to choose the language with which the user visualizes labels and configuration parameters.

Figure 6 - Language selection​

Enabling the Web Service methods for recalculation of analysis​

If the attribute is involved in an AF analysis, it is possible to use the same interface to enter values and also to launch the recalculation of the AF analysis. In this case, it is sufficient to fill in the field with the indication of the web service. In case WS mode is chosen to allow the system to recalculate the analysis associated with the element, it is necessary to indicate the name of the web service to be retrieved from the widget.

Figure 7 - Name WebServer​

The element on which is searched for the analysis is shown in the Target Element section.

Figure 8 - Target element​

The following choices are possible:

SettingDescription
CurrentThe analysis refers to the current element
ParentThe analysis refers to the parent
EmptyAn indication of the element is not sent to the WS but only the analysis
BrothersThe analysis refers to the current element and all those who are descended from the same father

These strings will be displayed in the widget.

Figure 9 - View the widget​

Configurations​

Figure 10 - Configurations panel​

Exclusion table​

If defined, the widget checks in the database if the logged-in user has the rights to view the widget (if there is a row in the table with the Widget field equal to EW_MultiManualDataEntry and the User field equal to the name of the logged-in user, this user will not be able to view the widget);

Figure 11 - Table Exclusion​

Showing User Interface Data​

Users can choose what to display in the manual input user interface: the name of the attribute or its description.

Figure 12 - Choice of attribute label​

Settings​

  • Show date allows to hide/display the date indicating the time with which the change will be made.
  • Input with milliseconds allows you to choose the milliseconds for entering the value.

Figure 13 - Show date option​

By selecting "show date" the date will be displayed, otherwise the time will be written at the end time of the display.

SettingsDescription
Show dataAllows you to hide/display the date indicating the time with which the change will be made
Table 1 - Settings​

Number of decimals​

It is possible to indicate the number of decimals to be displayed in the Number of decimals section.

Figure 14 - Choosing the number of decimals​

Indication of the analysis to be recalculated​

Enter the name of the analysis template to recalculate. It is also possible to specify multiple analyses separating the names with the character ";".

Figure 15 - Analysis Name​

The analysis must be present and configured as shown in the figure below.

Figure 16 - Analysis of which it is carried out recalculation​

Indication of element and attribute​

It is possible to customize the header text and table data row in Sections Element Title Name and Attribute Title Name:

Figure 17 - Customizing table​

Show values and default​

Toggles that allow the user to show/hide current value, new value and attribute default

Figure 18 - Current, new and default value toggle​

Attr. default name​

The name of the sub element containing the default value of the attribute

Figure 19 - Attr. default name​

REST Provider​

Allows the user to select between default or custom protocol for api requests.

Figure 20 - REST Provider selection​

Attributes List​

It is possible to indicate which attributes display simply by setting a flag in the Attributes section Attributes to show.

Figure 21 - Attribute Selection​

Acting on the arrows on the right the user can also customize the ordering of the attributes in the user interface display.

In the Attributes to show section, users can enter the name of the child-attribute containing the default value of the attribute to be displayed in the new value field. After entering the name of the attribute, the symbol will appear next to the new value field. By clicking it, the default value will appear.

Figure 22 - Child-attribute Default value​

Title​

The title of the widget can be changed by indicating any string in the Title section. Selecting the Show heading item, the complete path of the element is shown below the title of the widget.

Figure 23 - Customize the title​

Text Size​

You can indicate the size of the widget tests in the Text Size section.

Figure 24 - Text Size​

Text size input​

You can indicate the size of the input text in the Text size input section.

Figure 25 - Text size input​

Response size​

You can indicate the size of the response icon in the Response size section.

Figure 26 - Response size​

Button text size​

You can indicate the size of the button text widget tests in the Button text size section.

Figure 27 - Button text size​

Assets​

List of attributes dragged into the display to create the widget. If there are more than one, it is possible to delete an asset by clicking on the symbol.

Figure 28 - Assets Section​

Colors Widget​

Customize the widget’s colors including:

  • Title color
  • Background color
  • Header text color
  • Table text color
  • Table header background
  • Table background

As shown in the table below.

​
Figure 29 – Customize the Widget Color​

To configure the color 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 “APPLY”.

​
Figure 30 – Choice of Color​

Extensions Folder​

It is possible to define extensions for customizing the widget (in this field it should type the name of the folder that contains the extensions to the path PIVision \Public \Libs.

Figure 31 - Extensions Folder​

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 32 - Contacts​

Installation​

Following are the installation requirements and procedure.

Requirements​

In order to install the product, minimum requirements are listed in the table below:

​

SoftwareVersionNote
PI Vision2024 (*)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 files in the folder ..\PIPC\PIVision\Scripts\app\editor\symbols\ext:

  • sym-TQSMultiManualDataEntry.js
  • sym-TQSMultiManualDataEntry-config.html
  • sym-TQSMultiManualDataEntry-template.html

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

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

Figure 33 - Web.config​

WebService Installation​

If the widget needs to perform backfill analysis, a dedicated WebService must be installed. Follow these steps:

  1. Copy the contents of the WebService disk (for example, to C:\Dev\CartellaWebService).

  2. Start Internet Information Services (IIS).

    ​
    Figure 34 – IIS​

  3. On the DefaultWebSite, right-click and select Add Application….

    ​
    Figure 35 – IIS: Add Application​

  4. Enter the alias and the physical path (as shown in the following figure), then click OK to confirm.

    ​
    Figure 36 – IIS: Form Add Application​

The chosen alias is used in the widget configuration (for example, Https://PIVisionServerIP/NomeWS/WSMethods.asmx).

Additional Notes for Use​

For the widget to operate correctly, make the following changes in the Vision IP configuration database:

  • Disable CSRF:
    Set the EnableCSRF attribute to FALSE.

  • Enable PUT and POST Methods:
    In the Cors Methods attribute, ensure that PUT and POST are included, separated by commas.

Steps to Adjust Settings:

  1. Connect to the Configuration Database using PI System Explorer.

  2. Expand the OSIsoft element, then expand the PI element WEB API.

  3. Under the PI element Vision-srv, select the System Configuration element.

  4. Edit the Cors Methods attribute (add PUT and POST if not present) and set EnableCSRF to FALSE.

    Figure 37 – Configuration Database​

Finally, restart the PI Web API service.

​
Figure 38 – Restart PI API Web Service​

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.