The NumericHistoryCalc component calculates the total, average, minimum and maximum values for the configured time range of logged values from a Niagara history.
Status
BStatus slot which reflects the current status of the component.
Fault Cause
String property which stores the fault cause if the component's status is in fault.
History Name
BFormat property used to specify the history id to be used in the total calculations. This can be a combination of static text and BFormat calls. The intent is to allow flexibility in specifying the target history without having to manually code the property for duplicated devices.
For example assuming the numericHistoryCalc object was the child of a numeric point named 'mainElectricConsumption' which is configured to be logged as a history with a history id of 'vykonProTest/mainElectricConsumption'. The 'History Name' property could be configured as 'vykonProTest/%parent.name%'.
History Ord
The resolved ord to the history to be used in the total calculations.
Delta Logged
Boolean property used to specify whether the configured history is logged in a delta fashion. If the history is logged in a delta fashion, set the property to "true".
When deltaLogged="true", the total values are calculated as the sum of each individual record. When deltaLogged="false", the total values are calculated as the difference between the first and last record for the period.
Exclude Invalid Values
When value = "true", records with fault, down, stale or null statuses are excluded from the calculations.
Exclude Hidden Values
When value = "true", records with the hidden trend flag set are excluded from the calculations. This allows using the history editor to mark a record as hidden in the event that an erroneous value was stored.
Include Time Of Day
TimeRange property that allows configuring what times during the day which the history record's timestamp must be within to be included in the calculated values. For example if the time range were configured as 6:00:00 AM EST to 6:00:00 PM EST, only history records whose timestamp was within that range would be used in calculating the values.
Time Range
The period of time used to query the history for records when calculating the values.
Facets
Theses facets are applied against the various output properties.
Total
StatusNumeric property which stores the total for the records matching the configured time range. This value is updated when the calculate action is executed.
Average
StatusNumeric property which stores the average for the the records matching the configured time range. This value is updated when the calculate action is executed.
Maximum
StatusNumeric property which stores the maximum for the records matching the configured time range. This value is updated when the calculate action is executed.
Minimum
StatusNumeric property which stores the minimum for the records matching the configured time range. This value is updated when the calculate action is executed.
Count
Integer property which stores the number of records which matched the configured time range and were used in calculating the values.
Calculating
Readonly boolean property that indicates if the component is actively calculating values.
Last Update Time
The last time that the calculate method updated the calculated values.
\