Versions Compared

Version Old Version 2 New Version Current
Changes made by

Former user

Former user

Saved on

Key

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

...

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.

...

Syntax to run the command function block from mzsh:

Code Block
$ mzsh wfcommand <Workflow Name> <Agent Name> <"true"|"false"> <instruction>

...

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 the package, Batch Aggregation APL Flush Function.

The APL function aggregationHintFlushSessions may can be called from the Analysis APL code or Aggregation APL code in batch workflows.

...


ParameterDescription

aggregationAgentName

The name of an Aggregation agent in the batch workflow


Info
titleExample - Using aggregationHintFlushSessions

For example, consider a batch workflow containing one Aggregation agent named "Agg" which has the Aggregation agent property If Timeout is Missing set to Default. Also, consider that the beginBatch function block and the timeout function block in the APL code for the Aggregation agent are is defined as in the following code:

Code Block
beginBatch {            
    aggregationHintFlushSessions("Agg");        
}

timeout {
    sessionRemove(session);
}

Finally, consider that there are 10 sessions, with timeout values in the distant future, in the storage when the end of the drain function block in the Aggregation agent has been reached. Then the timeout function block will be executed 10 times, one time for every session in the storage, and thus all the sessions in the storage will be removed.


...