Aggregation Agent Configuration - Real-Time

Owned by Jenni Wallin
Last updated: Mar 03, 2023 by Kevin Wu
4 min read

The real-time Aggregation agent's configuration dialog includes the following tabs: 

  • General
  • APL Code
  • Storage

General Tab

The General tab enables you to assign an Aggregation profile to the agent and to define error handling.

With the Error Handling settings you can decide what you want to do if no timeout has been set in the code or if there are unmatched UDRs.


The Aggregation agent configuration dialog - General tab


SettingDescription

Profile

Click  Browse... and select an Aggregation profile.

All the workflows in the same workflow configuration can use different Aggregation profiles. For this to work, the profile has to be set to Default in the Field settings tab in the Workflow Properties dialog. After this, each workflow in the Workflow Table can be assigned with the correct profile.

Force Read Only

Select this check box to only use the aggregation storage for reading aggregation session data.

If you enable the read only mode, timeout handling is also disabled.

When using file storage and sharing an Aggregation profile across several workflow configurations, the read and write lock mechanisms that are applied to the stored sessions must be considered:

  • There can only be one write lock at a time in a profile. This means that all but one Aggregation agent must have the  Force Read Only setting enabled.

  • If all of the Aggregation agents are configured with Force Read Only, any number of read locks can be granted in the profile.

  • If one write lock or more is set, a read lock cannot be granted.

If Timeout is Missing

Select the action to take if timeout for sessions is not set in the APL code using sessionTimeout. The setting is evaluated after each consume or timeout function block has been called (assuming the session has not been removed).

The available options are:

  • Ignore  - Do nothing. This may leave sessions forever in the system if the closing UDR does not arrive.

  • Abort  - Abort the agent execution. This option is used if timeout must be set at all times. Hence, a missing timeout is considered being a configuration error.

  • Use Default Timeout  - Allow the session timeout to be set here instead of within the code. If enabled, a field becomes available. In this field, enter the timeout, in seconds.

If No UDR Match is Found

Select the action that the agent should take when a UDR that arrives does not match any session, and Create Session on Failure is disabled:

  • Ignore  - Discard the UDR.

  • Log Event - Discard the UDR and generate a message in the System Log.

  • Route - Send the UDR on the route selected from the on list. This is a list of output routes through which the UDR can be sent. The list is only activated if Route is selected.

APL Code Tab

The APL Code tab enables you to manage the detailed behavior of the Aggregation agent. You use the Analysis Programming Language (APL) with some limitations but also with additional functionality. For further information see the APL Reference Guide.

The main function block of the code is consume. This block is invoked whenever a UDR has been associated with a session.

The timeout block enables you to handle sessions that have not been successfully closed, e g if the final UDR has not arrived.

Aggregation agent configuration dialog - APL Code tab

ItemDescription

Code Area

This is where you write your APL code. For further information about the code area and its right-click menu, see Text Editor in Administration and Management in Legacy Desktop.

Compilation Test...

Use this button to compile the entered code and check for validity. The status of the compilation is displayed in a dialog. Upon failure, the erroneous line is highlighted and a message, including the line number, is displayed.

Outline

Use this button to display or hide the APL Code Editor Outline navigation panel. The navigation panel provides a view of all the blocks, variables and methods in an APL code configuration and makes it possible to easily navigate between different types in the APL code. For further information on the Outline navigation panel, see Administration and Management in Legacy Desktop.

Storage

The Storage tab contains settings that are specific for the selected storage in the Aggregation profile. Different settings are available in batch and real-time workflows.  

File Storage

When using file storage for sessions in a batch workflow, the Storage tab contains a setting to control how often the timeout block should be executed. In this tab, it is also specified when the changes to the aggregation data is written to file.


The Aggregation agent configuration dialog - Storage tab for File Storage


SettingDescription

Session Timeout Interval (seconds)

Determines how often, in seconds, the timeout block is invoked for outdated sessions.

Storage Commit Interval (seconds)

Determines how often, in seconds, the in-memory data is saved to files on disk.

Storage Commit Interval (#Processing Calls)

Determines the number of Processing Calls before the in memory data is saved to files on disk. A 'Processing Call' is an execution of any of the blocks consume, command or timeout.

If both this option and the Storage Commit Interval (seconds) are configured, commits are made when any of them are fulfilled.

Note!

  • If  Storage Commit Interval (seconds) and/or  Storage Commit Interval (#Processing Calls) are configured, data left in memory when the workflow stops will be saved to file.

  • If  Storage Commit Interval (seconds) and Storage Commit Interval (#Processing Calls) are not configured, none of the sessions in-memory are stored on disk. The session count displayed in the Aggregation Inspector will not include these sessions.

  • When the  Max Cached Sessions in the Aggregation profile is exceeded, and  Storage Commit Interval (seconds) and  Storage Commit Interval (#Processing Calls) are not configured, the agent deletes the oldest session. This is done in order to allocate space for the new session while still staying within the limit.

Couchbase Storage

The Aggregation agent configuration dialog - Storage tab for Couchbase


SettingDescription

If Error Occurs in Storage

Select the action that the agent should take when an error occurs in the storage:

  • Ignore  - Discard the UDR.

  • Log Event  - Discard the UDR and generate a message in the System Log.

  • Route  - Send the UDR on the route selected from the on list. This is a list of output routes on which the UDR can be sent. The list is only activated only if  Route  is selected.

Disable TimeoutSelect this check box to disable the timeout handling.

Redis Storage

The Aggregation agent configuration dialog - Storage tab for Redis


SettingDescription

If Error Occurs in Storage

Select the action that the agent should take when an error occurs in the storage:

  • Ignore  - Discard the UDR.

  • Log Event  - Discard the UDR and generate a message in the System Log.

  • Route  - Send the UDR on the route selected from the on list. This is a list of output routes on which the UDR can be sent. The list is only activated if Route is selected.

Disable TimeoutSelect this check box to disable the timeout handling.