TRADACOM Variables

TRADACOM Variables

TRADACOMS/splitOption EDITPA Variable

Default: File

This variable indicates how you want Module for EDI to split a transmission segment within an EDI document. The module creates the following types of documents from a transmission segment, based on the value of this variable:

Transmission documents that contain the single transmission envelope along with its batch segment and file

Batch documents that contain a single batch segment along with its files

File documents that contain a single file

If you want to perform processing on the file in an inbound document, set splitOption to File or Batch. If you are sending the inbound EDI document through Trading Networks to simply deliver it to a destination without processing the file, set splitOption to Transmission.

Note: Validation errors can prevent Module for EDI from splitting a transmission document. The kinds of errors that will cause splitOption to fail are listed in Errors that Prevent the Splitting of Transmissions.

The following table lists the possible values for this variable and the types of documents that Module for EDI creates for each value.

Value	Description
Transmission	Creates only the Transmission document.
Batch	Creates the Transmission document and a Batch document for each batch segment in the transmission segment.
File	Creates the Transmission document, a Batch document for each batch segment in the transmission segment, and a File document for each file in the transmission segment. This is the initial value for the splitOption variable in the default EDITPA.

TRADACOMS/storageOption EDITPA Variable

Default: One Message

If a File document contains many detail messages, My webMethods may not be able to display all of the content parts. In this case, you may want to consider using an alternative storage option.

Value	Description
One Message	Default. For a TRADACOMS File, Trading Networks creates one File document type that contains all the detail messages contained in the file.
N Messages	Instead of storing all detail messages in a single File document type, Trading Networks creates a separate File document type for each detail message. For more information, see Storage Options for File Document Types.

Note: When you use the Monitoring > Integration > B2B > Transaction page to view transactions, and the value of storageOption is One Message, the control number displayed is the control number in the FIL segment. If the value of storageOption is N Messages, the control number displayed is taken from the sequence number in the MHD segment.

TRADACOMS/ControlNumberManagement/validateInboundTransmissionControlNumbers EDITPA Variable

Default: false

This variable indicates whether you want Module for EDI to validate and track control numbers in the transmission headers of inbound EDI documents.

Value	Description
true	Validates and tracks control numbers in the transmission headers of inbound EDI documents.
false	Does not validate or track control numbers in the transmission headers of inbound EDI documents.

TRADACOMS/ControlNumberManagement/validateInboundBatchControlNumbers EDITPA Variable

Default: false

This variable indicates whether you want Module for EDI to validate and track control numbers in the batch headers of inbound EDI documents.

Value	Description
true	Validates and tracks control numbers in the batch headers of inbound EDI documents.
false	Does not validate or track control numbers in the batch headers of inbound EDI documents.

TRADACOMS/ControlNumberManagement/validateInboundFileControlNumbers EDITPA Variable

Default: false

This variable indicates whether you want Module for EDI to validate and track control numbers in the file headers of inbound EDI documents.

Value	Description
true	Validates and tracks control numbers in the file headers of inbound EDI documents.
false	Does not validate or track control numbers in the file headers of inbound EDI documents.

TRADACOMS/ControlNumberManagement/duplicateControlNumberAction EDITPA Variable

Default: Error & Continue

This variable indicates the action you want Module for EDI to take when it encounters a duplicate control number in an inbound document when it is validating transmission and/or batch control numbers.

For more information about each of the following actions, see Actions Module for EDI Can Take for Invalid Control Numbers.

Value	Description
Error & Continue	Module for EDI logs the error and then continues normal processing of the EDI document that contains the invalid control number.
ProcessNormally	Module for EDI logs a warning and then continues normal processing of the EDI document that contains the invalid control number.
Reject	Module for EDI logs the error and then sends the document to Trading Networks without splitting it. (Typically, Module for EDI splits an inbound EDI based on the EDITPA splitOption variable and sends the split documents to Trading Networks for processing.) Additionally, Module for EDI sets the Trading Networks custom attribute EDI Status to Duplicate Control Number. You can use the custom attribute EDI Status in processing rule criteria. You should create a processing rule to handle this rejected document. For information, see Defining Processing Rules to Handle Documents with Invalid Control Numbers. If desired, you can force a duplicate document to be processed later. For more information, see Reprocessing EDI Documents with Invalid Control Numbers.

TRADACOMS/ControlNumberManagement/outOfSequenceControlNumberAction EDITPA Variable

Default: Error & Continue

