Navigation in an AVEVA OMI Project (Galaxy) lets you leverage the existing asset model and existing Graphic Toolbox (GTB) folder structure, or build a custom hierarchy of run-time behaviors. These behaviors allow the run-time user to perform various actions to show content, browse information, etc. The Navigation SDK is designed to allow you to build a visible control, such as the NavTreeControl, that shows either your custom build hierarchy or existing hierarchies in the Galaxy. The Navigation SDK is delivered as ArchestrA.Client.Navigation.dll, which is installed with the remainder of the AVEVA OMI assemblies as part of the ArchestrA IDE installation.

The main functional element of the Navigation SDK is a .NET assembly that lets you retrieve the underlying navigation model and NavigationItems to provide an easy way to access the navigation hierarchies in your ArchestrA apps.

The Navigation SDK exposes the following classes:

• NavigationModel
• NavigationItem
• NavigationException

The namespace for these classes is:

• ArchestrA.Client.Navigation

The assembly name is:

• ArchestrA.Client.Navigation.DLL 

Changes in the System Platform 2023 Release

System Platform 2023 introduces some new properties and enums, and depcrecates others in the Navigation assembly.

Deprecated Properties and Enums

The following properties and their enums have been deprecated as of the System Platform 2023 release:

• LevelsOfSearch property and enums:
  • All
  • SearchesCurrentOnly
  • SearchesOneLevel
  • SearchesTwoLevels
  • SearchesThreeLevels
• NavigationSearchMode property and enums:
  • FixedLocation
  • CurrentNav
  • ChildrenAlone

New Properties and Enums

The following properties and their enums are introduced in the System Platform 2023 release:

• NavSearchOptions property: Gets or sets the NavigationSearch options, and provides the navigation search options for the given navigation path.
• NavSearchOptions enums:
  • Unconfigured
  • StartNode
  • Siblings
  • ChildLevels
• SearchLevelOptions property: Gets or sets depth of the search for the content, and provides the levels of search that need to be performed on the given navigation path. Only used if NavSearchModeOptions contains Child Levels.
• SearchLevelOptions enums:
  • Unconfigured
  • All
  • OneLevel
  • TwoLevels
  • ThreeLevels