Module for EDI 9.12 | Building Services with EDI Module | Part II WmEDIforTN Package | WmEDIforTN Batch Folder | Summary of Elements in this Folder | wm.b2b.editn.batch:batchProcess
 
wm.b2b.editn.batch:batchProcess
WmEDIforTN. Creates batch EDI documents. You do not invoke this service from one of your own services. Rather, Module for EDI registers this service in Trading Networks as a scheduled delivery service and assigns it the name EDI Batch.
You can then define a scheduled delivery queue in Trading Networks and associate the EDI Batch service with the queue. When you define the scheduled delivery queue, you specify the values to use for input when the service is invoked. For more information about batching, see webMethods Module for EDI Installation and User’s Guide.
Input Parameters
queue
String Name of the queue from which to get the EDI documents to batch. Trading Networks provides the name of the queue when it invokes this service.
senderIDQualifier
String For ANSI X12 and UN/EDIFACT, the EDI ID qualifier for the sender, e.g., 01 if the sender is represented as a D-U-N-S number. For TRADACOMS, this specifies the sender code to be used in the transmission.
How the batchProcess service uses senderIDQualifier depends on the value of the oneBatchQueue input parameter.
senderID
String For ANSI X12 and UN/EDIFACT, the sender. For example, if you specified 01 for senderIDQualifier, specify the sender's D-U-N-S number for senderID. For TRADACOMS, this specifies the sender name to be used in the transmission.
How the batchProcess service uses senderID depends on the value of the oneBatchQueue input parameter.
receiverIDQualifier
String For ANSI X12 and UN/EDIFACT, the EDI ID qualifier for the receiver, e.g., 01 if the receiver is represented as a D-U-N-S number. For TRADACOMS, this specifies the receiver code to be used in the transmission.
How the batchProcess service uses receiverIDQualifer depends on the value of the oneBatchQueue input parameter.
receiverID
String The receiver. For example, if you specified 01 for ReceiverIDQualifier, specify the receiver's D-U-N-S number for receiverID. For TRADACOMS, this specifies the receiver name to be used in the transmission.
How the batchProcess service uses receiverID depends on the value of the oneBatchQueue input parameter.
mode
String (optional) The types of envelopes you want the batch EDI document to have. This parameter is only used when oneBatchQueue is NONE. Specify one of the following:
Value
Meaning
IC
Interchange or TRADACOMS transmission envelope only
GP
Group or TRADACOMS batch envelope only
IC&GP
Both interchange and group (or TRADACOMS transmission and batch) envelopes. This is the default.
oneBatchQueue
String (optional) How you want the service to batch the document.
Value
Meaning
SINGLEOUTPUT
Batch the EDI documents in the queue into a single batch EDI document that contains multiple interchanges or transmissions.
With this setting, the batchProcess service uses senderID, senderIDQualifier, receiverID, and receiverIDQualifier to sort EDI documents when an EDI document in the queue does not have headers. In this case, the sender and receiver values are used to determine into which collection and sub-collection areas the transactions in the EDI document should be sorted.
When creating the BizDocEnvelope for the final EDI batch document, the batchProcess service uses the sender and receiver input parameters as the sender and receiver identified in the BizDocEnvelope. As a result, these are the sender and receiver you can use for criteria in a processing rule.
MULTIPLEOUTPUTS
Batch the EDI documents in the queue into multiple batch EDI documents, each with a single interchange or transmission.
With this setting, the batchProcess service uses senderID, senderIDQualifier, receiverID, and receiverIDQualifier to sort EDI documents in the queue when a document in the queue does not have headers. In this case, the sender and receiver values are used to determine into which collection and sub-collection areas the transactions in the EDI document should be sorted.
NONE
This is the default. Batch the documents in the queue using the method provided in version 6.0.1 of the Module for EDI.
With this setting, the batchProcess service uses senderID, senderIDQualifier, receiverID, and receiverIDQualifier to locate the partner-specific EDITPA. The variables that you define in the partner-specific and default EDITPAs determine how the EDI documents in a queue will be combined into the final EDI batch document.
If the EDITPA envelopeIdentifier variables are null in the default and partner-specific EDITPAs, the batchProcess service uses the value you specify for corresponding batchProcess input parameter.
standard
String The EDI standard to use.
*If oneBatchQueue is SINGLEOUTPUT or MULTIPLEOUTPUTS, the batchProcess service only uses standard for an interchange in the batch EDI document when a document in the queue does not have an interchange header. When documents have interchange headers, the batchProcess service uses the standard from the header.
*If oneBatchQueue is NONE, the batchProcess service uses standard for the batch EDI document.
Specify one of the following:
Value
Meaning
X12
VICS
UCS
Use ANSI X12 envelopes (ISA/IEA and GS/GE).
UNEDIFACT
EANCOM
Use UN/EDIFACT envelopes (UNA, UNB/UNZ and UNG/UNT).
TRADACOMS
Use TRADACOMS envelopes (STX/END, BAT/EOB, and MHD/MTR)
version
String Version of the EDI standard for which to build the envelope, e.g., 4010.
Note:
For TRADACOMS, the only valid version is 1.
*If oneBatchQueue is SINGLEOUTPUT or MULTIPLEOUTPUTS, the batchProcess service only uses version for a batch EDI document when a document in the queue does not have headers. When documents have headers, the batchProcess service uses the version from the header.
*If oneBatchQueue is NONE, the batchProcess service uses version for the batch EDI document.
environment
String (optional) The environment to indicate in the envelope headers. Specify either Test or Production.
Note:
For TRADACOMS, the only valid value is Production.
*If oneBatchQueue is SINGLEOUTPUT or MULTIPLEOUTPUTS, the batchProcess service only uses environment for an interchange in the batch EDI document when a document in the queue does not have an interchange header. When documents have interchange headers, the batchProcess service uses the production mode from the header.
*If oneBatchQueue is NONE, the batchProcess service uses environment for the batch EDI document.
controlNumber
String How you want the service to create the control number for the envelope.
Value
Meaning
fromTable
The number from the EDIControlNumber table plus the configured control number increment. The EDIControlNumber table is a module-specific table in the Trading Networks database.
Sequentialize
Sequentialize the control number starting from 1.
groupControlNumber
String How you want the group control numbers (or TRADACOMS batch transmission references) to be created.
Value
Meaning
fromTable
Create the number from the EDIControlNumber table plus the configured control number increment. The EDIControlNumber table is a module-specific table in the Trading Networks database.
sequentialize
Sequence the group or TRADACOMS batch control number according to the value specified for the controlNumber parameter.
none
Do not overwrite the group or TRADACOMS batch control number.
Note:
If groupControlNumber is left blank, the value of contentControlNumber is used.
contentControlNumber
String How you want the transaction control numbers to be created.
Note:
Not applicable to TRADACOMS documents because transmission references always start from 1.
Value
Meaning
sequentialize
Sequence the control number starting from 1.
none
Use the control number from the group or transaction header (or TRADACOMS batch or file header).
removeEmptyRecord
String (optional) Whether you want to remove all the empty records from the batched documents.
Value
Meaning
true
Remove all the empty records from the batched documents. This is the default.
false
Do not remove the empty records from the batched documents.
acknowledgement
String (optional) Whether you want to request FAs for your interchange header segment (UNB/ISA); not applicable to TRADACOMS documents.
Value
Meaning
true
Set the envelope to request an FA.
false
Set the envelope to not request an FA.
delimiters
Document (optional) Delimiters to use when forming the batch EDI document. If you do not specify delimiters, the batchProcess service attempts to obtain the delimiters from the EDITPA. For more information about batching documents, see webMethods Module for EDI Installation and User’s Guide.
Note:
The delimiters parameter is not applicable to TRADACOMS documents. Module for EDI provides built-in support for the following TRADACOMS delimiters: segment terminator, data element separator, sub-element separator, and segment code separator. You cannot modify this list of delimiters.
Key
Description
record
String The segment terminator to use for the batch EDI document, e.g., +.
field
String The field separator for each EDI segment in the batch EDI document, e.g., !.
subfield
String The separator for composite elements in the batch EDI document, e.g., *.
release
String The release character to use for the batch EDI document, e.g., ?.
createGroup
String (optional) Add a group or a TRADACOMS batch.
Value
Meaning
true
Add a group or a TRADACOMS batch
false
Do not add a group or a TRADACOMS batch. This is the default.
priorityCode
String (optional) Add a TRADACOMS priority code and a priority for the batch.
Value
Meaning
urgent
The batch is urgent priority.
normal
The batch is normal priority.
low
The batch is low priority.
processOutput
String Controls how the output of the EDI batch is handled.
Value
Meaning
true
Split the batch document into Interchange, Group, and Transaction documents.
false
Do not split the batch document into Interchange, Group, and Transaction documents. This is the default.
batchMaxCount
Integer The maximum number of transactions the service processes one at a time. The remaining transactions are handled in subsequent executions of the service. If no value is provided, or a zero or a negative value is provided, all queued transactions are processed.
batchGroup
Integer Optional. The number of documents to be retrieved for processing at one time. If no value is provided, or a zero or a negative value is provided, documents are retrieved one by one.
Before using this parameter, ensure your environment has sufficient runtime memory to handle retrieving and loading a large number of documents at one time. If not, ignore batchGroup, and let the documents load one at a time.
Output Parameters
None.
Usage Notes
*For more information about EDITPAs and the variables contained in them, see the chapter on defining partner information in webMethods Module for EDI Installation and User’s Guide.
*For more information about how Module for EDI batches EDI documents, including how this service is used, see the chapter on batching EDI documents in webMethods Module for EDI Installation and User’s Guide.