PI Vision OMI App properties

View Dashboard Display

Boolean property that enables/disables viewing a saved display from the PIVision server. If True, the Dashboard Id is used to determine which dashboard display to show at runtime.

Boolean properties for setting display mode (View Dashboard Display, View Ad hoc Display, View Freeform Display) are mutually exclusive. If this setting is True, the other display settings must be set to False.

Dashboard Id

Display Id, as an integer of a saved PIVision display URL. For example, the Display Id is 3117 for a display with the following URL:
https://PIVisionwebserver/PIVision/#/Displays/3117/PowerAnalysis

Asset Path

Specifies an asset path for an existing display to swap related assets that share the same PI AF template.

Note: This is an additional, optional configuration on the saved dashboard display.

This property lets you configure an existing display to use other assets that share the same AF template. See Configure dashboard displays for more information.

View Ad hoc Display

Boolean property that enables/disables the ad hoc display mode. If True, you can specify data items to show in a single temporary trend (ad hoc) display.

Boolean properties for setting display mode (View Dashboard Display, View Ad hoc Display, View Freeform Display) are mutually exclusive. If this setting is True, the other display settings must be set to False.

Symbol Type

Determines the type of symbol that is used for a temporary (ad hoc) display. Depending on the symbol type, you can add multiple data items per symbol. If you do not specify a symbol type, the property uses Trend as the default.

Each specified data item in an ad hoc display is shown in a single trend, using the specified Symbol Type. The symbol type is designated by an enum type, which correlates to a PIVisionSymbolType, and can be any of the following:

If no symbol is specified, a trend symbol type is used for the ad hoc display.

Data Items

Specifies one or more data items for a temporary (ad hoc) PI Vision display. These items will appear regardless of the currently selected navigation node, even if Follow Current Context is True and you have navigated away from the asset containing the specified data items. See Configure ad hoc displays for additional information about the Data Items property.

Context Asset Server

Name of the of asset server for the PI system. The app uses this property to connect to the AF server using the currently logged in Windows user credential. Once connected, it gets attributes automatically from the currently selected asset, when the Follow Current Context property is enabled.

This is an optional property. If a Context Asset Server is not configured, the PI Vision OMI App tries connecting to the default AF Server.

Context Asset Database

Name of the Asset database that contains the attributes of the current asset on a given AF server.

This property is used to connect to the AF server to get the attributes automatically from the currently selected asset, when the Follow Current Context is enabled.

This is an optional configuration property. If a context database is not specified, the PI Vision OMI App tries to discover the current selected asset from the default database of the given AF server.

Max Context Data Items to Show

Determines the number of data items from the current context that can be shown in the ad hoc display, when the Follow Current Context property is enabled. A value of 10 or less is recommended. The default is 10.

When Follow Current Context is disabled, the Max Context Data Items property is inactive, and any number entered is ignored.

View Display URL

Boolean property that enables/disables the freeform display mode. If True, the Display URL Parameters property appends to the base URL configured in the Connection properties, and shows the display called by the complete URL at runtime.

Boolean properties for setting display mode (View Dashboard Display, View Ad hoc Display, View Freeform Display) are mutually exclusive. If this setting is True, the other display settings must be set to False.

When freeform display mode is enabled, Display URL Parameters is the only other property (in addition to Connection properties) that is used for configuring the display for the given PI Vision webserver and website. All other properties, including Time Range and Appearance, are ignored.

Display URL Parameters

Specifies parameters to be appended to the base path of the configured PI Vision web server URL for a display from PI Vision. The Display URL Parameters property lets you directly call displays that are not dashboard (saved) or ad hoc displays, such as EventDetails or EventComparison displays. You can also include additional parameters (Time Range, Appearance, etc.).
For example:

• To call an Event Comparison, you would enter something like "EventComparison/24"

• To call an Event Detail display, you would enter something like "EventDetails?srcdisplayid=23&server=PIVISIONSERVERP&eventid=c80dc366-82e4-11ec-a058-00155d754303"

  Underlying Data Type	Default Value	Read/Write Mode	Runtime Property	Scriptable
  String	Empty	Read/Write	Yes	Yes

Start Time

Specifies the start time of a dashboard or ad hoc display. If this property is not specified, the start time defaults to the current time at run time.

Note: Start and end times must be used in pairs. OSIsoft recommends using ISO 8601 standards because they are not affected by time zones. Start/End time properties cannot be used with freeform displays.

End Time

Specifies the end time of a display. If this property is not specified, the end time defaults to eight hours from the current time.

Note: Start and end times must be used in pairs. OSIsoft recommends using ISO 8601 standards because they are not affected by time zones. Start/End time properties cannot be used with freeform displays.

Follow Current Context

If enabled, automatically discovers the applicable ad hoc or dashboard display (depending on mode) associated with the asset in the AF server. Context cannot be used with freeform displays.

Hide Toolbar

Boolean value that determines if the display toolbar is shown or hidden. When set to true, the toolbar is hidden. This property cannot be used with freeform displays.

Hide Timebar

Boolean value that determines if the display timebar is shown or hidden. When set to true, the timebar is hidden. This property cannot be used with freeform displays.

Hide Sidebar

Boolean value that determines if the display sidebar is shown or hidden. When set to true, the sidebar is hidden. This property cannot be used with freeform displays.

Kiosk Mode

Boolean value that determines if the PI Vision display is operating in kiosk mode. In kiosk mode, users cannot search for data or save the display. This property cannot be used with freeform displays.