APERAK Application error and acknowledgement

TBG3 Transport

The function of this message is: a) to inform a message issuer that his message has been received by the addressee's application and has been rejected due to errors encountered during its processing in the application. b) to acknowledge to a message issuer the receipt of his message by the addressee's application.

Header

1. 00010 · UNH · Message header · Max 1 · Mandatory

   A service segment starting and uniquely identifying a message. The message type code for the Application error and acknowledgement message is APERAK. Note: Application error and acknowledgement messages conforming to this document must contain the following data in segment UNH, composite S009: Data element 0065 APERAK 0052 D 0054 17B 0051 UN

   1. Data element S009/0057 is retained for upward compatibility. The use of
   S016 and/or S017 is encouraged in preference.
   2. The combination of the values carried in data elements 0062 and S009 shall
   be used to identify uniquely the message within its group (if used) or if
   not used, within its interchange, for the purpose of acknowledgement.

2. 00020 · BGM · Beginning of message · Max 1 · Mandatory

   A segment to indicate the type and function of the message and to transmit the identifying number.

3. 00030 · DTM · Date/time/period · Max 9 · Conditional

   A segment to specify related date/time.

4. 00040 · FTX · Free text · Max 9 · Conditional

   A segment to specify free form or processable supplementary information related to the whole message. In computer-to-computer exchanges free form text will normally require the receiver to process this segment manually.

5. 00050 · CNT · Control total · Max 9 · Conditional

   A segment to provide message control totals.

6. Segment group 1 Repeat 99

   1. 00070 · DOC · Document/message details · Max 1 · Mandatory

      A segment to provide the necessary identification information about the document being acknowledged.

   2. 00080 · DTM · Date/time/period · Max 99 · Conditional

      A segment to provide the relevant dates concerning the document being acknowledged.

7. Segment group 2 Repeat 9

   1. 00100 · RFF · Reference · Max 1 · Mandatory

      A segment to indicate the reference number of the document/message.

   2. 00110 · DTM · Date/time/period · Max 9 · Conditional

      A segment to specify the date and time of the referenced document/message.

8. Segment group 3 Repeat 9

   1. 00130 · NAD · Name and address · Max 1 · Mandatory

      A segment to specify the identification of the message issuer and message receiver.

   2. 00140 · CTA · Contact information · Max 9 · Conditional

      A segment to specify a person or department inside the party's organization, to which communication should be directed.

   3. 00150 · COM · Communication contact · Max 9 · Conditional

      A segment to indicate communication channel type and number inside the party's organization, to which communication should be directed.

9. Segment group 4 Repeat 99999

   1. 00170 · ERC · Application error information · Max 1 · Mandatory

      A segment identifying the type of application error or acknowledgement within the referenced message. In case of an error, the error code may specify the error in detail (e.g. a measurement relating to a piece of equipment is wrong) or as a rough indication (e.g. a measurement is wrong).

   2. 00180 · FTX · Free text · Max 1 · Conditional

      A segment to provide explanation and/or supplementary information related to the specified application error or acknowledgement. For example, the explanation may provide exact details relating to a generic error code.

   3. Segment group 5 Repeat 9

      1. 00200 · RFF · Reference · Max 1 · Mandatory

         A segment to provide a reference relating to the acknowledgement type or the specified error (e.g. functional entity reference such as equipment level).

      2. 00210 · FTX · Free text · Max 9 · Conditional

         A segment to provide additional details relating to the reference, e.g. the content of the wrong data (and its exact place in the message).

10. 00220 · UNT · Message trailer · Max 1 · Mandatory

    A service segment ending a message, giving the total number of segments in the message (including the UNH & UNT) and the control reference number of the message.

    1. 0062, the value shall be identical to the value in 0062 in the
    corresponding UNH segment.