EDI TPA parameters

GSRouting
webMethods B2B creates Interchange, Group, and Transaction documents based on the splitOption variable in the EDITPA.
PersistMultipleDocEnvelope
The persistMultipleDocEnvelope variable indicates whether webMethods B2B saves the original document in the webMethods B2B database.
processingMode
The processingMode variable indicates whether the partners that use the EDITPA are in testing, production, or custom mode.
splitOption
The splitOption variable defines how webMethods B2B splits an interchange segment within an EDI document.
FAReconciliation
The FAReconciliation variable indicates whether to enable FA reconciliation.
UNAmode
The UNAmode variable indicates whether you want to create a UNA segment to precede the interchange in an outbound UN/EDIFACT EDI document.
delimiters
The delimiters/record variable indicates the segment terminator to use in an outbound EDI document.
envelopeIdentifier
The envelopeIdentifier variables consist of ID and qualifier variables for senders and receivers.
ICheaderInfo
The ICheaderInfo variables indicate the values to use for ANSI X12 interchange and group headers and UN/EDIFACT UNB headers in outbound EDI documents.
FAGeneration
The FAGeneration/autoGenerateFA variable indicates whether you want webMethods B2B to automatically generate FAs for an inbound EDI document.
ControlNumberManagement
The control number variables indicate whether you want to validate and track control numbers in the interchange headers of inbound EDI documents.
BatchCriteria
Grouping transactions from all queued EDI documents.
persistOriginalEnvelope
The persistOriginalEnvelope variable indicates whether to persist the original incoming EDI envelope in webMethods B2B before webMethods B2B starts processing the EDI envelope.
documentPersistOrder
The documentPersistOrder variable indicates the order in which the EDI documents are submitted to webMethods B2B .

GSRouting

webMethods B2B creates Interchange, Group, and Transaction documents based on the splitOption variable in the EDI TPA. The GSRouting variables indicate the value for the sender and receiver in these documents.

The values that you select for the GSRouting variables determine:

  • How you define the criteria for processing rules when you create them for the Interchange, Group, and Transaction documents. You can use the sender and receiver as criteria in the processing rules.
  • The ID types and values that you define in the partner profiles. For webMethods B2B to match the sender and receiver criteria in a processing rule, define a partner profile with an ID type and value that match the value in the interchange, group, and transaction documents.
routingMode
The default value is OFF.

The routingMode variable indicates how webMethods B2B obtains the sender and receiver for each type of document. The examples use the following headers:

ISA*00**00**01*123456789*ZZ*987654321*020201*1535*U*00300*000004323*0*P
GS*PO*901234572000*908887732000*020201*1535*4369*X*003020
GSOnly
webMethods B2B determines the sender and receiver for different transactions.
  • For Interchange documents, webMethods B2B uses the interchange header. For example, the sender uses EDI ID qualifier 01 with value 123456789 and the receiver uses the EDI ID qualifier ZZ with the value 987654321.
  • For Group and Transaction documents, webMethods B2B uses the group header. For example, the sender uses the value 901234572000 and the receiver uses the value 90888773200.
For more information about the EDI ID qualifiers, see the senderQualifier and receiverQualifier variables.
GS&ISA
webMethods B2B determines the sender and receiver that is described in the following sample payload- ISA*00* *00**01*123456789 *ZZ*987654321 *020226*1534*U*00401*000000009*0*T*>~ GS*PO*901234572000*908887732000*20020226*1534*1*X*003041~

For Interchange documents, webMethods B2B uses the interchange header. For example, the sender uses EDI ID qualifier 01 with value 123456789 and the receiver uses the EDI ID qualifier ZZ with the value 987654321. Ensure that your Interchange segment contains ‘ZZ’ in uppercase.

For Group and Transaction documents, webMethods B2B derives the sender by concatenating ISA05, ISA06, and GS02 fields, using a colon (:) separator. webMethods B2B derives the receiver ID by concatenating ISA07, ISA08, and GS03.For example, the sender is identified as 01:123456789:901234572000 and the receiver is identified as ZZ:987654321:908887732000. The EDI ID qualifiers are always ZZ (Mutually Defined) when you use GS&ISA. Add these concatenated values as the external identifiers in the corresponding partner profiles with the ID type set as Mutually Defined(ZZ).
OFF
webMethods B2B determines the sender and receiver for Interchange, Group, and Transaction documents, webMethods B2B uses the interchange header. For example, the sender uses the EDI ID qualifier 01 with the value 123456789 and the receiver uses the EDI ID qualifier ZZ with the value 987654321.
senderQualifier
The default value is *.

