BatchCriteria Variables
Batching involves grouping together transactions from all queued EDI documents. You can use the BatchCriteria variables to specify which fields Module for EDI uses to identify the collections and sub-collections by which to batch transactions.
BatchCriteria/useDefault EDITPA Variable
Default: true
The BatchCriteria/useDefault variable indicates whether to consider only the standard fields for sorting the documents in the batching process.
When this variable is not present in the TPA, Module for EDI considers only the standard fields for sorting the documents in the batching process.
Value | Description |
true | Module for EDI considers only the standard fields for sorting the documents in the batching process. |
false | Module for EDI considers the standard fields and all the other fields set to true in UNB, UNG, ISA, and GS records for sorting the documents in the batching process. |
BatchCriteria EDITPA Variable
Default: (no default)
The BatchCriteria variable indicates which fields should be considered during the sorting of documents in the batch process.
When the BatchCriteria/useDefault variable is set to true, Module for EDI considers only the standard fields for sorting the documents in the batching process.
The module considers the following standard fields for sorting the EDIFACT documents to a collection area.
Value | Description |
UNB/UNB02/S00202 | The sender qualifier of the EDIFACT document. |
UNB/UNB02/S00201 | The sender ID of the EDIFACT document. |
UNB/UNB03/S00302 | The receiver qualifier of the EDIFACT document. |
UNB/UNB03/S00301 | The receiver ID of the EDIFACT document. |
UNB/UNB11 | The mode of the EDIFACT document. |
UNG/UNG07/S00802 | The version of the EDIFACT document. |
The module considers the following standard fields for sorting the X12 documents to a collection area.
Value | Description |
ISA/ISA05 | The sender qualifier of the X12 document. |
ISA/ISA06 | The sender ID of the X12 document. |
ISA/ISA07 | The receiver qualifier of the X12 document. |
ISA/ISA08 | The receiver ID of the X12 document. |
ISA/ISA15 | The mode of the X12 document. |
ISA/ISA12 | The version of the X12 document. |
The module considers the following standard fields for sorting the EDIFACT documents to a sub-collection.
Value | Description |
UNG/UNG02/S00601 | The group sender of the EDIFACT document. |
UNG/UNG03/S00701 | The group receiver of the EDIFACT document. |
UNG/UNG06 | The control agency code of the EDIFACT document. |
UNG/UNG07/S00801 | The message version number of the EDIFACT document. |
UNG/UNG07/S00802 | The message release number of the EDIFACT document. |
UNG/UNG07/S00803 | The message association assigned number code of the EDIFACT document. |
UNG/UNG01 | The group type of the EDIFACT document. |
The module considers the following standard fields for sorting the X12 documents to a sub-collection.
Value | Description |
GS/GS02 | The group sender of the X12 document. |
GS/GS03 | The group receiver of the X12 document. |
GS/GS08 | The version of the X12 document. |
GS/GS01 | The group type of the X12 document. |
When the
BatchCriteria/useDefault variable is set to false, in addition to using the standard fields,
Module for EDI considers all the other fields set to true in UNB, UNG, ISA and GS records for sorting the documents. For example, if you want to use the routing address UNB/UNB03/S00303 in addition to the standard fields in the sorting criteria, set
BatchCriteria/UNB/UNB03/S00303 to
true.
BatchCriteria/UNB record fields identify collection areas for EDIFACT documents
BatchCriteria/ISA record fields identify collection areas for X12 documents
BatchCriteria/UNG record fields identify sub-collection areas for EDIFACT documents
BatchCriteria/GS record fields identify sub-collection areas for X12 documents
Note:
Do not include S0010, the syntax identifier field, in the sorting process.