Framework EDI Reference. Constants
Acknowledgment Option ID Constants

Acknowledgment Option ID Constants indicate what feature in the acknowledgment interface can be enabled or disabled.  The following are currently available: 

• OptAcknowledgment_ShowReportingLevel (0) – This option does the following:
• ASC/X12.  Enables/disables showing the transaction set level (AK2/AK5) in the functional acknowledgment (997) output if there are no errors recorded in that level.  By default this option is enabled, that is, AK2/AK5 will be shown even if no syntactical errors were reported at the corresponding transaction set level.
• UN/EDIFACT. Enables/disables showing the group (UCF) and/or message (UCM) response level in the service report message (CONTRL) output if there are no errors recorded in those levels.  By default this option is enabled, that is, UCF and/or UCM is shown even if no errors were reported at the corresponding group and message levels respectively.
• OptAcknowledgment_ReportToSingleInterchange (1) – Enables/disables reporting of errors to an acknowledgment containing only a single interchange.  If this option is disabled when the subject document contains more than one interchange, then separate corresponding interchanges will be created in the acknowledgment document; if enabled, then syntactical errors are reported in a single interchange in the acknowledgment document.  This option is disabled by default.
• OptAcknowledgment_UseGroupVersion (2) – Enables/disables verifying the subject document using the schema having the version specified in the functional group.  When this option is disabled, the subject document is verified for correctness using the schema selected by the version specified in the interchange header.  When this option is enabled, the version specified in the functional group is used instead to select the schema for reference in syntactical correctness verification. 
• OptAcknowledgment_ServiceSegment (3) – Indicates if the document is using the UNA segment to specify its delimiters.  Applicable to UN/EDIFACT.  This options controls the UNA segment as follows: 
  • When a document containing a UNA is read, this option is enabled.  Disabling the option prevents the UNA segment from being written out.
  • When a document not containing a UNA is read, the initial setting of this option is unaffected.  Enabling the option will write out the UNA segment based on the delimiters set for the document.  Disabling the option prevents the UNA segment from being written out.
• OptAcknowledgment_Combine (4) – Combines the interchange acknowledgment (TA1) and the functional acknowledgment (997) into a single interchange in the acknowledgment document. If the option is disabled, the TA1 acknowledgment is enveloped in its own interchange, and separated from the interchange that envelopes the 997 acknowledgment. Applicable to ASC/X12. 
• OptAcknowledgment_IgnoreAckRequest (5) – Ignores the Acknowledgment Request data element value in the Interchange Header control segment. 
  • In ASC/X12, the data element identifier containing this value is I13. The Acknowledgment Request together with the method EnableInterchangeAcknowledgment determines whether an interchange acknowledgment is generated for the subject document. By default, if the value is "1" the acknowledgment is generated, otherwise if the value is "0" the acknowledgment is not generated. If the Acknowledgment Request is ignored then the acknowledgment is generated based on whether it has been manually enabled using only the EnableInterchangeAcknowledgment method.
  • In UN/EDIFACT the data element identifier that requests the Interchange Acknowledgment is 0031. The Acknowledgment Request together with the method EnableFunctionalAcknowledgment or EnableInterchangeAcknowledgment determines whether the CONTRL acknowledgment is generated for the subject document. If the value is "1" the acknowledgment is generated otherwise if the value is "0" the acknowledgment is not generated. If the Acknowledgment Request is ignored then the acknowledgments is generated based on the whether it has been manually enabled using the previous two methods of EnableFunctionalAcknowledgment or EnableInterchangeAcknowledgment to enable the acknowledgments.

• OptAcknowledgment_PartialAcceptGroup (6) - If enabled, accepts the Functional Group if some of the Transaction Sets (X12) or Message (EDIFACT) are not accepted because of errors.  Otherwise the Functional Group is either rejected, or accepted with errors, depending on the OptAcknowledgment_AcceptGroupWithErrors flag.  Note that if all the underlying transaction sets/messages are rejected then the Functional Group is rejected even if this option is enabled.  Default is disabled (0).

• OptAcknowledgment_AcceptSetWithErrors (7) - If enabled, accepts the Transaction Set (X12) or Message (EDIFACT) even if there are underlying errors reported.  Default is disabled (0).

• OptAcknowledgment_AcceptGroupWithErrors (8) - If enabled, accepts the Functional Group even if all underlying Transaction Sets (X12) or Message (EDIFACT) are rejected.  Default is disabled (0).

• OptAcknowledgment_AcceptInterchangeWithErrors (9) - If enabled, accepts the Interchange even if errors are found in the interchange header and trailer data segments. Default as disabled (0).

• OptAcknowledgment_ReadOnlyMode (1001) - Indicates if processing the acknowledgment should be in Read-Only mode. Default as disabled (0).

The Option method enables the feature by setting the value to 1; disables the feature by setting the value to 0.