The senderQualifier variable indicates the EDI ID qualifier that webMethods B2B uses for the sender when the GSRouting/routingMode variable is GSOnly.

*
webMethods B2B uses the EDI ID qualifier for the sender from the interchange header (for example, ISA05 field).
Other EDI ID qualifiers
You can specify any EDI ID qualifier that the EDI standard supports. For all EDI ID qualifiers, see the documentation for your EDI standard and version.
Note: Be sure to add the external ID types to webMethods B2B for the EDI ID qualifier you specify, if necessary.
receiverQualifier
The default value is *.

The receiverQualifier variable indicates the EDI ID qualifier that webMethods B2B uses for the receiver when the GSRouting/routingMode variable is GSOnly.

Qualifier : *
webMethods B2B uses the EDI ID qualifier for the receiver from the interchange header (for example, ISA07 field).
Other EDI ID qualifiers
You can specify any EDI ID qualifier that the EDI standard supports. For all EDI ID qualifiers, see the EDI Standards documentation for your EDI standard and version.
Note: Ensure that you add the external ID types to webMethods B2B for the EDI ID qualifier you specify, if necessary.

PersistMultipleDocEnvelope

The default value is true.

The persistMultipleDocEnvelope variable indicates whether webMethods B2B saves the original document in the webMethods B2B database. The original EDI document usually contains multiple interchange segments. webMethods B2B only uses the persistMultipleDocEnvelope variable from the default EDI TPA.

Note: webMethods B2B splits each interchange segment within the original EDI document into Interchange, Group, and Transaction documents based on the setting of the splitOption EDI TPA variable. Control whether the Interchange, Group, and Transaction documents are saved in the webMethods B2B database in the processing rule.
true
webMethods B2B saves the original EDI document in the database. The document is saved with both the sender and receiver set to unknown.
false
webMethods B2B does not save the original EDI document in the database. When you specify false, you cannot retrieve the original EDI document later.

processingMode

The default value is Testing.

The processingMode variable indicates whether the partners that use the EDITPA are in testing, production, or custom mode. When processing Interchange, Group, and Transaction documents, webMethods B2B includes the document attribute EDI Processing Mode and sets the value of this attribute based on the processingMode EDITPA variable.

In your processing rules for Interchange, Group, and Transaction documents, you can use the EDI Processing Mode document attribute to customize processing according to the partner's processing mode.

Testing
Use Testing, when you test the exchange of documents between two partners. For example, when the processing mode is Testing, you might create processing rules that accept the documents and do all processing except passing the document to production applications.
Production
Use Production, when you are confident that your logic for exchanging documents is successful.
Custom
Use Custom when you want to define your own setting.
Interchange Define
webMethods B2B sets the value of the EDI Processing Mode document attribute based on the processing mode that is defined in the interchange header.
For an ANSI X12 document, webMethods B2B defines the processing mode based on the value of ISA015, as follows:
  • T or others. Sets the EDI processing mode document attribute to Testing.
  • P. Sets the processing mode document attribute to Production.
  • I. Sets the processing mode document attribute to Custom.
For a UN/EDIFACT document, webMethods B2B defines the processing mode attribute based on the value of UNB11, as follows: 1,2,3,4 or others. Sets the processing mode attribute to Testing Empty. Sets the processing mode attribute to Production

splitOption

The default value is Transaction.

The splitOption variable defines how webMethods B2B splits an interchange segment within an EDI document. The splitOption determines which of the following document types to create from the interchange segment:

  • Interchange documents. Splits the payload at the envelope level.
  • Group documents. Splits the payload at the envelope and group level.
  • Transaction documents. Splits the payload at the envelope, group, and transaction level.

To process the transactions in an inbound document, set splitOption to Transaction or Group. To route the inbound EDI document without processing individual transactions, set the splitOption to Interchange.

