A message (of type error), which is logged to the System Log when the batch is canceled
It is possible to send an error UDR containing any useful information to the ECS where the batch is sent (if configured to do so). Note that an error UDR may be defined from the Workflow Properties dialog as well. In this case, the APL code overrules the window configuration.
This parameter is optional.
Retrieves the stated dynamic field from the workflow table. The returned value can either be a boolean, an integer, or a string. The fields are configured in the Dynamic Fields tab in the Workflow Properties. See Dynamic Fields Tab in the Desktop User's Guide for further information.
The APL code will not validate unless the dynamic field(s) has been configured in Workflow Properties.
( string category,
string name )
The dynamic field's category
The name of the dynamic field
The value of the selected dynamic field
Large input files can be split into smaller output files using hintEndBatch. The function will send an End Batch message to the other agents in the workflow, possibly causing a split of the current batch being processed. How each agent acts upon such a request can be found out in the respective user's guide; in the Transaction Behavior section. If the workflow does not contain any agent capable of acting upon the request, the workflow will abort.
The hintEndBatch() function is only supported for workflows containing one of the following:
Database Collection agent
Disk Collection agent
FTP Collection agent
A split batch cannot be sent to ECS. Calling cancelBatch after hintEndBatch, will result in workflow abort. However, the original batch can be sent to ECS to make sure to evaluate if the batch will be canceled before it is split.
Puts the current thread to sleep a given number of milliseconds before resuming execution. This is mostly used for simulation, for instance, traffic shaping or limiting the number of calls to an external system.
( long milliseconds )
The number of milliseconds the current thread will sleep before resuming execution.
Stops a running workflow. wfStopproduces a single stop signal and does not wait for the workflow to stop. If it succeeds in stopping the workflow, the stop is registered in the System Log.