Skip to main content

Insert Event

- PI Vision Widget -​

Revision History​

Revision No.DateAuthorDocument IDDescription of changes
9.3November 2025RSEW_InsertEvent_9.3_en.docChoosing an event from Event Table will not show name and description on the Insert Event widget
9.2June 2025RSEW_InsertEvent_9.2_en.docAdded select REST provider
9.1May 2025RSEW_InsertEvent_9.1_en.docAdded feature Get Support
9.0March 2025IDEW_InsertEvent_9.0_en.docCompatibility PI Vision 2024 and introduced new widget style
8.2November 2023MDCEW_InsertEvent_8.2_en.docEdit calls with external PIWebAPI
8.1October 2023MDCEW_InsertEvent_8.1_en.docAdded field to enter external PIWebAPI
8.0August 2023MDCEW_InsertEvent_8.0_en.docCompatibility PIVision 2023
7.1September 2022CCEW_InsertEvent_7.1_en.docAdd custom configuration
7.0August 2022AMEW_InsertEvent_7.0_en.docCompatibility PIVision 2022
6.1May 2022MDCEW_InsertEvent_6.1_en.docWriting completed message inserted
6.0October 2021MDCEW_InsertEvent_6.0_en.docCompatibility PIVision 2021
4.0October 2020OSEW_InsertEvent_4.0_en.docCompatibility PIVision 2020
2.2.1August 2020BAEW_InsertEvent_2.2.1_en.docReview
2.2November 2019PCEW_InsertEvent_2.3.docBugFix
2.1November 2019PCEW_InsertEvent_2.2.docExpiration date
2.0 *March 2019GIEW_InsertEvent_2.1.docRestyling review * Review of the modified N. in order to align it with the version number of the Widget
2.1December 2018PCTQS_InsertEvent_2.1.docReview, adding and editing user comments
2.0November 2017GTTQS_InsertEvent_2.0.docWidget configuration restyling Installation procedure modification
1.0September 2017GTTQS_InsertEvent_1.0.docFirst release documentation

Document References​

DocumentDescription
PI Vision Installation and Administration GuidePI Vision™ user manual from AVEVA
EW_TreeEventEW_TreeEvent widget user manual
EW_EventTableEW_EventTable widget user manual

Introduction​

EW Insert Event widget allows users to enter and close the event frame using a graphical interface within PI Vision.

The parameters for its population are passed by the widget Tree Event: database, template, range, and unit.

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 to 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
EFEvent Frame

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 Advanced Manual Entry in the display area.

Figure 1 - PI Vision Menu​

When the mouse is released the widget is positioned and must be customized.

Figure 2 - Widget​

For customization, the contextual menu should be selected with the right mouse button and then select the configure form item*.*

Figure 3 - Context Menu​

Once installed and configured the widget it is possible to control display as explained in the next chapter.

Functionality and use​

Inserting and editing of the Event Frame​

To insert a new event frame, select the widget Tree Event, then the reference element on which it is desired to associate the event frame (1).

After selecting the item, fill out the fields in the widget information with the Start Time/Inizio and the eventual Comment.

To compile the timestamp select the appropriate icon for the date and time and then proceed to the creation with the START button (2).

Figure 4 - Entering a new Event Frame: step 1​

Once saved, the event frame could be displayed with the widget Event Table and, if one of the rows is selected, the input mask is repopulated with the information.

Figure 5 - Closing Event Frame: step 2​

To proceed with closing it, it is sufficient to indicate the timestamp of the end of the event frame and click on the End Time/Fine button. Furthermore, before closing the Event Frame, it will be possible to modify the comment.

The Clean/Pulisci button is used to delete the contents of the fields if you want to proceed with a new entry.

Customization and configuration​

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

Language​

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

Figure 6 - Language selection​

Event Frame Template​

To create a new event frame, it must provide its template; in the section Event Frame Template Name**,** it is sufficient to indicate the name of the template.

Figure 7 - Template Indication​

Below is an example of the Event Frame template.

Figure 8 - Template Event Frame​

It is important that the two string attributes for Comment and User are defined in the Event Frame Templates in AF, as shown in Figure 8.

REST Provider​

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

Figure 9 - REST Provider selection​

Settings​

  • Enumerator Sets: Permit to associate enumeration set value and string attribute;
  • Attribute category: allows to enhance a set of editable attributes of the event frame;
  • Comment attribute: Define the attribute where you can write the comment;
  • User attribute: Define the attribute where you can write the user;
  • Severity: It’s possible add to event frame the severity;
  • Custom name event frame: It’s possible modify the name of saved event frame:
    • Prefix: It’s possible add one prefix at the event frame name;
    • Element name: It’s possible add the element name in the event frame name;
    • Start time: It’s possible add the time and date in the event frame name;
  • Description: It’s possible modify the event frame description;
    • Element template name: It’s possible add the element template name at the description of event frame;
    • User: It’s possible add the user at the description of event frame;

Figure 10 - Settings​

Offset​

This option is used to add an offset to the starting date and ending date of the event frame data (in minutes).

Figure 11 - Offset​

Text Size​

In addition to that, it is also possible to customize the text font size, selecting the pixels in the combo section Text Size

Figure 12 - Customize the text size​

Colors widget​

It is possible to customize the colors of the widget in terms of:

  • Background;
  • Text of the table;
  • Background of the table.

as shown in the figure below.

Figure 13 - Color Customization​

In order to configure the colour, it is enough to select the colour drop-down menu and choose the gradation on the first horizontal scrollbar, the potential point on the colour palette and indicate through the second horizontal scrollbar the level of transparency. Confirm with the button .

Figure 14 - 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 15 - 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 1 - 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-TQSInsertEvent.js;
  • sym-TQSInsertEvent-config.html;
  • sym-TQSInsertEvent-template.html;

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

  • Images which contains the control icon:
    • TQSInsertEvent.png;

Additional notes for the use of the product​

For proper operation of the widget must disable the Cross-Site Request Forgery (CSRF) and explicitly enable the PUT and POST methods in the PI Vision 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.

Figure 16 - Configuration Database​

After these procedures, the PI Web API service needs to be restarted.

Figure 17 - 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.

For the use of the Tree Event and the Event Table refer to the specific documents EW_TreeEvent and EW_EventTable.