An acknowledgment is a document created and sent to the sender in response to
the sender's document. It is to inform the sender of the documents receipt and validity. The acknowledgment also notifies the sender
of what action has been taken -- whether the document has been rejected or if it has been accepted.
When multiple documents are sent by the sender, an acknowledgment for each
document can be created.
Acknowledgments notify the sender of the following things:
Syntactical
correctness of the document.
If
the receiver of the document has accepted or rejected the document.
NOTE:Although the
acknowledgment itself is a document, another acknowledgment MUST NOT be created
in response to a received acknowledgment to prevent an endless cycle of
verifications.
Generating Acknowledgments
For FREDI to automatically generate an acknowledgment of the document that is
being read, the following conditions must be set.
The
properties EnableFunctionalAcknowledgment and/or EnableInterchangeAcknowledgmenthave to be set to TRUE to enable
generation of the Functional Acknowledgment and/or Interchange Acknowledgment
respectively.
For
the ASC/X12 Interchange Acknowledgment, if the acknowledgment option OptAcknowledgment_IgnoreAckRequest
is disabled (set to 0). The Interchange Acknowledgment is generated
depending on the value of the Acknowledgment Requested Data Element
(I13). If the value is "1" then the Interchange Acknowledgment
is enabled.
For
the UN/EDIFACT Syntax and Service Report, if the option OptAcknowledgment_IgnoreAckRequest
is disabled (set to 0). The acknowledgment is generated depending on the
value of the Acknowledgment Requested Data Element (0031). If the value
is "1" then the acknowledgment is enabled.
The
implementation guideline provided and used to process the document
must also have the ASC/X12 Transaction Set or UN/EDIFACT Message definition that will
be used as a guideline to create the acknowledgment.For
ASC/X12, the Functional Acknowledgment Transaction Set identifier is 997;
for UN/EDIFACT the acknowledgment (or syntax and service report) Message identifier is CONTRL.
For the ASC/X12 Interchange Acknowledgment, the definition of the Data Segment
identifier TA1 must be present in the implementation guideline.
Errors detected while processing the EDI document are mapped to acknowledgment error codes, and recorded.Internally, a hierarchical document tree is
created that matches the hierarchical structure of the acknowledgment
transaction set/message defined in the implementation guideline.Data is automatically
populated with default values wherever a data
segment and data element can be identified and their semantic meanings
understood.Because data segments and
data elements are organized hierarchically in a tree, methods and properties
are provided such that they can be located, accessed and edited before the
final decision of saving the acknowledgment document into disk.
Currently, FREDI can only generate the following acknowledgments for ASC/X12
and UN/EDIFACT.
ASC/X12 Functional Acknowledgment (997)
ASC/X12 Interchange Acknowledgment (TA1)
UN/EDIFACT Syntax and Service Report (CONTRL)
Methods
Get997Transport - Returns the Transports object associated with the ASC/X12 Functional Acknowledgment.
GetContrlTransport - Returns the Transports object associated with the UN/EDIFACT Service Report.
GetEdiString - Gets the string containing the entire text of the acknowledgment document.
GetFirst997DataSegment - Returns the first Data Segment in the ASC/X12 Functional Acknowledgment.
GetFirstContrlDataSegment - Returns the first Data Segment in the acknowledgment or service report generated by an EDIFACT document.
GetFirstTA1DataSegment - Returns the first Data Segment in the ASC/X12 Interchange Acknowledgment.
GetTA1Transport - Returns the Transports object associated with the ASC/X12 Interchange Acknowledgment.
MapDataElementLevelError - Maps a Framework EDI standard error code to an acknowledgment code that reports errors in the data element semantic level.
MapDataSegmentLevelError - Maps a Framework EDI standard error code to an acknowledgment code that reports errors in the data segment semantic level.
MapGroupLevelError - Maps a Framework EDI standard error code to an acknowledgment code that reports errors in the Functional Group semantic level.
MapInterchangeLevelError - Maps a Framework EDI standard error code to an Interchange acknowledgment code.
MapMessageLevelError - Maps a Framework EDI standard error code to an acknowledgment code that reports errors in the Message semantic level.
MapTransactionSetLevelError - Maps a Framework EDI standard error code to an acknowledgment code that reports errors in the Transaction Set semantic level.
Save - Saves the acknowledgment to an external file.
Properties
AcceptGroupWithErrors – Allows
the Functional Acknowledgment file being generated to indicate that the Functional Group being checked for syntactical errors should be accepted even if syntactical errors are found.
AcceptSetWithErrors - Allows the Functional Acknowledgment file
being generated to indicate that the Transaction Set being checked for syntactical errors should be accepted even if syntactical errors are found.
AcceptTA1withErrors - Allows the Interchange Acknowledgment file
being generated to indicate that the Interchange being checked for syntactical errors should be accepted even if syntactical errors are found.
CompositeTerminator - Sets or gets the component element terminator used by the acknowledgment.
DecimalNotation - Sets or gets the decimal notation used by the acknowledgment.
ElementTerminator - Sets or gets the data element terminator used by the acknowledgment.
EnableFunctionalAcknowledgment - Enables the generation of the ASC/X12 Functional Acknowledgment or UN/EDIFACT acknowledgment when the EDI document is loaded.
EnableInterchangeAcknowledgment - Enables the generation of the ASC/X12 Interchange Acknowledgment when the EDI file is loaded.
