Versions Compared

Key

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

This section describes how to flush aggregation sessions in real-time and batch workflows.


Anchor
command - Real-Time Only
command - Real-Time Only
command - Real-Time Only

To flush Real-time workflow sessions, run an agent command from the Command Tab of the Aggregation agent in the Workflow Monitor or use the Command Line Tool mzsh. There is a choice of applying the command on all sessions or only on those with a timeout set. There is also an option of attaching information in a string to be available within the command function block in the Aggregation agent.

...


ParameterDescription

Workflow Name

The name of the workflow that contains the Aggregation agent

Agent Name

The name of the Aggregation agent in the workflow

"true"|"false"

Specifies what sessions to apply the command block for. true means apply on all sessions, while false means apply only on sessions with timeout set. To have the sessions removed, the command block must issue sessionRemove(session).

instruction

This is an optional string. If specified, the string will be available within the command function block in the Aggregation agent through the instruction variable. Refer to 3.2 Variables for further information.


Info
titleExample - Using command

A simple APL example of command:

Code Block
command {
  OutputUDR finalUDR = udrCreate( OutputUDR );
  finalUDR.user = session.user;
  finalUDR.IPAddress = (string)session.IPAddress;
  finalUDR.downloadedBytes = session.downloadedBytes;
  finalUDR.uploadedBytes = session.uploadedBytes;
  if (instruction == "extra") { finalUDR.extraBytes = session.extraBytes; }
  udrRoute( finalUDR );
  sessionRemove(session);
} 



Batch Aggregation APL Flush Function

This section describes the APL function aggregationHintFlushSessions, which is used to timeout all stored sessions that have a timeout value in a batch Aggregation agent. The function is included in the package Batch Aggregation APL Flush Function.

...