The following options are the possible values for the splitOption variable and the types of documents that webMethods B2B creates for each value.

Interchange
webMethods B2B creates only the Interchange document.
Note: When splitOption is Interchange and the FAReconciliation EDITPA variable is set to true, webMethods B2B splits the document at the Group level.
Group
webMethods B2B creates the Interchange document and a Group document for each group segment in the interchange segment.
Transaction
webMethods B2B creates the Interchange document, a Group document for each group segment in the interchange segment, and a Transaction document for each transaction set in the interchange segment.

FAReconciliation

The default value is false.

The FAReconciliation variable indicates whether to enable FA reconciliation in webMethods B2B to reconcile the following acknowledgments:

  • Inbound FA acknowledgments that you received with the outbound EDI documents sent.
  • Outbound FA acknowledgments that you send with the inbound EDI documents received.

To reconcile FAs, webMethods B2B makes a record of each Group or Interchange EDI document that it sends and receives. For ANSI EDI documents, webMethods B2B records each Group document that it sends or receives. For UN/EDIFACT EDI documents, webMethods B2B records each Group document if the EDI document contains Group-level documents. If it does not contain the Group-level documents, webMethods B2B records Interchange-level document.

Select the appropriate value.

true
webMethods B2B reconciles FAs.
false
webMethods B2B does not reconcile the FAs.

UNAmode

The default value is auto.

The UNAmode variable indicates whether you want to create a UNA segment to precede the interchange in an outbound UN/EDIFACT EDI document.

When you use the webMethods B2B batching feature to create an outbound EDI document, the batchProcess service recognizes this setting.

Integrations that you create to form outbound UN/EDIFACT EDI documents can retrieve this setting from the EDITPA by using the getTPA operation on webMethods Integration.

yes
webMethods B2B creates the UNA segment before the interchange in the outbound EDI UN/EDIFACT document.
no
webMethods B2B does not create UNA segment before the interchange in the outbound EDI UN/EDIFACT document.
auto
webMethods B2B creates the UNA segment before the interchange in the outbound EDI UN/EDIFACT document.

delimiters

Integrations that you create to form outbound EDI documents can retrieve this setting from the EDITPA by using the getTPA operation on webMethods Integration.

When you use the batching feature for an outbound EDI document, and do not specify the delimiters to the batchProcess service, the batchProcess service retrieves this setting from the EDITPA.

record

The record variable indicates the segment terminator to use in an outbound EDI document, for example, +.

field
The field variable indicates the field separator to use for each EDI segment in an outbound EDI document, for example, !.
subfield

The subfield variable indicates the separator to use for composite elements in an outbound EDI document, for example, *.

release

The release variable indicates the release character to use for an outbound EDI document, for example, “\\xd3.

envelopeIdentifier

The envelopeIdentifier variables consist of ID and qualifier variables for senders and receivers.

When you use the batching feature, in the batchProcess service the input parameter oneBatchQueue is set to NONE, the batchProcess service uses its input parameters to locate the EDITPA. It then uses the envelopeIdentifier variables to set the sender and receiver in the interchange and group headers of the outbound batch EDI document.

When you are using batching with oneBatchQueue set to SINGLEOUTPUT or MULTIPLEOUTPUTS, do not specify the sender/ID variable.

sender/ID
The sender/ID variable indicates the sender ID to use for an outbound EDI document. The integrations that you create to form outbound EDI documents can retrieve this setting from the EDITPA by using the getTPA operation on webMethods Integration.
sender/qualifier
The sender/qualifier variable indicates the EDI ID qualifier that is associated with the value that you specify for sender/ID. For example, if you specified a D-U-N-S number for the sender/ID, for sender/qualifier specify 01, which is the EDI ID qualifier for a D-U-N-S number. The integrations you create to form outbound EDI documents can retrieve this setting from the EDITPA by using the getTPA operation on webMethods Integration.
receiver/ID
The receiver/ID variable indicates the receiver ID to use for an outbound EDI document. The integrations that you create to form outbound EDI documents can retrieve this setting from the EDITPA by using the getTPA operation on webMethods Integration.
receiver/qualifier
The receiver/qualifier variable indicates the EDI ID qualifier that is associated with the value that you specify for receiver/ID. For example, if you specified a D-U-N-S number for the receiver/ID, specify 01 for receiver/qualifier, which is the EDI ID qualifier for a D-U-N-S number. The integrations you create to form outbound EDI documents can retrieve this setting from the EDITPA by using the getTPA operation on webMethods Integration.