This variable indicates the action you want Module for EDI to take when it encounters an out-of-sequence control number in an inbound document while it is validating transmission and/or batch control numbers.

For more information about each of the following actions, see Actions Module for EDI Can Take for Invalid Control Numbers.

Value	Description
Error & Continue	Logs the error; then continues normal processing of the EDI document that contains the invalid control number.
ProcessNormally	Logs a warning and continues normal processing of the EDI document that contains the invalid control number.
Reject	Logs the error and sends the document to Trading Networks without splitting it. Typically, Module for EDI splits an inbound EDI based on the EDITPA splitOption variable and sends the split documents to Trading Networks for processing. Additionally, the module sets the Trading Networks custom attribute EDI Status to Out of Sequence Control Number. You can use the custom attribute EDI Status in processing rule criteria. You should create a processing rule to handle this rejected document. For information, see Defining Processing Rules to Handle Documents with Invalid Control Numbers. You can later force processing of the out-of-sequence document if you want. For more information, see Reprocessing Documents with Out-of-Sequence Control Numbers.

TRADACOMS/enforceApplicationReference EDITPA Variable

Default: false

This variable is used to validate that the contents of the APRF field in the STX segment match the file type of the messages in the transmission.

Value	Description
true	Validates that the APRF field contents match the file type of the messages.
false	Does not perform APRF validation.

TRADACOMS/OutBound/createReconciliationMessage EDITPA Variable

Default: false

This variable indicates whether Module for EDI creates a reconciliation (RSGRSG) message in outbound batched EDI documents.

Value	Description
true	Creates an RSGRSG message at the end of the transmission for the batched TRADACOMS document.
false	Does not create an RSGRSG message.

TRADACOMS/OutBound/recipientTransmissionReference EDITPA Variable

Default: false

(optional) This variable indicates whether Module for EDI returns the receiver's transmission reference in outbound EDI documents.

Value	Description
true	Returns the receiver's transmission reference in outbound EDI documents.
false	Does not return the receiver's transmission reference.

TRADACOMS/OutBound/applicationReference EDITPA Variable

(optional) This variable returns the value of the receiver's application reference field (the APRF field in the STX segment) in outbound EDI documents.

Note: This variable is ignored if the TRADACOMS/Outbound/applicationReferenceFromFile variable is set to true.

TRADACOMS/OutBound/applicationReferenceFromFile EDITPA Variable

Default: false

(optional) This variable indicates whether Module for EDI returns the value of the receiver's application reference field (the APRF field in the STX segment) in outbound EDI documents. In this case, the value of the APRF field is the file type specified in the transmission. For example, if the transmission contains ORDERS files, the value of the APRF field will be ORDHDR.

Value	Description
true	Returns the value of the APRF field, which is the file type specified in the transmission, for example, ORDHDR.
false	Uses the value specified for the TRADACOMS/Outbound/applicationReference variable.

TRADACOMS/persistMultipleDocEnvelope EDITPA Variable

Default: true

This variable indicates whether Module for EDI saves the original EDI document in the Trading Networks database. The original EDI document that Trading Networks receives typically contains multiple transmission segments. The module only uses the persistMultipleDocEnvelope variable from the default EDITPA.

Note: Module for EDI splits each transmission segment within the original EDI document into Transmission, Batch, and File documents based on the setting of the TRADACOMS/splitOption EDITPA variable. You can control whether the Transmission, Batch, and File documents are saved to the Trading Networks database via a processing rule.

Value	Description
true	Saves the original EDI document to the Trading Networks database. Note that the document is saved with the sender and receiver both set to Unknown. This is the default. Note: This behavior occurs only if the original EDI document contains multiple transmission segments.
false	Does not save the original EDI document to the Trading Networks database. If you specify false, you will not have a way to retrieve the original EDI document.

TRADACOMS/publishBatchFailEvent EDITPA Variable

Default: false

This variable indicates whether Module for EDI publishes an IS document when it cannot include an EDI document that is queued for batching into the final batch EDI document. The format of the IS document is defined by the wm.b2b.editn.publishedDocs:batchFailDocument service. For more information about this IS document type, see webMethods Module for EDI Built-In Services Reference . For more information about how this EDITPA variable is used during batching and how to handle failure to publish an IS document, see Updating the Task Status and Publishing Documents for Failed Tasks.

Value	Description
true	Publishes an IS document when it encounters errors including an EDI document into the final batch EDI document.
false	Does not publish an IS document when it encounters errors including an EDI document into the final batch EDI document.