Return to EDIFACT D00B Messages page.Application error and acknowledgement message
0. INTRODUCTIONThis specification provides the definition of the Application error and acknowledgement message (APERAK) to be used in Electronic Data Interchange (EDI) between trading partners involved in administration, commerce and transport. 1. SCOPE1.1. Functional definitionThe function of this message is:
1.2. Field of applicationThe Application error and acknowledgement message may be used for both national and international applications. It is based on universal practice related to administration, commerce and transport, and is not dependent on the type of business or industry. 1.3. PrinciplesA message being first controlled at system level (CONTRL) to detect syntax errors and to acknowledge its receipt is then transmitted to the application process to be processed. If an error is detected at the application level, which prevents its complete processing, an APERAK message is sent to the original message issuer giving details of the error(s) encountered. If no error has been detected and when an acknowledgement is necessary (when no dedicated answer to the original message exists) an APERAK message is sent precising the reasons of acknowledgement. In case of application error, the APERAK message will need manual processing e.g. when the underlying reason is a programming error. In case of acknowledgement the APERAK message may be automatically or manually processed at recipient's discretion. 2. REFERENCESSee UNTDID, Part 4, Chapter 2.3 UN/ECE UNSM - General Introduction, Section 1. 3. TERMS AND DEFINITIONS3.1. Standard terms and definitionsSee UNTDID, Part 4, Chapter 2.3 UN/ECE UNSM - General Introduction, Section 2. 4. MESSAGE DEFINITION4.1. Segment clarificationThis section should be read in conjunction with the segment table which indicates mandatory, conditional and repeating requirements. 0010 UNH, Message headerA 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:
0020 BGM, Beginning of messageA segment to indicate the type and function of the message and to transmit the identifying number. 0030 DTM, Date/time/periodA segment to specify related date/time. 0040 FTX, Free textA 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. 0050 CNT, Control totalA segment to provide message control totals. 0060 Segment Group 1: DOC-DTMA segment group to provide information on the document being acknowledged. 0070 DOC, Document/message detailsA segment to provide the necessary identification information about the document being acknowledged. 0080 DTM, Date/time/periodA segment to provide the relevant dates concerning the document being acknowledged. 0090 Segment Group 2: RFF-DTMA group of segments to specify the document/message to which the current message relates, and related date and time. 0100 RFF, ReferenceA segment to indicate the reference number of the document/message. 0110 DTM, Date/time/periodA segment to specify the date and time of the referenced document/message. 0120 Segment Group 3: NAD-CTA-COMA group of segments to specify the identifications of message sender and message receiver with their contacts and communication channels. 0130 NAD, Name and addressA segment to specify the identification of the message issuer and message receiver. 0140 CTA, Contact informationA segment to specify a person or department inside the party's organization, to which communication should be directed. 0150 COM, Communication contactA segment to indicate communication channel type and number inside the party's organization, to which communication should be directed. 0160 Segment Group 4: ERC-FTX-SG5A group of segments to identify the application error(s) within a specified received message and to give specific details related to the error type or to precise the type of acknowledgement. 0170 ERC, Application error informationA 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). 0180 FTX, Free textA 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. 0190 Segment Group 5: RFF-FTXA group of segments to specify the functional entity reference (e.g. goods item level, equipment level) relating to the specified error; further details can be added to identify the error more precisely. 0200 RFF, ReferenceA segment to provide a reference relating to the acknowledgement type or the specified error (e.g. functional entity reference such as equipment level). 0210 FTX, Free textA segment to provide additional details relating to the reference, e.g. the content of the wrong data (and its exact place in the message). 0220 UNT, Message trailerA 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. 4.2. Segment index (alphabetical sequence by tag)
4.3. Message structure4.3.1. Segment table
|