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:addGroupEnvelope
 
wm.b2b.edi.util:addGroupEnvelope
WmEDI. For outbound EDI documents, adds a group envelope (GS and GE segments) according to the ANSI X12, UCS, or VICS standards.
Note:
For UN/EDIFACT EDI documents, use the wm.b2b.edi.util:addGroupEnvelopeEDIFACT service instead.
Input Parameters
documents
String List Documents to which to add a group envelope.
IDcode
String The Functional ID Code of the EDI document according to the EDI standard.
senderQual
String (optional) EDI ID qualifier for the sender ID. It is used with sender to obtain the Trading Networks internal ID.
sender
String The sender to identify in the group envelope. For example, if you specify 01 for senderQual (indicating a D-U-N-S number), specify the value of the D-U-N-S number for sender.
receiverQual
String (optional) EDI ID qualifier for the receiver ID. It is used with receiver to obtain the Trading Networks internal ID.
receiver
String The receiver to identify in the group envelope. For example, if you specify 01 for receiverQual (indicating a D-U-N-S number), specify the value of the D-U-N-S number for receiver.
grpCtlNumber
String (optional) The group control number of the EDI document.
ctlFromTable
String Whether you want the service to obtain the control number for the group from the EDIControlNumber table, which is a module-specific table in the Trading Networks database.
Value
Meaning
true
Obtain the control number from the EDIControlNumber table.
false
Do not obtain the control number from the EDIControlNumber table. Use the value specified in the grpCtlNumber parameter.
agencyCode
String (optional) Responsible agency code: T (default) or X.
verRelCode
String EDI standard version and release code, e.g., 4010, 3040, etc.
delimiters
Document (optional) Delimiters used in the outbound EDI document.
Key
Description
record
String The segment terminator for the EDI document, e.g., \u000a to use the new line character. The default is the new line 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.
Output Parameters
outDocument
String Contains the outbound EDI string.
Usage Notes
*Only use this service for ANSI X12, UCS, or VICS standards.
*All ANSI X12 documents must have a group envelope. You can add a group envelope either by:
*Using this service and setting the addGroup input parameter of the wm.b2b.edi.util:addICEnvelope service to false. Use this method to control the values used in the group envelope because you can specify them using the input parameters of the addGroupEnvelope service.
*Using wm.b2b.edi.util:addICEnvelope service and setting the addGroup input parameter to true. Use this method if you do not need to control the values used in the group envelope, that is if you can accept the defaults.
Choose only one of these methods. Failing to add a group envelope or creating a group envelope twice will result in an invalid document.
*The ctlFromTable input parameter can be used to control the group control number. If the control number is empty and ctlFromTable is set to true, the group control number for the group type and version is retrieved from the EDIControlNumber table. If ctlFromTable is set to true, make sure that senderQual and receiverQual parameters are specified.