Batch headers

These message headers are available to support batch processing for large documents.

In case of batch processing, the data can be sent in multiple documents. The batch information can be included in the message header . Including it in the header can help the receiving application to handle the messages belonging to the same batch without opening the BOD messages. Database connection point AnySQL type is populating batch headers.

For BOD documents it is in most cases available in the message content, in the BODID element.

See Sending documents in batch.

BatchId

The unique ID of the batch. The documents with this number must be processed sequentially on the receiving side.

The BatchId is alphanumeric, maximum length is 250 characters.

BatchSequence

The sequence number of this document in the batch. This is required because the documents can arrive f sequence.

The BatchSequence is numeric, the maximum value is 9223372036854775807.

BatchSize

The total number of documents in the batch. This can be unknown until the last document and omitted for the other documents.

The BatchSize is numeric, the maximum value is 9223372036854775807.

BatchRevision

The revision number of the batch. This is used when one set of documents fails. The complete set can be resent using a new revision number. The revision number must be increasing, but not sequential.

The BatchRevision is numeric, the maximum value is 9223372036854775807.

BatchAbortIndicator

Name of element in BODID abortIndicator

This indicator type attribute is set to true when a system that is sending a batch determines that it is not finishing. The receiving system is notified that any documents received as a part of this batch must be discarded.

The BatchAbortIndicator value is true or false.