Aggregate Documentation

Module ID: 1ba63b5d-df4a-4a3b-a144-c03a7259d39b
Version: 4.0.0
Retrieved: 2025-10-09 15:14:58

Aggregate

The module aggregates data over a period of time or by collecting a specified number of samples. The mode is set by the SampleMode setting. When a new message is received its value (Value Property ) will be added to the group with the same name (Source Property). When the limit is reached (time or count based on SampleMode) the module will calculate average, min and max and send the results for each group individually to the next module(s) in the flow.

Settings

The data is grouped by Source Property and the value to aggregate on is collected from Value Property. If Source Property is empty the name default will be used as name for the aggregation

Name Requirements Purpose Default
Source Property Length: 0-64 The property that contains the name to group on name
Value Property Length: 1-64 The property that contains the value to aggregate on value
Target Property Length: 0-64 The property to write the result into. If empty result is written to the root  
Keep Properties true/false If true properties on the object being input will be attached on the output. False will only include aggregated data true
Ignore Empty Measurements bool If true the module will not send result messages for groups that had no registered values in the current time interval. true
Sample Mode Time/Count The mode to use in aggregation Time
Sample Interval 1000 - 60000*60*24 Used for sample mode Time. The timespan (in ms) for each aggregation 30000
Sample Count 1 - 1000000 Used for sample mode Count. The samples to use for each aggregation 100

Input

The input must have a property that matches the Value Property setting.

Name Required Type Description
[Source Property] no string The property containing the name to group on
[Value Property] yes double The property containing the value to aggregate on

Output

Output will only be sent on every interval configured in the Interval setting. The output from the module is a new object for each aggregation group. The object details is listed below.

Name Type Description
name string The group name for the aggregation. Comes from the Source Property property on the incoming data. If no name property is given, set to default.
min double Smallest value registered during the current aggregation.
max double Largest value registered during the current aggregation.
count int The number of registered values during the current aggregation.
timestamp DateTime The time when the aggregate results are calculated, i.e. at the end of the aggregation interval.
average double The average value for the current aggregation

Search Documentation