Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Action

Description

 View

Shows you the state of an aggregation session. You can copy the data if required.

Info

Example - Aggregated session data in JSON format

This is an example of a JSON file sent downstream after a flush.

Code Block
{
    "timeoutAt": "2024-10-02T14:19:48.108Z",
    "createdAt": "2024-10-02T13:19:48.108Z",
    "sum_fieldX": 52,
    "group_fieldsA": 105,
    "month_timestamp": "2024-09"
}

"timeoutAt": "2024-10-02T14:19:48.108Z"

This indicates the exact time when the system flushed the aggregated data. The data was flushed (sent downstream or processed further) based on a timeout at this specific timestamp.

"createdAt": "2024-10-02T13:19:48.108Z"

This marks the start time of the aggregation session, showing when the session was created. It indicates that this session ran for exactly one hour before the timeout occurred and the data was flushed.

"sum_fieldX": 52

This shows that the aggregator has summed up the value in fieldX to 52 during this session52 fieldX during this session. This could refer to any fields configured in the aggregated field section in the function’s configuration. in configuration. unit of data being aggregated.

"group_fieldsA": 105

This could be any field that’s that has been used to group the data during aggregation. It can be set by selecting fields in Group fields in the function's configuration. This is the identifier for an entity associated with this aggregation. It shows which entity’s data was aggregated in this session.

"month_timestamp": "2024-09"

This field represents the aggregation period. this is based on the date/time configured in Group fields in the aggregator function’s configuration. September 2024.

Note!

These metadata fields can be used when creating custom scripts for aggregated data. See, Metadata, at the bottom of this page for more details.

Edit Timeout

Edit the timeout date and time on a session before a session is flushed. This allows you to change when a timeout will happen before a session gets flushed.

Delete

Delete the session. A warning message and confirmation dialogue will pop up.

...