PI Vision Custom Symbol : MANUAL INPUT

Description

The PI Vision custom symbol Manual Input is a single datasource symbol that allows you to input new values to PI AF attributes and PI tags as well.

At first sight, its look & feel is very similar to the core symbol Value, so it will easily integrate to your existing PI Vision displays :

When the user clicks on the pen icon, the symbol shows an input form :

When the user sends the new value, a feedback message is displayed in the input form :

Demo on YouTube

https://www.youtube.com/watch?v=0c4xImG8MAc

NB : The Manual Input custom symbol is compatible with the asset switching feature (not show in the video).

Features

The Manual Input custom symbol is compatible with any kind of data types :

• Numbers
• Texts
• Digital sets (PI tags) and Enumeration Sets (PI AF attributes) :

  

• Booleans

  

Moreover, this custom symbol is fully compatible with all OSIsoft time expressions, like '*', '*-2d', 't', 'y+8h', which is really useful :

If the time expression is malformed, an error message helps the user to correct the timestamp :

Similarly, if the value type doesn't match the type of the datasource, the symbol displays an error message :

Empty input texts are not allowed for both the "Value" field and the "Timestamp" field.

The "Send Value" button is disabled until both textboxes are filled :

Configuration options

• Visibility (display or not the following items)
  • Label
  • Value
  • Units
  • Manual Input Icon
  • Timestamp
  • Keep Symbol On Top
    This option avoids the input form to be hidden by other symbols in the display (the input form is pushed to the front of the display)
• Style
  • Font size
    • Pre-defined font sizes (8 to 72)

      

    • Custom font size

      

  • Format (Database, General, Number, Scientific)
  • Text alignment
    • Left

      

    • Center

      

    • Right

      

  
  
• Inputs
  • New timestamp default value
    This option allows the user to configure which timestamp is set by default for the new value.
    This can be a time expression, or a format string

    

    

    With the first option, all AVEVA time expressions are supported :
    • *
    • *-1d
    • t-2mo
    • y+6h
    • mon
    • apr
    • etc...
    With the second option, you can for example set the default timestamp at the full hour relatively to current time, with the format string "dd/MM/yyyy HH:00:00".
    
    To be precise : if current time is 09/02/2024 19:45:29, the new value timestamp will default to 09/02/2024 19:00:00 when the display is opened or refreshed. The user may then change this timestamp before sending the new value.
• Colors :
  • Background
  • Label
  • Value
  • UOM
  • Timestamp
  • Errors
• Border :
  • Color
  • Weight (from 0 pixel to 20 pixels)

Technical considerations

Compatibility

This custom symbol is compatible with PI Vision 2017 R2 or later.

Tested with :

• PI Vision 2017 R2 SP1 (build 3.3.1.0)
• PI Vision 2019 Patch 1 (build 3.4.1.0)
• PI Vision 2020 Patch 1 (build 3.5.1.0)
• PI Vision 2021 Patch 1 (build 3.6.1.0)
• PI Vision 2022 (build 3.7.0.0)
• PI Vision 2022 Patch 1 (build 3.7.1.0)
• PI Vision 2023 (build 3.8.0.0)
• PI Vision 2023 SP1 Patch 1 (build 3.9.1.0)
  

Data retrieval

Based on PI Web API.

Tested with :

• PI Web API 2018 SP1 (version 1.11.1.5474)
• PI Web API 2019 SP1 (version 1.13.0.6518)
• PI Web API 2021 SP2 (version 1.16.0.254)
• PI Web API 2021 SP3 (version 1.17.0.200)
  

Asset Switching

This custom symbol is fully compatible with the asset switching feature.

Dependencies

No dependency required :

• No external library
• No polyfill