The NumericHistoryAnalysis component calculates the total, average, minimum and maximum values for specific intervals 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 numericHistoryAnalysis 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.
Facets
Theses facets are applied against the various output properties.
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.
Date Mode
The mode determines the dates used for the monthly and yearly queries. When set to the default value "First Of Month" the monthly and yearly properties use the first day of the month as the start of the period. When set to "Billing Cycle" the monthly and yearly properties use the "Billing Cycle Start Day" property value as the first day of the month.
Billing Cycle Start Day
The day of the month which the billing cycle starts.
Execute Period
BRelTime property which determines the frequency at which the component recalculates the total values.
Calculating
Readonly boolean property that indicates if the component is actively calculating values.
Next Update Time
The next time at which the calculate method is scheduled to be executed.
Last Update Time
The last time that the calculate method updated the calculated values.
\Current Day Total
StatusNumeric property which stores the total for the current day. This value is updated at the execute period
Current Day Avg
StatusNumeric property which stores the average for the current day. This value is updated at the execute period
Current Day Min
StatusNumeric property which stores the minimum for the current day. This value is updated at the execute period
Current Day Max
StatusNumeric property which stores the maximum for the current day. This value is updated at the execute period
Yesterday Total
StatusNumeric property which stores the total for the previous day. This value is updated during the first regular execution after midnight each day.
Yesterday Avg
StatusNumeric property which stores the average for the previous day. This value is updated at the execute period
Yesterday Min
StatusNumeric property which stores the minimum for the previous day. This value is updated during the first regular execution after midnight each day.
Yesterday Max
StatusNumeric property which stores the maximum for the previous day. This value is updated during the first regular execution after midnight each day.
Current Week Total
StatusNumeric property which stores the total for the current week. This value is updated at the execute period.
Current Week Avg
StatusNumeric property which stores the average for the current week. This value is updated at the execute period
Current Week Min
StatusNumeric property which stores the minimum for the current week. This value is updated at the execute period.
Current Week Max
StatusNumeric property which stores the maximum for the current week. This value is updated at the execute period.
Last Week Total
StatusNumeric property which stores the total for the previous week. This value is updated during the first regular exection after midnight of the first day of the week.
Last Week Avg
StatusNumeric property which stores the average for the previous week. This value is updated at the execute period
Last Week Min
StatusNumeric property which stores the minimum for the previous week. This value is updated during the first regular exection after midnight of the first day of the week.
Last Week Max
StatusNumeric property which stores the maximum for the previous week. This value is updated during the first regular exection after midnight of the first day of the week.
Current Month Total
StatusNumeric property which stores the total for the current month. This value is updated at the execute period.
Current Month Avg
StatusNumeric property which stores the average for the current month. This value is updated at the execute period
Current Month Min
StatusNumeric property which stores the minimum for the current month. This value is updated at the execute period.
Current Month Max
StatusNumeric property which stores the maximum for the current month. This value is updated at the execute period.
Last Month Total
StatusNumeric property which stores the total for the previous month. This value is updated at the first regular execution after midnight of the first day of a month.
Last Month Avg
StatusNumeric property which stores the average for the previous month. This value is updated at the execute period
Last Month Min
StatusNumeric property which stores the minimum for the previous month. This value is updated at the first regular execution after midnight of the first day of a month.
Last Month Max
StatusNumeric property which stores the maximum for the previous month. This value is updated at the first regular execution after midnight of the first day of a month.
Current Year Total
StatusNumeric property which stores the total for the current year. This value is updated at the execute period.
Current Year Avg
StatusNumeric property which stores the average for the current year. This value is updated at the execute period
Current Year Min
StatusNumeric property which stores the minimum for the current year. This value is updated at the execute period.
Current Year Max
StatusNumeric property which stores the maximum for the current year. This value is updated at the execute period.
Last Year Total
StatusNumeric property which stores the total for the previous year. This value is updated during the first regular execution after midnight of the first day of a year.
Last Year Avg
StatusNumeric property which stores the average for the previous year. This value is updated at the execute period
Last Year Min
StatusNumeric property which stores the minimum for the previous year. This value is updated during the first regular execution after midnight of the first day of a year.
Last Year Max
StatusNumeric property which stores the maximum for the previous year. This value is updated during the first regular execution after midnight of the first day of a year.