Page tree
Skip to end of metadata
Go to start of metadata


The Function described in this document is only available as part of an add-on package. Please contact your Account Manager for further information.

The Aggregation Inspector helps you visualise, manage and troubleshoot the sessions containing your aggregated data. The main UI elements of the Aggregation Inspector are:

  • Aggregation Tab: Presents a cumulative view of all sessions within a solution. The data is displayed in a table where each row represents sessions created per aggregator. 
  • Inspect Tab: Enables viewing of stored aggregation sessions. The data is displayed in a table where each row represents a session, with the session data ordered in columns. 

Aggregation Tab

After entering a solution, select the Aggregation tab next to the Streams and Stream Groups tabs. The Aggregation Table displays an overview of all Aggregation sessions currently in your solution. All streams and their respective aggregator Functions are listed in the overview along with information on the total number of active sessions, the oldest session, the most recent session and the option to view and delete the session. 

Aggregation Tab - Overview

Aggregation Table

The Aggregation Table displays the following details:


The stream for which the aggregation session is recorded.


The name of the Aggregator Function in that stream.


Shows the current number of active sessions for aggregator

Oldest Session

Shows the time elapsed since the oldest active session was created for aggregator.

Most recent

Shows the time elapsed since the most recent active session was created for aggregator.

  • View: Click to view the inspect tab of the aggregator. 
  • Delete all Sessions: Click to delete all active sessions of an aggregator.

Display Options 

Click Display options to enable or disable the Overview widgets or if you wish to display specific column(s) in the Aggregation Table. By default, the Overview widgets are enabled and all columns in the Aggregation Table are selected. After making your selection, click Apply to save and view the changes. If needed, you also have the option to refresh the data to reflect the latest details.
Click the icon to hide the Display options panel.

Display options

Overview Widgets

In Display Options, when Overview widgets is selected and applied, three widgets namely Active sessions, the Oldest session, and the Most recent session are displayed. 

Overview Widgets

Edit Timeout and Delete Sessions

If you select one or more streams, you will see the following options above the Overview widgets instead of Display options and refresh Data: 

  • Edit timeout: Click to set/update the timestamp for the session(s) data to be timed out. You can set the timeout for more than one session at the same time.
  • Delete: Click to delete the aggregation sessions for the selected stream(s). This will also remove all stored sessions from the Aggregation Table in the Inspect tab of that Data Aggregator Function(s).

Edit timeout & Delete Session

Click Clear selection to clear the selection of the rows in the Aggregation table.

Inspect Tab

To inspect, view or delete each individual aggregation session of aggregator Function in a stream, click on the Inspect tab. You will see this once you click on an aggregator Function (Data Aggregator or Script Aggregator) inside a valid stream or click View in the aggregation table
In the following section, you will find the details of the Inspect tab with respect to the Aggregator Function:

  • Data Aggregator: You can view the detailed overview of individual sessions of Data Aggregator in a tabular format.

    Data Aggregator - Inspect Tab Overview

  • Script Aggregator: The Inspect tab shows the following view. By default, you will not see any input fields in this view. However, you can select which columns (or, input fields) to appear in the Aggregation table using the Display options. 

    Script Aggregator - Inspect Tab Overview

The Inspect tab of the Aggregator Function is accessible only if the stream has been executed at least once by Usage Engine. 

The different options as shown in the Inspect tab for Data aggregator and Script Aggregator are described in detail below:

You can filter the aggregated sessions on the basis of:

  • Session creation: If you wish to filter according to when the session was created, set a start date and an end date to filter sessions created during that period. 
  • Planned timeout: If you wish to filter according to planned timeout.
  • Fields: If you wish to filter according to the Field and Value of a specific attribute. For example, after selecting the Field, you can set the filtering criteria using Operator with relational operators like Less than, Greater than, Equal to or you can filter according to Range of values or Is not equal to. In case of Script Aggregator, you also can select the type of the field (String, Numerical or Boolean).

Upon setting a filter, the Filters Applied label is displayed. Click Hide filter to hide the Filter option. 

Similar to the one in the Aggregation tab, you can use Display Options in the Inspect tab to enable or disable the Overview widgets and select which columns you wish to display on the Aggregation Table. In Data aggregator, by default, all the fields columns are displayed and in script aggregator all fields columns are hidden by default. See here to know more about Display Options in the Aggregation tab.

Click the Hide display options or icon to hide the Display options panel.

You can perform the following different actions on session data. 

  • View as JSON: Use the View as JSON option to view individual session data in JSON format. You also have the option to copy the JSON format.
  • More: To explore further actions, click More to specify/edit the timeout options for individual session by clicking Edit timeout or delete a specific session by clicking Delete

Clicking Delete will remove the selected session for that aggregator. 


Similar to the one in the Aggregation tab, you can also delete or edit timeout of one or more sessions in one go. See here to know more.  

Deleting a Solution

When trying to delete a solution that uses an aggregator Function, a warning is displayed and you will not be able to proceed with the deletion. You must always remove all active sessions from the aggregation before deleting.

  • No labels