Versions Compared

Key

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

Cloud_Edition_button.webpImage Modified

The Inspect Tab in the Data Aggregator function allows you to manage individual aggregation sessions, including viewing, inspecting, and deleting them. There are a few ways to access the Inspect tab, via the Data aggregator function as documented below, and via the Aggregation tab, see Aggregation Tab for more details.

Note!

The Inspect tab of the Data aggregator function is only accessible

...

after the stream has been executed at least once.

To navigate to the Inspect tab, double-click on the Data aggregator function icon from the stream editor canvas, then click Inspect at the top right of the page.

...

Widgets

The widgets provide a

...

snapshot of the number of active sessions, the oldest ongoing session, and the most recently initiated session. You can hide the widgets by going to Display options and switching off the Overview widgets toggle.

...

Inspect tab table

The table on the Inspect tab displays the data related to the

...

sessions.

...

Actions on the Inspect tab table

Under

...

More

...

you

...

have the following options:

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.

...

Edit Timeout

You can edit the timeout date and time on a session before a timeout window has closed. This allows you to extend or adjust the time window during which the session remains open, and after modifying the timeout, you can queue the data for reprocessing based on the new timeout.

...

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 session. This could refer to any fields configured in the aggregated field section in the function’s configuration.

"group_fieldsA": 105

This could be any field 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.

"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.

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.

...

Note!

You cannot delete a

...

solution, stream, or data aggregator function that has

...

active aggregation

...

sessions. You must first delete the aggregation sessions and then delete the

...

functions, streams, and solutions they were a part of.

...

Toolbar buttons

...

Filter

...

You can filter the aggregated sessions based on the following:

...

Filter panel fields

Description

Session creation

Select from the dropdown list or select Custom and enter the from and to dates and times.

Planned timeout

...

Select from the dropdown list or select Custom and enter the from and to dates and times.

Fields

...

Use this option to filter by the Field and

...

Value of a specific attribute. For example,

...

after selecting the Field, you can choose an Operator like Less than, Greater than, Equal

...

+ Add field: Add up to 5 fields in the filter

Filter_inspect_tab_Data_aggregator.pngImage Removed

...

to, or you can filter according to Range of values or Is not equal to. In the Script Aggregator Inspect tab filter, you also can select the type of the field (String, Numerical or Boolean).

Tip

Hint!

When you have set a filter, the Filters Applied label is displayed. Click on the Hide filter button to hide the Filter options. 

Note!

The filter function is disabled if there are more than 10,000 sessions in the Inspect tab.

Display options panel

Enable or disable the Overview widgets and select which columns to display in the data table. You can also toggle the Overview widgets on and off in this

...

panel.

Display_options_inspect_tab.pngImage Modified

Refresh data

Use this button to update and view the most current state of the aggregation sessions or data being displayed.

Metadata

There may be instances where you want to apply certain rules to aggregated data, such as applying a discount or adjusting values based on specific business rules. You can achieve this by using the Script function. If you need to reference metadata from aggregated sessions, such as the number of records or timestamps, you can access it using the meta-variable as described in Supported Variables/APIs.

Info

Example- metadata for an aggregated session

This example shows a JSON object representing metadata about a Data Aggregator function. It shows an aggregation session, including details about the events processed and how the data was flushed.

Code Block
{"origin":"Data_Aggregator","count":7,"flushType":"TIMEOUT","firstEvent":"2022-04-08T17:35:53.239Z","lastEvent":"2022-04-08T17:38:17.315Z"

Property name 

Description

origin

This indicates that the data comes from the Data Aggregator component of the stream

count

Number of aggregated records

flushType

The reason for the session being flushed out. Shows any of the values: ALL_FILES, EACH_FILE, TIMEOUT, and CONDITION. During preview, the value will be empty.

firstEvent

Date and time of the first aggregated record in the session

lastEvent

Date and time of the last aggregated record in the session