Module for EDI 9.12 | Building Services with EDI Module | Part II WmEDIforTN Package | WmEDIforTN Util Folder | Summary of Elements in this Folder | wm.b2b.editn.util.reprocess:validateControlNumber
 
wm.b2b.editn.util.reprocess:validateControlNumber
WmEDIforTN. Determines whether the specified control number is the one expected for the specified sender/receiver pair.
If the specified control number (in the numberToValidate input parameter) matches the next expected control number for the sender/receiver pair, this service updates the next expected control number.
This service calculates the new expected control number by adding the specified control number (in numberToValidate) to the configured control number increment. If the result exceeds the configured control number cap, this service sets the next expected control number to the configured control number minimum. For more information about control numbers, see webMethods Module for EDI Installation and User’s Guide.
Input Parameters
senderID
String The sender ID associated with the control number.
senderQualifier
String (optional) The sender EDI ID qualifier associated with the control number.
receiverID
String The receiver ID associated with the control number.
receiverQualifier
String (optional) The receiver EDI ID qualifier associated with the control number.
standard
String EDI standard associated with the control number. Specify one of the following: X12, UNEDIFACT, VICS, UCS, -or- EANCOM.
productionMode
String Production mode associated with the control number. Specify one of the following: Production (default), Test, or Custom.
version
String Version of the EDI standard for the control number, e.g., 4010.
isEnvelope
String Whether the control number is for an envelope or a group.
Value
Meaning
true
The control number is associated with an envelope.
false
The control number is associated with a group.
groupType
String (optional) The group type associated with the control number.
*For an interchange control number, specify ENVELOPE.
*For group control numbers, specify the group type. For example, for ANSI X12 4010 850, specify PO.
createIfNotFound
String Whether you want to create an entry for this control number this sender/receiver pair if there is currently no entry.
Value
Meaning
true
Creates a control number entry for the specified sender/receiver, production mode, standard and version combination and sets the next expected control number.
The next expected control number is calculated by adding the specified control number (in numberToValidate) to the configured control number increment. If the result exceeds the configured control number cap, the next expected control number is set to the configured control number minimum.
false
Does not create a control number entry for the specified sender/receiver, production mode, standard and version combination.
numberToValidate
String The control number that you want to validate.
Output Parameters
result
String Whether the control number you specified in numberToValidate is valid. The value of result will be one of the following:
Value
Meaning
Valid
The control number that you specified is valid and the next expected control number has been incremented.
OutOfSequence
The control number that you specified is not valid. The service has determined that the control number is out-of-sequence.
Duplicate
The control number that you specified is not valid. The service has determined that the control number is a duplicate.