Analysis Agent - Batch(3.0)

The configuration dialog consists of two tabs: Analysis and Thread Buffer.

Analysis Tab

The Analysis tab consists of the following settings:


SettingDescription

Code Area

This is the text area where you enter the APL code, used for UDR processing.

You can enter code manually, you can import it, or you can set an import command to access the generic code created in the APL Code Editor. For further information, see APL Code Editor(3.0).

Below the text area there are line, column and position indicators to assist in finding syntax errors.

Compilation Test...

Compiles the code that you enter, to evaluate the 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.

Note!

The more complex code and formats that you enter, the more time it takes to compile.

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 the section, APL Code Editor Outline, in APL Code Editor(3.0).

UDR Types

Use the Add button to select UDR types. You can select one or more UDR types that the agent expects to receive. For further information, see 9.5.6 Analysis Agent Input and Output Types.

Set To Input

Automatically selects the UDR type distributed by the previous agent.

If the routing of the UDRs, namely the udrRoute command, is omitted, the outgoing connection point disappears from the dialog, so that you cannot connect to a subsequent agent in the workflow.

For further information about the APL Code Editor Assistance in place to help you create APL code, see APL Code Editor Assistance(3.0).

Thread Buffer Tab

You configure the use and settings of private threads for an agent, enabling multi-threading within a workflow, in the Thread Buffer tab. For further information, see the Thread Buffer Tab in Workflow Template (3.0).

Transaction Behavior

Emits

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

Command

Description

End Batch

The agent does not emit End Batch, however it can trigger the collector to do so by calling the method hintEndBatch. See the sections about beginBatch and endBatch in APL Reference Guide(3.0) for information about the method hintEndBatch.

Cancel Batch

If a Cancel Batch is emitted anywhere in the workflow, the workflow aborts depending on how the behavior has been set. See the section about cancelBatch in APL Reference Guide(3.0) for further information.

Hint End Batch

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

Note!

Not all collectors can act upon a call on a hintEndBatch request. Refer to the information for the relevant Collection agent.

Receives

The agent retrieves commands from other agents and, based on them, generates a state change for the file currently being processed.

Command

Description

Begin Batch

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

Cancel Batch

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

End Batch

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