ICheaderInfo

The ICheaderInfo variables indicate the values to use for different elements of an ANSI X12 interchange and group headers and UN/EDIFACT UNB headers in outbound EDI documents.

The integrations that you create to form outbound EDI documents can retrieve this setting from the EDITPA by using the getTPA operation on webMethods Integration

When you use the batching feature, webMethods B2B uses this setting when it creates the interchange headers of the outbound batch EDI document.

The default value for ISA01 is 00.

The default value for ISA11 is U.

FAGeneration

autoGenerateFA
The default value is Off.

The autoGenerateFA variable indicates whether you want webMethods B2B to automatically generate FAs for an inbound EDI document.

webMethods B2B creates a task when it generates an FA. You can track the status on the Tasks page. For more information, see Managing tasks.

On
Always automatically generate FAs for inbound EDI documents.
Off
Never automatically generate FAs for inbound EDI documents.
Per Document
Automatically generates FAs based on the indicator flag in the interchange header (for example, ISA14 or UNB09).
FALevel
The default value is Default.

The FALevel variable defines the level of detail that the webMethods B2B acknowledges in the FAs that it generates.

Default
Acknowledges at the envelope level (group for ANSI X12 documents and interchange for UN/EDIFACT documents).
TransactionSet
Acknowledges at the transaction set level.
Segment
Acknowledges at the segment level.
Element
Acknowledges at the element level.
Note: When you are generating FAs at the element level, ensure that you configure the maximum number of errors to report per FA transaction.
processDocument
The default value is All.
The processDocument variable indicates how you want webMethods B2B to process a transaction, group, or UN/EDIFACT interchange based on its FA status. Use this EDITPA variable to define which FA statuses are acceptable and which are unacceptable.
  • For acceptable FA statuses, webMethods B2B processes a transaction, group, or UN/EDIFACT interchange by using its normal processing.
  • For unacceptable FA statuses, webMethods B2B processes documents differently.
The following options describe the settings for the processDocument EDITPA variable, and the acceptable and unacceptable FA statuses based on the processDocument setting.
All
Process all Interchange, Group, and Transaction documents regardless of their FA status.
Only Accepted
Process Interchange, Group, and Transaction documents only that have the FA status as Accepted.
Not Rejected
Process all Interchange, Group, and Transaction documents unless they have the FA status Rejected.
generateControlNumber
The default value is FromInboundDocument.

The generateControlNumber variable defines how webMethods B2B generates the control numbers for the interchange and group headers of the FAs it automatically creates.

FromInboundDocument
webMethods B2B uses the control numbers from the corresponding headers of the inbound EDI document that the FA acknowledges. For example, to acknowledge a group, webMethods B2B uses the control number from the corresponding group header in the inbound document.
Random
webMethods B2B randomly generates control numbers for the interchange and group headers of the FA.
FromControlNumberTable
webMethods B2B obtains the control numbers from the database. webMethods B2B searches the database for the entry that matches the sender/receiver, EDI standard/version, production mode, and type (for example, Envelope or group type) identified in the corresponding interchange or group header of the inbound EDI document that the FA acknowledges. webMethods B2B uses the next control number from this EDIControlNumber table entry for the FA. It also increments the value of the next control number in the table entry so that it reflects the new next control number.
Note: webMethods B2B always sets the control number for the transaction (997 or CONTRL) to 001.
addGroup
The default value is false.

The addGroup variable indicates whether you want webMethods B2B to add a functional group to the UN/EDIFACT FA (for example, CONTRL).

true
Adds a functional group to the FA.
false
Does not add a functional group to the FA.
ctlNumberWleadingZero
The default value is false.

The ctlNumberWleadingZero variable indicates whether you want webMethods B2B to fill the field value of the control number with leading zeros. For example, if the control number is 34, and the length of the field is eight, and if the ctlNumberWleadingZero variable is set to true, webMethods B2B sets the field value of the control number to 00000034.

