Calling convention: CIP_PeriodicalAggregate("CalculationName": String, "IndicatorName": String, StartValue: Variant)
Description: Aggregates calculation result sets over a period. The accumulated variables are reset when the indicator equals StartValue or is not greater than its preceding value; ordinary values are summed, while variables with minimum or maximum suffixes use the corresponding aggregate.
Parameters:
CalculationName = Name of the calculation whose final aggregate is returned.
IndicatorName = Result variable that identifies period boundaries.
StartValue = Indicator value representing the start of a new period.
Returns: Variant aggregate for CalculationName, or NULL when it cannot be calculated or found. A NULL CalculationName displays a user-script error and returns NULL.
Availability: Requires a current object with calculation definitions and populated MathParser result sets.
Example:
MonthlyTotal := CIP_PeriodicalAggregate("CalculatedEntry", "MonthEntry", 1);