Sending documents in batch
Avoid sending large documents. Documents up to 5 MB are handled throughout ION.
Do not include large files inside the documents, for example, images or PDF files. Instead, make the files available in a document management system or another location. Include a reference (URL) in the document.
Sometimes you must divide a large file into multiple documents. For example, the first document can contain a header and the first 100 lines. The next document can contain the next 100 lines. Each document must be valid.
Batch message headers are used to indicate that the document is part of a batch. Batch fields should not be sent for single documents (batch size = 1).
For BODs, Batch fields are used to indicate that the BOD is part of a batch. The batch fields must be included inside the BOD XML, in the BODID, and can be included in the message header. The message header fields are optional. We recommend that you include them. It allows the receiver to handle the batch without having to open each BOD to determine the correct sequence. Note that the total length for the BODID cannot exceed 255 characters.
The data types and maximum lengths of the header fields are specified in the table.
This table shows the fields to use:
| Header Field Name | Name of element in BODID | Description |
|---|---|---|
| BatchId | 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 | batchSequence | The sequence number of this document in the batch. This is
required because the documents can arrive out of sequence. The BatchSequence is numeric, the maximum value is 9223372036854775807. |
| BatchSize | 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 | 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 does not have to be
sequential. The BatchRevision is numeric, the maximum value is 9223372036854775807. |
| BatchAbortIndicator | abortIndicator | This indicator type
attribute is set to true when a system that is sending a batch
determines that it will not finish. The receiving system is notified
that any documents received as a part of this batch must be discarded.
The BatchAbortIndicator value is either ‘true’ or ‘false’. |
For example, publishing daily balance updates through SourceSystemGLMovement BOD. Often you must split the BOD. It is assumed that the tenant is ‘acme’, the accounting entity is 10 and the location is 1. The subsequence BODIDs is one of these options:
Infor-nid:acme:10:1_A:0?SourceSystemGLMovement&verb=Sync&batchSequence=1&batchID=lid://infor.sunsystems.5:1Infor-nid:acme:10:1_A:0?SourceSystemGLMovement&verb=Sync&batchSequence=2&batchID=lid://infor.sunsystems.5:1Infor-nid:acme:10:1_A:0?SourceSystemGLMovement&verb=Sync&batchSequence=3&batchID=lid://infor.sunsystems.5:1&batchSize=3