Versions Compared

Old Version 7

changes.mady.by.user Felicity Borrelli

Saved on

compared with

New Version 8

changes.mady.by.user Felicity Borrelli

Saved on

Key

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

...

Under More you have the following options:

Action

Description

 View

View or copy the individual session data in JSON format.

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

Info

Example - Aggregated session data in JSON format

Code Block
{
    "timeoutAt": "2024-10-02T14:19:48.108Z",
    "createdAt": "2024-10-02T13:19:48.108Z",
    "sum_sheets": 52,
    "printerId": 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_sheets": 52

This shows that the aggregator has summed up 52 "sheets" during this session. This could refer to the total number of sheets processed, for example, in this printing as a service scenario, or any other unit of data being aggregated. You can use this to confirm the total count processed during the session.

"printerId": 105

This is the identifier for the printer (or another entity) associated with this aggregation. It shows which printer's data was aggregated in this session.

"month_timestamp": "2024-09"

This field represents a monthly aggregation period, showing that the processed data corresponds to 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 timeout window has passed. This allows you to change when a timeout will happen before a session gets flushed. 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.

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

Note!

The filter option is available for up to 10,000 records in the Inspect tab. If function is disabled if there are more than 10,000 records the filter will be disabled. This limit helps to maintain smooth and efficient stream execution in Usage Engine and ensures optimal system performance during large-scale data processing. in the Inspect tab.

Filter panel fields

Description

Planned timeout

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

Session created

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

Fields

Select the Field and Type of field from the dropdown lists. Depending on the Type of field selected (String, Number, or Boolean) different options will become available. For example, if the Type of field is Number, then the Operator field will appear where you can select the relevant Operator from the dropdown list, like, Less than, Greater than, Equal to etc.. Finally, enter the value(s) of the field - this option will also change depending on the Type of field selected.

+ Add field

Add up to 5 fields in the filter

...

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","lastCall":false}

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

lastCall

This indicates that this flush is not the final flush of the stream. There may still be more data to process, and additional flushes will happen later.