Versions Compared

Key

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

...

Item

Description

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 to the selected storage in the Aggregation profile. Different settings are available in batch and real-time workflows and will change based on the Aggregation Profile selected in the General tab.

...

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.

Debug Events

Debug messages are dispatched in debug mode. During execution, the messages are displayed in the Workflow Monitor.

You can configure Event Notifications that are triggered when a debug message is dispatched. For further information about the debug event type, see Debug Event(4.3).

The agent produces the following debug events:

  • Aggregation Storage implementation
    This event is reported during workflow initialization. It shows the selected storage type, for example, file storage, Couchbase, or Redis.

...

in the

...

code.