Module for EDI 9.12 | Building Services with EDI Module | Part I WmEDI Package | WmEDI Util Folder | Summary of Elements in this Folder | wm.b2b.edi.util.FA:lite997
 
wm.b2b.edi.util.FA:lite997
WmEDI. Creates a functional acknowledgment (997) that acknowledges EDI documents based on input values.
This service takes AK9 and ICValues IS document (IData object) as input, which is parsed and validated, and creates a 997 as output on the functional group level.
Input Parameters
ICValues
Document Parsed EDI values of envelope, including error results. This IData object contains only one envelope and one functional group.
EDI_delimiters
Document (optional) Delimiters used in the outbound FA.
Value
Meaning
record
String The segment terminator for the FA, e.g., +. The default is the ' character.
field
String The field separator for each EDI segment e.g., !. The default is the + character.
subfield
String The separator for composite elements, e.g., ^. The default is the : character.
release
String Character used to ignore a record, field, or subfield delimiter in a field. If a release character occurs in a field or subfield before the delimiter, it will be prefixed with this character in the output.
AK9
Document The values of the AK9 segment. These values acknowledge the functional group listed from ICValues.
senderIDQualifier
String The EDI ID qualifier of functional group level sender.
receiverIDQualifier
String The EDI ID qualifier of functional group level receiver.
grpCtlNumber
String The group control number of the output 997 document.
ctlFromTable
String Whether you want the service to obtain the control number from the EDITPA (EDI Trading Partner Agreement). Specify true or false.
Value
Meaning
true
Obtain the control number from the EDITPA.
false
Do not obtain the control number from the EDITPA. Use the value specified in the grpCtlNumber parameter.
addGroups
String Whether to add a functional group to the FA.
Value
Meaning
true
Add a functional group to the FA.
false
Do not add a functional group to the FA.
addICEnvelopes
String Whether to add an interchange envelope to the FA. Specify true or false.
Value
Meaning
true
Add an interchange to the FA.
false
Do not add an interchange to the FA.
Output Parameters
outDocument
String The outbound FA string.
Usage Notes
The service does not specify what to do with the acknowledgment that it has created. This service can be used only for the ANSI X12 standards.