history-HistoryShortcuts

History Nav shortcuts provide convenient navigation links to histories. You can place these shortcuts anywhere in a station to provide a filtered list of individual history shortcuts. The default property values display links to all histories that are under the Nav shortcut ancestor device’s name. You edit properties in the Property Sheet view to display only the histories you want. History Nav shortcuts have a Nav Container view and a History Chart Builder view.

NOTE: The history shortcuts are not actual histories but links that provide convenient access to a history when you double-click on the shortcut. You cannot drag history shortcuts onto a Px page and relativize them.

Figure 24. Example History Nav Shortcut property values

The history shortcut has the following properties:

Type Value Description

History Query Predicate Text string This property allows you to filter the histories by entering a value as a BQL query predicate value. For example, you could enter the following text string: where state=’Georgia’ (note the single quotes) to filter for all histories that have a state property with the value set to “Georgia”. This property works in conjunction with the Only Display Parent Device Histories property.

Only Display Parent Device Histories

true (default), false

Type	Value	Description
History Query Predicate	Text string	This property allows you to filter the histories by entering a value as a BQL query predicate value. For example, you could enter the following text string: where state=’Georgia’ (note the single quotes) to filter for all histories that have a state property with the value set to “Georgia”. This property works in conjunction with the `Only Display Parent Device` Histories property.
Only Display Parent Device Histories	true (default), false	This property allows you to restrict the history shortcut filtering to those histories that match the ancestor device of the HistoryNavShortcut component. If set to `true`, only shortcuts to histories that are identified with the history shortcuts parent device name are displayed. If set to `false`, shortcuts to all valid (those that match the “BQL query predicate value”) are displayed. In cases where the parent device name is not a valid history device name, you can add a dynamic “`historyDeviceName`” property. This property works in conjunction with the `History Query Predicate property`.
historyDeviceName	Text string	Using the History Nav Shortcuts component Slot Sheet view, you can add a “`historyDeviceName`” string property to the HistoryNavShortcuts Property Sheet. This property allows you to filter for an alternate history device name (in case the HistoryNavShortcuts parent device’s name is not a valid history device). For example, if you place a HistoryNavShortcut under a device that has a name “SqlServerDatabase” and a `history ID` from that RDBMS device are named “/myStation/currentTemp”, then a shortcut for this history is not displayed when the `Only Display Parent Device Histories` is set to true. However, if you add a `HistoryDeviceName` property to the component and set a value of “myStation” in that property, a shortcut for that history displays under the History Nav Shortcuts component.

This property allows you to restrict the history shortcut filtering to those histories that match the ancestor device of the HistoryNavShortcut component. If set to true, only shortcuts to histories that are identified with the history shortcuts parent device name are displayed.

If set to false, shortcuts to all valid (those that match the “BQL query predicate value”) are displayed.

In cases where the parent device name is not a valid history device name, you can add a dynamic “historyDeviceName” property. This property works in conjunction with the History Query Predicate property.

historyDeviceName

Text string

Using the History Nav Shortcuts component Slot Sheet view, you can add a “historyDeviceName” string property to the HistoryNavShortcuts Property Sheet. This property allows you to filter for an alternate history device name (in case the HistoryNavShortcuts parent device’s name is not a valid history device).

For example, if you place a HistoryNavShortcut under a device that has a name “SqlServerDatabase” and a history ID from that RDBMS device are named “/myStation/currentTemp”, then a shortcut for this history is not displayed when the Only Display Parent Device Histories is set to true. However, if you add a HistoryDeviceName property to the component and set a value of “myStation” in that property, a shortcut for that history displays under the History Nav Shortcuts component.

About nesting history shortcuts

History Nav Shortcuts can be nested in order to build hierarchies of shortcut navigation. In the following illustration, note the following points:

The History Query Predicate property filters to show the shortcuts in the Nav tree. Since the Only Display Parent Device Histories value is set to true and the shortcut is not a child of any of the station devices (Station1, Station2, etc.) these shortcuts include histories that have a building property set to a value of Headquarters and are included anywhere in the History space. If the shortcut is placed under Station1 with these same property settings, then only the Station1 Consumption, OutsideAirTemp, and Demand histories would display.
Figure 25. Example nested History Nav Shortcuts
The History Nav Shortcuts named Chemistry shows all shortcuts to histories with a building property set to Chemistry.
The History Nav Shortcuts named Biology shows shortcuts to histories with a building property set to Biology. Since the Only Display Parent Device Histories value is set to true and the shortcut does not have a parent device these are histories that have a Biology property set to a value of Headquarters and are included anywhere in the History space.