AVEVA™ Operations Management Interface

Predefined navigation attribute rules

Save PDF

Predefined navigation attribute rules

Save PDF

Last UpdatedNov 06, 2024
5 minute read

Navigation attributes are available only for use in AVEVA OMI ViewApps. Navigation attributes cannot be used in an InTouch application because the MyViewApp.Navigation prefix is regarded as a configuration error.

All Navigation attributes operate in the MyViewApp.Navigation namespace. Navigation attributes are specified with the MyViewApp.Navigation prefix in the form MyViewApp.Navigation.attribute_name.

Notes:

Attribute names with Path return the fully qualified path of a navigation item within the navigation model.
Attributes with the word Title in their names return the user friendly name set as the value of the Title property of a navigation item. When a navigation item's Title property is not configured, then the name of the navigation item is used instead.

Attribute Name	Data Type	Read/Write	Initial Value	Description
Current	String	Read/Write	None	Returns the name of the current internal name of a navigation item. Should always be assigned a value.
CurrentTitle	String	Read Only	None	CurrentTitle returns the name specified in the Title property of the current navigation item. If the navigation item's Title property is empty, CurrentTitle returns the current value.
CurrentPath	String	Read/Write	None	CurrentPath can be assigned the fully qualified path of a navigation item. When a value is set to CurrentPath, it is validated to see if the navigation item with the fully qualified path exists in the navigation model. If the navigation item exists, then the value is accepted. Otherwise, the previous value of CurrentPath is retained. A successful path assignment moves the navigation item to a new value and triggers Auto-Fill behaviors. Other Navigation attributes like Parent, NextSibling, PrevSibling, Current, CurrentAsset are updated.
CurrentAsset	String	Read/Write	None	CurrentAsset can be assigned the name of an asset if the current navigation item is an asset. When a value is set to CurrentAsset, it is validated to see if an asset with the given name exists in the navigation model. If an asset with given name exists, then the value is accepted. Otherwise, the previous value of CurrentAsset is retained. A successful asset assignment moves the navigation item to a new value and triggers Auto-Fill behaviors. Other attributes like Parent, NextSibling, PrevSibling, Current, CurrentAsset are updated.
CurrentAsset Title	String	Read Only	None	CurrentAssetTitle returns the user friendly name of the current asset. CurrentAssetTitle returns CurrentAsset if empty.
CurrentAsset Path	String	Read Only	None	CurrentAssetPath returns the fully qualified name of the current asset path. CurrentAssetPath returns empty if the current asset is empty.
CurrentArea	String	Read/Write	None	CurrentArea can be assigned the name of the current asset’s area if the current asset is valid. When CurrentArea is set to a value, the incoming value is validated to see if an area with the given name exists in the navigation model. If an area with given name exists, then the CurrentArea value is accepted. Otherwise the previous value of the CurrentArea is retained. A successful area assignment moves the navigation item to a new value and triggers Auto-Fill behaviors. Other Navigation attributes like Parent, NextSibling, PrevSibling, Current, CurrentAsset are updated.
CurrentArea Title	String	Read Only	Non	CurrentAreaTitle returns the user friendly name of the current asset’s area. CurrentAreaTitle returns "CurrentArea" if empty.
CurrentArea Path	String	Read Only	None	CurrentAreaPath returns the fully qualified path of the current area. CurrentAreaPath returns empty if the current asset is empty.
CurrentRoot Area	String	Read Only	None	Returns the name of the current asset's Root area if the CurrentAsset is a valid asset. This is the area at the root of the Model Hierarchy (not the navigation hierarchy) which contains the CurrentAsset. This value is populated even if the Root Area node is not contained in the Navigation model.
CurrentRoot AreaTitle	String	Read Only	None	Returns the user friendly name of the current asset's Root area. If the root area is not part of the navigation model, this value will be empty.
CurrentRoot AreaPath	String	Read Only	None	Returns the fully qualified name of the current root area item using the ".Title" strings to form the path. Returns empty if the root area is not part of the Navigation model.
Root	String	Read Only	None	Root returns the internal name of the root item in the current navigation hierarchy.
RootTitle	String	Read Only	None	RootTitle returns the user friendly name of the root item in the current navigation hierarchy. If the root item's Title property is empty, RootTitle returns Root as its assigned value.
RootPath	String	Read Only	None	RootPath returns the fully qualified path of the root item using the Title strings to form the path.
Parent	String	Read Only	None	Parent returns the internal name of the parent navigation item in the current navigation hierarchy. If there is no parent item, Parent returns empty.
ParentTitle	String	Read Only	None	ParentTitle returns the user friendly name of the parent item in the current navigation hierarchy. If the parent item's Title property is empty, ParentTitle returns the Root value.
ParentPath	String	Read Only	None	ParentPath returns the fully qualified path of the parent item in the current navigation hierarchy. If there is no parent, ParentPath returns empty.
PrevSibling	String	Read Only	None	PrevSibling returns the internal name of the previous sibling item in the current navigation hierarchy. If there is no previous sibling, no value is associated with PrevSibling.
PrevSibling Title	String	Read Only	None	PrevSiblingTitle returns the friendly name of the previous sibling item in the current navigation hierarchy. If the previous sibling's Title property is empty, PrevSiblingTitle retains the current value.
PrevSibling Path	String	Read Only	None	PrevSiblingPath returns the fully qualified path of the previous sibling navigation item. No value is set to PrevSiblingPath if there is no previous sibling.
PrevSibling Count	Integer	Read Only	None	Returns the number of previous sibling items remaining in the current navigation hierarchy.
NextSibling	String	Read Only	None	NextSibling returns the internal name of the next sibling item in the current navigation hierarchy. No value is set to NextSibling if there is no next sibling item.
NextSibling Title	String	Read Only	None	NextSiblingTitle returns the friendly name of the next sibling item in the current navigation hierarchy. If the next sibling's Title property is empty, NextSiblingTitle returns NextSibling as its assigned value.
NextSibling Path	String	Read Only	None	NextSiblingPath returns the fully qualified path of the next sibling navigation item. If there is no next sibling in the path, NextSiblingPath returns empty.
NextSibling Count	Integer	Read Only	None	Returns the number of next sibling items remaining in the current navigation hierarchy.
FirstChild	String	Read Only	None	Returns the internal name of the first child item in the current navigation hierarchy. If there is no first child, returns empty.
ChildCount	Integer	Read Only	None	Returns the number of child items in the current navigation hierarchy.
FirstChildPath	String	Read Only	None	Returns the fully qualified path of the first child, using the “Title” strings to form the path, for example, “\\<rootname>\<nodename>”. If there is no first child, returns empty.
FirstChildTitle	String	Read Only	None	Returns the friendly name of the first child of the current navigation item. If there is no first child the string is empty.

AVEVA™ Operations Management Interface

Predefined navigation attribute rules

Table of Contents

Predefined navigation attribute rules

Related Links