PI Vision OMI App property validation
- Last UpdatedJul 18, 2024
- 2 minute read
The properties listed in the PI Vision OMI App property grid are validated during design time to ensure proper configuration.
For most of the properties, design time validation occurs only when the property value is modified in the property grid. If the property is not modified in the property grid, validation will occur when the ViewApp is deployed to run time. Values entered for properties are checked, and if the required minimum configuration is not met, an visual cue indicating the error is shown in the app, and details of the error are sent to the System Platform Logger.
The following is a summary of property validation.
|
Property name |
Type |
Validation |
|---|---|---|
|
Web Server |
string |
Cannot be empty; no spaces in name |
|
Web Site |
string |
Cannot be empty; no spaces in name |
|
View Dashboard Display |
Boolean |
Can only be true when ad hoc and freeform display modes are false |
|
Dashboard ID |
integer |
Must be > 0 when View Dashboard Display is true. |
|
Asset Path |
string |
Optional, not validated |
|
View Ad hoc Display |
Boolean |
Can only be true when dashboard and freeform display modes are false |
|
Data Items |
string |
Optional, not validated |
|
Context Asset Server |
string |
Optional, not validated |
|
Context Asset Database |
string |
Optional, not validated |
|
Follow Current Context |
Boolean |
Can only be true when either dashboard or ad hoc display mode is true |
|
View Display URL |
Boolean |
Can only be true when dashboard and ad hoc display modes are false |
|
Display URL Parameters |
string |
Can only be set when View Display URL is true |
|
Start Time |
string |
Optional. If Start Time is provided, End Time must also be provided |
|
End Time |
string |
Optional. If End Time is provided, Start Time must also be provided |