Versions Compared

Old Version 2

changes.mady.by.user Kevin Wu

Saved on

compared with

New Version 3

changes.mady.by.user Kevin Wu

Saved on

Key

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

The batch Aggregation agent's configuration dialog contains the following tabs:

...


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>.

Compilation Test...

Use this button to compile your code and check that it is valid. 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>.


Storage Tab

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

The Aggregation agent configuration dialog - Storage tab for File Storage


SettingDescription

Defragment Session Storage Files

For batch workflows, the Aggregation session storage can optionally be defragmented to minimize disk usage. When checked, configure the defragmentation parameters:

Defragment After Every [] Batch(es)

Run defragmentation after the specified number of batches. Enter the number of batches to process before each defragmentation.

Defragment if Batch(es) Finishes Within [] Second(s)

Set a value to limit how long the defragmentation is allowed to run. This time limitation depends on the execution time of the last batch processed. If the last batch is finished within the specified number of seconds, the remaining time will be used for the defragmentation. The limit accuracy is +/- 5 seconds.

Defragment Session Files Older Than [] Minute(s)

Run defragmentation on session storage files that are older than this value to minimize moving recently created sessions unnecessarily often.

Elasticsearch Storage

Image Modified

The Aggregation agent configuration agent - Storage tab for Elasticsearch

Setting

Description

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.

Meta Information Model

The Aggregation agent publishes different MIM parameters depending on the storage selected in the Aggregation profile. For information about the MediationZone MIM and a list of the general MIM parameters, see Administration and Management[hide]3.0[/hide].

Publishes

File Storage

The MIM parameters listed in this section are applicable when File Storage or SQL Storage is selected in the Aggregation profile.

The values of the MIM parameters below are reset when the EC is started.


MIM Parameter

Description

Created Session Count

This MIM parameter contains the number of sessions created.

Created Session Count is of the long type and is defined as a global MIM context type.

You can reset the value by using resetCounters via a JMX client. See 7.5 Aggregation Monitoring for further information.

Online Session Count

This MIM parameter contains the number of sessions cached in memory.

Online Session Count  is of the int type and is defined as a global MIM context type.

Session Cache Hit Count

When an already existing session is read from the cache instead of disk, a cache hit is counted.

This MIM parameter contains the number of cache hits.

...

Session Cache Hit Count is of the long type and is defined as a global MIM context type.

You can reset the value by using resetCounters via a JMX client. See 7.5 Aggregation Monitoring for further information.

Session Cache Miss Count

When an already existing session is requested and the Aggregation profile cannot read the session information from the cache and instead reads the session information from disk, a cache miss is indicated. If a non-existing session is requested, this will not be counted as a cache miss.

This MIM parameter contains the number of cache misses counted by the Aggregation profile.

Session Cache Miss Count is of the long type and is defined as a global MIM context type.

You can reset the value by using resetCounters via a JMX client. See 7.5 Aggregation Monitoring for further information.

Session Count

This MIM parameter contains the number of sessions in storage on the file system.

Session Count is of the int type and is defined as a global MIM context type.

Elasticsearch Storage

The MIM parameters listed in this section are applicable when Elasticsearch is selected in the Aggregation profile.  The values of the MIM parameters below are reset when the workflow is started.

MIM Parameter

Description

Created Session Count

This MIM parameter contains the number of sessions created.

Created Session Count is of the long type and is defined as a global MIM context type.

You can reset the value by using resetCounters via a JMX client. See 7.5 Aggregation Monitoring for further information.

Online Session Count

For Elasticsearch, the value for this MIM parameter is always 0. This MIM parameter is retained for Elasticsearch to retain backwards compatitlity for workflows created with File Storage.

Online Session Count  is of the int type and is defined as a global MIM context type.

Session Cache Hit Count

When an already existing session is read from the cache instead of disk, a cache hit is counted.

For Elasticsearch, the value for this MIM parameter is always 0. This MIM parameter is retained for Elasticsearch to retain backwards compatitlity for workflows created with File Storage.

Session Cache Hit Count is of the long type and is defined as a global MIM context type.

You can reset the value by using resetCounters via a JMX client. See 7.5 Aggregation Monitoring for further information.

Session Cache Miss Count

When an already existing session is requested and the Aggregation profile cannot read the session information from the cache and instead reads the session information from disk, a cache miss is indicated. If a non-existing session is requested, this will not be counted as a cache miss.

For Elasticsearch, the value for this MIM parameter is always 0. This MIM parameter is retained for Elasticsearch to retain backwards compatitlity for workflows created with File Storage.

Session Cache Miss Count is of the long type and is defined as a global MIM context type.

You can reset the value by using resetCounters via a JMX client. See 7.5 Aggregation Monitoring for further information.

Session Count

This MIM parameter contains the number of sessions in storage on the file system.

Session Count is of the int type and is defined as a global MIM context type.

Transaction Behaviour

Emits

The agent emits commands that change the state of the file currently processed.

Command

Description

Cancel Batch

The agent itself does not emit Cancel Batch messages. However, if the code contains a call to the method cancelBatch this causes the agent to emit a Cancel Batch.

Hint End Batch

If the code contains a call to the method hintEndBatch, this causes the agent to emit a Hint End Batch.

Retrieves

The agent retrieves commands from other agents and, based on those commands, changes the state change of the file currently processed.

Command

Description

Begin Batch

When a Begin Batch message is received, the agent calls the beginBatch function block, if present in the code.

End Batch

When an End Batch message is received, the agent calls the endBatch function blocks, if present in the code.

Prior to End Batch, possible timeouts are called. Thus, when a time limit is reached, the timeout function block will not be called until the next End Batch arrives. If the workflow is in the middle of a data batch or is not currently receiving any data at all, this could potentially be some time after the configured timeout.

Cancel Batch

When a Cancel Batch message is received, the agent calls the cancelBatch function block, if present in the code.


...