true
Adds leading zeros to the field value of the control number.
false
Does not add zeros to the field value of the control number.
RejectionRules
syntaxErrorStatus
The default value is Rejected.

The syntaxErrorStatus variable indicates how you want webMethods B2B to report the syntax error status for a transaction, group, or UN/EDIFACT interchange.

Rejected
Use this setting when you want to reject the element (for example, a transaction) because of syntax errors. The following list provides the syntax error status:
  • Accepted. When syntax errors do not occur.
  • Rejected. When syntax errors occur.
Accepted, But Errors Were Noted
Use this setting when you want to know whether the syntax errors occur, but you do not want to reject the element (for example, a transaction) because of syntax errors. The following list provides the syntax error status:
  • Accepted. When syntax errors do not occur.
  • Accepted, But Errors Were Noted. When syntax errors occur.
Accepted
Use this setting when you do not want to check for syntax errors. Always reports the syntax error status as Accepted regardless of whether there are any syntax errors.
logicalErrorStatus
The default value is Rejected.

The logicalErrorStatus variable indicates how you want webMethods B2B to report the logical error status.

Rejected
Use this setting when you want to reject the element (for example, transaction) because of logical errors. The following list provides the logical error status:
  • Accepted. When the logical errors do not occur.
  • Rejected. When the logical errors occur.
Accepted, But Errors Were Noted
Use this setting when you want to know whether the logical errors occur but do not want to reject the element (for example, transaction) because of logical errors. The following list provides the logical error status:
  • Accepted. When the logical errors do not occur.
  • Accepted, But Errors Were Noted. When the logical errors occur.
Accepted
Always reports the logical error status as Accepted regardless of whether there are any logical errors. Use this setting when you do not want to check for logical errors.
childTransactionRejectedStatus
The default value is Rejected.

The childTransactionRejectedStatus variable indicates how you want webMethods B2B to report the child transaction rejected status. The child transaction rejected status indicates whether child elements of a group or UN/EDIFACT interchange have an FA status of Rejected.

Rejected
Use this setting when the FA status of all the child transactions are Rejected. The following list provides the child transaction rejected statuses:
  • Rejected. When the FA status of any of the child transactions is either Rejected or Accepted, But Errors Were Noted.
  • Accepted. When the FA statuses of all the child transactions are Accepted.
Partially Accepted
Use this setting when the FA status of at least one child transaction is Accepted and one is Rejected. The following list provide the child transaction partially accepted statuses:
  • Rejected. When the FA statuses of all the child transactions are Rejected.
  • Partially Accepted. When the FA status of at least one child transaction is Accepted, but the FA statuses of other child transactions are Rejected and/or Accepted, But Errors Were Noted.
  • Accepted, But Errors Were Noted. When the FA statuses of the child transactions are either Rejected and/or Accepted, But Errors Were Noted AND no child transactions are Accepted.
  • Accepted. When the FA statuses of all the child transactions are Accepted.
Accepted, But Errors Were Noted
The following list provides the child transaction with status Accepted, But Errors Were Noted:
  • Rejected. when all the child transactions are Rejected.
  • Accepted, But Errors Were Noted. When the FA statuses of the child transactions are Rejected, Accepted, But Errors Were Noted, and Accepted.
  • Accepted. When the FA statuses of all the child transactions are Accepted.Use this setting when the FA status of at least one child transaction is Accepted, But Errors Were Noted.
deliverFA
The default value is true.

It indicates whether the FA document needs to be auto delivered to the partner or not.

true
Delivers the functional acknowledgment to the partner.
false
Do not deliver the functional acknowledgment to the partner.
splitFAOption
The default value is Interchange.

It indicates whether to generate the FA document for interchange, group, and transaction.

Interchange
Splits the functional acknowledgment at the interchange level of the document.
Group
Splits the functional acknowledgment at the group level of the document.
Transaction
Splits the functional acknowledgment at the transaction level of the document.
Note:

For custom user-specific EDITPA, if you do not select any option for splitFAOption, the default TPA value is used for processing the document.

