The framework in the Nav tree

To begin your understanding of how the framework data model works symbiotically with Niagara, this topic points out where in a typical Nav tree framework configuration appears. These are the areas you use most frequently as you set up the framework.

TIP: Consider opening each container in a separate tab so you can quickly navigate among them without having to scroll the Nav tree.

Drivers container

Your Drivers folder models your network and devices. This is where all your points reside. When tagging points, you can use this space or the Hierarchy space (once you create one or more hierarchies).

The AnalyticService

Figure 5. AnalyticService under the Services folder

You use the AnalyticService in the Services container to configure framework properties. This folder also contains four sub-folders for configuring framework features:

The Alerts folder contains alerts. These components use algorithms to evaluate conditions and may or may not generate an alarm.
The Algorithms folder contains the formulas used by alerts, Px Views and Web Charts.
The Definitions folder contains data definitions.
A Data Definition is an optional component the framework uses to configure default properties for a specific data item defined in a station. Data Definition components simplify configuration by defining defaults that apply across the framework. These default properties may be overridden for a specific analytic request in an Alert, Analytic Proxy Ext or Binding.

An Analytic Data Folder under the AnalyticService groups Data Definition components. The Analytic Data Manager serves as the primary view for this folder.

You may have a data definition for each type of data to be used in formulas and charts. Pre-defined data definitions are located in the data model’s Dictionary. You can modify and add to these definitions.

A formula (algorithm) may serve as a data definition. A graphic widget also provides a data definition property.
The Pollers folder contains components to manage data sampling frequency.

HierarchyService

Figure 6. An example of a HierarchyService

You use the HierarchyService to define a logical data model that is independent of your drivers-network-device model.

While this service is a feature of Niagara 4, and not specifically a feature of the framework, it is indispensable to the framework. The HierarchyService provides the foundation for the alternative, meaningful data model that appears in the Hierarchy space.

Hierarchy folder

Figure 7. Example of a Hierarchy node

When you save a hierarchy, the HierarchyService automatically creates a Hierarchy structure at the same level as the Config container. You can use this hierarchy space to navigate from point to point.

The example above defines two hierarchies. The AnalyticDataModel organizes building equipment (AHUs, etc.) by geographic location. the AnalyticDashboards hierarchy contains all dashboard representations for the geographical locations.

TagDictionaryService

Figure 8. An example of a TagDictionaryService

You use the TagDictionaryService to set up tags. When assigned to individual points within a hierarchy, the framework uses tags to identify data source values.

While the tag dictionary is a feature of Niagara 4, and not specifically a feature of the framework, the Niagara Analytics Framework provides one of the most compelling reasons to use tags. This is where you can create your own tag dictionary.

You define inputs (data sources) and outputs by tagging data and configuring properties. Several tag dictionaries provide the tags to apply to points including:

Haystack tag dictionary
Niagara tag dictionary

You may create your own tags using an Analytics dictionary component under the TagDictionaryService.

Folder to contain Analytics’ logic

Figure 9. An example of a logic folder

At the same level as the Services and Drivers containers, you can create a folder to contain framework-specific components, such as Px views, schedules, special points, time triggers and proxy extensions.

The example screen capture above is from a demonstration station. Your logic folder may be very different.

Files folder

Figure 10. Example of chart files in the Files folder

The Files folder contains framework chart files.

In the example, two folders separate the UxCharts (Web Charts) from the Px Views.