...
| Table of Contents | ||||
|---|---|---|---|---|
|
An example of how function blocks are used can be found here:
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
initialize
The initialize function block is executed once for each invocation of the workflow and enables you to assign, for example, an argument with an initial value.
...
The beginBatch and endBatch function blocks are executed at the beginning and end of each batch respectively. Rules are that the beginBatch block is called when a batch collection agent emits a Begin Batch call. This occurs either at file start, or when a hintEndBatch call is received from any agent capable of utilizing APL code. See hintEndBatch in Workflow Functions[hide]3.0[/hide] for more information.
The endBatch block is called every time a batch collection agent emits an End Batch. This occurs either at file end, or when a hintEndBatch call is received from any agent capable of utilizing APL code.
...
When handling several types of UDRs in the same Analysis agent, the APL code must first determine what type is currently handled, then cast it to the correct type. For an example, see Data Types[hide]3.0[/hide].types.
drain
| Note | ||
|---|---|---|
| ||
Drain is applicable for batch workflows only. |
...
If the cancelBatch function block is called and the Cancel Batch behavior is set to Abort Immediately the workflow will immediately abort without the cancelBatch function block being called. The block is only called when the preferences are set to Abort After or Never Abort. For further information about the Abort related configurations, see Workflow Properties[hide]3.0[/hide] in the Desktop user's guide.
...