Skip to main content

Link

- PI Vision Widget -​

Revision History​
Revision No.DateAuthorDocument IDDescription of changes
9.2June 2025RSEW_Link_v9.2_en.docAdded select REST provider
9.1May 2025RSEW_Link_v9.1_en.docAdded feature Get Support
9.0March 2025ALEW_Link_v9.1_en.docCompatibility with PIVision 2024 and new widget style introduced
8.0August 2023DCEW_Link_v8.0_en.docCompatibility with PI Vision 2023
7.1February 2023MDCEW_Link_v7.1_en.docAsset management in configuration
7.0August 2022AMEW_Link_v7.0_en.docCompatibility with PI Vision 2022
6.1November 2021MDCEW_Link_v6.1_en.docBugFix
6.0October 2021MDCEW_Link_v6.0_en.docCompatibility with PI Vision 2021
4.7October 2021MDCEW_Link_v4.7_en.docIframe background color
4.6September 2021MDCEW_Link_v4.6_en.docBugFix
4.5August 2021MDCEW_Link_v4.5_en.docBugFix
4.4August 2021MDCEW_Link_v4.4_en.docMultiple I-frame management
4.3January 2021MDCEW_Link_v4.3_en.docBugFix and change settings button
4.2December 2020MDCEW_Link_v4.2_en.docBugFix
4.1November 2020MDCEW_Link_v4.1_en.docBugFix
4.0October 2020OSEW_Link_v4.0_en.docCompatibility with PI Vision 2020
2.5.1August 2020VSEW_Link_v2.5.1_en.docReview
2.5January 2020PCEW_Link_v2.5_en.docBugFix
2.4January 2020PCEW_Link_v2.4_en.docBugFix
2.3November 2019PCEW_Link_v2.3_en.docBugFix
2.2November 2019PCEW_Link_v2.2_en.docExpiration date
2.1March 2019GIEW_Link_v2.1_en.docReview
2.1October 2018GTEW_Link_v.7.0_en.docDocumentation restyling
2.0.1January 2018PCTQS_Link_v.2.0.1_en.docxReview
2.0November 2017GTTQS_Link_v.2.0_en.docxWidget configuration restyling; Installation procedure modification
1.0September 2017GTTQS_Link_v.1.0_en.docxFirst version
Document References​
DocumentDescription
PI Vision Installation and Administration GuidePI Vision™ user manual from AVEVA
EW Tree EventEW Tree Event widget functioning guide

Introduction​

The EW_Link widget allows you to display a web page within a PI Vision display as a container.

PI Vision from AVEVA, available since 2017, enables viewing real-time data from the PI Data Archive and asset-organized data from the AVEVA Asset Framework (PI-AF).
To access PI Vision, navigate to: https://webServer/PIVision (replace webServer with the correct server name).

The widget supports the most recent HTML5-compatible browsers on computers, tablets, and smartphones running Android and iOS.
Configuration in PI Vision is intuitive, featuring 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
PI-AFPI Asset Framework

Operating Principles And Use​

To insert the Link widget in a PI Vision display, first select the control icon, then choose the elements to be displayed, and finally drag them into the display.

Figure 1 - Link​

When the mouse button is released, the displayed widget is ready for configuration.

Figure 2: Widget included in the display​

To access further customization and configuration, right-click the widget symbol to open the context menu.

Figure 3: Context Menu​

Functionality and use​

The widget integrates a web page within a PI Vision display. The page can be:

  • Specified directly as a fixed URL in the widget,
  • Provided via an element's attribute (using a string type and URIBuilder data reference), or
  • Defined through cooperation with the EW Tree Event widget (in which case, do not select "Get link from attribute").

Customization and configuration​

The widget configuration allows changes in appearance such as colors, text size, and display language.

Language​

Select the language for labels and configuration parameters in the "Language" section.

Figure 4: Language selection​

URL​

The URL property defines the address of the web page to open.
You have three alternatives to specify the URL:

  1. Directly enter it in the URL property.
  2. Enter it in an element’s attribute.
  3. Use the EW Tree Event widget for cooperation.

Figure 6: Indication on the URL to open​

Cooperation with EW Tree Event​

When using the EW Tree Event widget, specify the element (which must contain a string attribute with the web page address).
This attribute name is set in the widget configuration.

Figure 7: Cooperation with EW Tree Event​

Refresh​

Enable "Refresh/Update" to refresh the page automatically.
Set the update interval (in seconds) for automatic refreshes.

Figure 8: Settings on page refresh​

Exclusion Table​

If defined, the widget verifies whether the logged-in user is permitted to view it by checking a database table.
If a row exists with "Widgets" equal to EW_Link and the "User" field matching the logged-in username, the widget will not display.

Figure 9: Table exclusion​

Button Position​

Choose the placement of the configuration button within the widget.

Figure 10: Button position​

Server WebAPI​

Enter the name of the Web Server where the WebAPI is installed if it differs from the PI Vision server.

Figure 11: Server WebAPI​

REST Provider​

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

Figure 12 - REST Provider selection​

Assets​

List the attributes dragged into the display to create the widget.
If multiple assets exist, you can remove an asset by clicking its associated symbol.

Figure 13: Assets Section​

Widget Colors​

Customize the widget’s colors, including the iframe background color.

Figure 14: Widget colors​

To set a color:

  • Select the color drop-down menu.
  • Choose a color gradation using the first horizontal scrollbar.
  • Pick a point on the color palette.
  • Set the transparency level with the second horizontal scrollbar.
  • Confirm by clicking the designated button.

Figure 15: Color choice​

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 16: Contacts​

Installation​

Follow the steps below for installation requirements and procedures.

Prerequisites​

The minimum installation requirements are as follows:

SoftwareVersionNote
PI Vision2024(*)Requirements are related to the correct functioning of the PI Vision *(This widget is also compatible with PI Vision 2023, 2022, 2021, 2020, and 2019.)*
Table 1 - Installation prerequisites​

It is recommended to use Google Chrome for full compatibility with the widget.

Installation procedure​

  1. Copy Files:
    Copy the following files into the folder:
    ..\PIPC\PIVision\Scripts\app\editor\symbols\ext

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

  2. Copy Folders:
    In the folder ..\PIPC\PIVision\Public, copy the following folders:

    • Images: Contains the control icon TQSLink.png
    • Libs: Contains the libraries (e.g., EWClasses.js)

  3. Additional Configuration for PI Vision 2020:
    If the installed version of PI Vision is 2020, add the following line within the <appsettings> section of web.config:

<add key="FrameSrcPolicy" value="*" />

Save the file and restart the IIS.

Additional notes for the use of the product​

The widget can be used in stand-alone mode or in conjunction with the EW_TreeEvent. In the first case, no additional configuration is needed as the information is entered at the widget configuration level.
Otherwise, it is possible to indicate an attribute in the link to be opened and in this case to move from one page to another, you must configure in the elements a dedicated attribute.
The attribute name is displayed in the widget configuration level.

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.