When splitFAOption value is Group or Transaction, the value for deliverFA must be `false’. To deliver the FA, create a custom processing rule.

When the splitFAOption value is Transaction and the FAReconciliation is true, webMethods B2B creates an entry on the FAReconciliation page for the X12 documents with 997 doctype. Ignore this entry in the FA reconciliation for X12 documents, as the FA reconciliation for X12 happens at the group level.

When you use the webMethods B2B connector in webMethods Integration, submitting an EDI payload through the submit operation does not automatically generate a functional acknowledgment (FA). The generation of the FA does not depend on the TPA parameter autoGenerateFA of webMethods B2B . To auto-generate FA when you submit the EDI payload, add the field autoGenerateFA in the params input of the submit operation, set the value to true, and then run the operation.

ControlNumberManagement

ValidateInboundEnvelopeControlNumbers
The default value is false.

The ValidateInboundEnvelopeControlNumbers variable indicates whether you want the module to validate and track control numbers in the interchange headers of inbound EDI documents.

true
Validates and tracks control numbers in the interchange headers of inbound EDI documents.
false
Does not validate or track control numbers in the interchange headers of inbound EDI documents.
ValidateInboundGroupControlNumbers
The default value is false.

The validateInboundGroupControlNumbers variable indicates whether you want webMethods B2B to validate and track control numbers in the group headers of inbound EDI documents.

true
Validates and tracks control numbers in the group headers of inbound EDI documents.
false
Does not validate or track control numbers in the group headers of inbound EDI documents.
duplicateControlNumberAction
The default value is Error & Continue.

The duplicateControlNumberAction variable indicates the action webMethods B2B takes, when a duplicate control number in an inbound document occurs when it validates interchange and/or group control numbers.

Error & Continue
webMethods B2B logs the error and then continues to process the EDI document that contains the invalid control number normally.
ProcessNormally
webMethods B2B logs a warning and processes the EDI document that contains the invalid control number normally.
Reject
webMethods B2B logs the error and does not process the document normally. webMethods B2B does not split the EDI document. Typically, webMethods B2B splits an inbound EDI based on the EDITPA splitOption variable and uses the documents that it splits for processing. However, if you set the action to Reject, webMethods B2B processes the document without splitting it. Also, webMethods B2B sets the custom attribute EDI Status to Duplicate Control Number. You can use the custom attribute EDI Status in processing rule criteria. Create a processing rule to handle this rejected document. You can force processing of the duplicate document later, if you want.
outOfSequenceControlNumberAction
The default value is Error & Continue.

The outOfSequenceControlNumberAction variable indicates the action that webMethods B2B takes, when it encounters an out-of-sequence control number in an inbound document when it validates interchange and/or group control numbers.

Error & Continue
webMethods B2B logs the error, and then continues to process the EDI document that contains the invalid control number.
ProcessNormally
webMethods B2B logs a warning and processes the EDI document that contains the invalid control number, normally.
Reject
webMethods B2B logs the error and does not process the document normally. webMethods B2B does not split the EDI document. Typically, webMethods B2B splits an inbound EDI based on the value set for the EDITPA splitOption variable and processes the document. However, if you set the action to Reject, webMethods B2B processes the document without splitting. Also, webMethods B2B sets the custom attribute EDI Status to Duplicate Control Number. You can use the custom attribute EDI Status in the processing rule criteria. Create a processing rule to handle this rejected document. You can force processing of the duplicate document later, if you want.
VDA/validateStructure
The default value is false.

Indicates whether you want wbMethods.io B2B to validate the structure of inbound VDA documents.

true
Validates the structure of inbound VDA documents.
false
Does not validate the structure of inbound VDA documents.

BatchCriteria

Batching involves grouping transactions from all queued EDI documents. Specify which fields of the EDI document to use to batch the transactions.

useDefault
The default value is true.
useDefault indicates whether to consider only the standard fields to sort the documents in the batching process.
true
Considers only the standard fields to sort the documents in the batching process.
false
Considers the standard fields and all the other fields set to true in UNB, UNG, ISA, and GS records to sort the documents in the batching process.

UNB record fields identify envelope segments for EDIFACT documents. webMethods B2B considers the following standard fields to sort the EDIFACT documents:

UNB/UNB02/S00202
The sender qualifier of the EDIFACT document.
UNB/UNB02/S00201
The sender ID of the EDIFACT document.
UNB/UNB03/S00302
The receiver qualifier of the EDIFACT document.
UNB/UNB03/S00301
The receiver ID of the EDIFACT document.
UNB/UNB11
The mode of the EDIFACT document.
UNG/UNG07/S00802
The version of the EDIFACT document.

ISA record fields identify envelope segments for X12 documents. webMethods B2B considers the following standard fields to sort the X12 documents:

ISA/ISA05
The sender qualifier of the X12 document.
ISA/ISA06
The sender ID of the X12 document.
ISA/ISA07
The receiver qualifier of the X12 document.
ISA/ISA08
The receiver ID of the X12 document.
ISA/ISA15
The mode of the X12 document.
ISA/ISA12
The version of the X12 document.

UNG record fields identify group segments for EDIFACT documents. webMethods B2B considers the following standard fields for sorting the EDIFACT documents:

UNG/UNG02/S00601
The group sender of the EDIFACT document.
UNG/UNG03/S00701
The group receiver of the EDIFACT document.
UNG/UNG06
The control agency code of the EDIFACT document.
UNG/UNG07/S00801
The message version number of the EDIFACT document.
UNG/UNG07/S00802
The message release number of the EDIFACT document.
UNG/UNG07/S00803
The message association assigned the number code of the EDIFACT document.
UNG/UNG01
The group type of the EDIFACT document.

GS record fields identify group segments for X12 documents. webMethods B2B considers the following standard fields to sort the X12 documents:

GS/GS02
The group sender of the X12 document.
GS/GS03
The group receiver of the X12 document.
GS/GS08
The version of the X12 document.
GS/GS01
The group type of the X12 document.

persistOriginalEnvelope

The default value is false.

The persistOriginalEnvelope variable indicates whether to save the incoming EDI document in webMethods B2B before the processing begins.

webMethods B2B processes the EDI documents in the order: transactions, groups, and the envelope.

If webMethods B2B fails to process the entire large inbound document, it cannot retrieve the original EDI document because it processes the envelope last and does not persist the document.

When you set the persistOriginalEnvelope variable as true, the original incoming EDI document is saved before processing. If webMethods B2B fails to process the entire document, you can track the original document and reprocess it.

If persisting every EDI document before processing slows down your system performance, you can configure documentPersistOrder to Envelope First. Selecting Envelope First makes webMethods B2B to process the envelop first before persisting the original incoming EDI document. If webMethods B2B fails to process the entire inbound document, you can retrieve the details of the original EDI document that is received from the partner.

true
webMethods B2B persists the original incoming EDI document with the following attribute values before processing
  • Processing Status = NEW
  • User Status = Original EDI Envelope
  • EDI Status = Persisted
When webMethods B2B does not fully process an inbound document, it retains the original persisted document without deleting it. Specific attribute values in these documents indicate that processing was incomplete. To reprocess such documents, you must resubmit the original files. Once webMethods B2B successfully processes all parts of the inbound document including transactions, groups, and envelope—it deletes the persisted document.
Note: When the value of the documentPersistOrder EDITPA variable is EnvelopeFirst, webMethods B2B does not persist the original EDI envelope before processing the document, even if you set the value of the persistOriginalEnvelope variable to true.
false
webMethods B2B does not persist the original inbound EDI envelope before processing the document.

documentPersistOrder

The default value is EnvelopeLast.

The documentPersistOrder variable indicates the order in which the EDI documents are submitted to webMethods B2B .

EnvelopeLast
webMethods B2B submits the envelope of the EDI document after it submits the transactions and groups.

If you set persistOriginalEnvelope to false, webMethods B2B does not save the original EDI document. So, if it fails when submitting a large document, you can't retrieve the original because it processes the envelope last.

EnvelopeFirst
webMethods B2B submits the envelope of the EDI document before it submits the groups and transactions.

If you set persistOriginalEnvelope to true, but also set documentPersistOrder to EnvelopeFirst, webMethods B2B processes the envelope first and does not save the original EDI document before processing. However, you can still track the original document until processing is complete.

Note: When you use EnvelopeFirst for EDITPA, it does not persist the envelope. To store the envelope, you need to select EnvelopeLast in the configuration. This is applicable only to VDA documents.