FAGeneration Variables
FAGeneration/autoGenerateFA EDITPA Variable
Default: Off
Note: 
When you are using non-standard processing,
Module for EDI does not use this EDITPA variable. Instead, it uses the
Auto Generate FA setting available on the Interchange Information Detail panel of the module’s home page. For more information about accessing and using this panel, see
Defining Interchange-Level Sender/Receiver
Pair Information.
The FAGeneration/autoGenerateFA variable indicates whether you want Module for EDI to automatically generate FAs for an inbound EDI document.
Value | Description |
On | Always automatically generates FAs for inbound EDI documents |
Off | Never automatically generates FAs for inbound EDI documents |
Per Document | Automatically generates FAs based on the indicator flag in the interchange header (for example, ISA14 or UNB09). |
FAGeneration/FALevel EDITPA Variable
Default: Default
Note: When you are using non-standard processing,
Module for EDI does not use this EDITPA variable. Instead, it uses the
FA Level setting available on the Interchange Information Detail panel of the module’s home page. For more information about accessing and using this panel, see
Defining Interchange-Level Sender/Receiver
Pair Information.
The FAGeneration/FALevel variable defines the level of detail that the module acknowledges in the FAs that it generates.
Value | Description |
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. |
FAGeneration/processDocument EDITPA Variable
Default: All
Note: When you are using non-standard processing,
Module for EDI does not use this EDITPA variable. Instead, it uses the
Child Transaction Rejected Status setting that you set from the Interchange Information Detail panel of the module’s home page. For more information about accessing and using this panel, see
Defining Interchange-Level Sender/Receiver
Pair Information.
The FAGeneration/processDocument variable indicates how you want Module for EDI 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, the module processes a transaction, group, or UN/EDIFACT interchange using its normal processing.
For unacceptable FA statuses, the module processes documents differently.
The following table describes the settings for the FAGeneration/processDocument EDITPA variable, when to use each one, and the acceptable and unacceptable FA statuses based on the processDocument setting.
Set process Document to: | When you want to: | Acceptable FA statuses | Unacceptable FA statuses |
All | Process all Interchange, Group, and Transaction documents regardless of their FA status. | All | None |
Only Accepted | Process only Interchange, Group, and Transaction documents that have the FA status "Accepted". | Accepted | Not Allowed Rejected Partially Accepted Accepted, But Errors Were Noted |
Not Rejected | Process all Interchange, Group, and Transaction documents unless they have the FA status "Rejected". | Not Allowed Partially Accepted Accepted, But Errors Were Noted Accepted | Rejected |
FAGeneration/generateControlNumber EDITPA Variable
Default: FromInboundDocument
Note: When you are using non-standard processing,
Module for EDI does not use this EDITPA variable. Instead, it uses the
Generate Control Number setting that you set from the Interchange Information Detail panel of the module’s home page. For more information about accessing and using this panel, see
Defining Interchange-Level Sender/Receiver
Pair Information.
The FAGeneration/generateControlNumber variable defines how Module for EDI is to generate the control numbers that it uses in the interchange and group headers of the FAs that it automatically generates.
Value | Description |
FromInboundDocument | Module for EDI uses the control numbers from the corresponding headers of the inbound EDI document that the FA acknowledges. The module uses the control number from the corresponding header of the inbound EDI document that the FA acknowledges. For example, if acknowledging a group, the module uses the control number from the corresponding group header in the inbound document. |
Random | Module for EDI randomly generates control numbers for the interchange and group headers of the FA. |
FromControlNumberTable | Module for EDI obtains the control numbers from the EDIControlNumber table. The module searches the EDIControlNumber table 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. The module 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 it reflects the new next control number. |
Note: Module for EDI always sets the control number for the transaction (997 or CONTRL) to 001.
FAGeneration/addGroup EDITPA Variable
Default: false
The FAGeneration/addGroup variable indicates whether you want Module for EDI to add a functional group to the UN/EDIFACT FA (for example, CONTRL).
Value | Description |
true | Adds a functional group to the FA. |
false | Does not add a functional group to the FA. This is the default. |
FAGeneration/ctlNumberWleadingZero EDITPA Variable
Default: false
The FAGeneration/ctlNumberWleadingZero variable indicates whether you want Module for EDI to fill the control number field value with leading zeros. For example, if the control number is 34, and the length of the field is eight, if the FAGeneration/ctlNumberWleadingZero variable is set to true, the module will set the control number field value to 00000034.
Value | Description |
true | Adds leading zeros to the control number field value. |
false | Does not add zeros to the control number field value. |
FAGeneration/RejectionRules/syntaxErrorStatus EDITPA Variable
Default: Rejected
Note: When you are using non-standard processing,
Module for EDI does not use this EDITPA variable. Instead, it uses the
Syntax Error Status setting that you set from the Interchange Information Detail panel of the module’s home page. For more information about accessing and using this panel, see
Defining Interchange-Level Sender/Receiver
Pair Information.
The FAGeneration/RejectionRules/syntaxErrorStatus variable indicates how you want Module for EDI to report the syntax error status for a transaction, group, or UN/EDIFACT interchange.
Value | Description |
Rejected | Use this setting when you want to reject the element (for example, transaction) because of syntax errors. Reports the syntax error status as: “Accepted” when there are no syntax errors “Rejected” when there are syntax errors |
Accepted, But Errors Were Noted | Use this setting when you want to know whether there were syntax errors, but you do not want to reject the element (for example, transaction) because of syntax errors. Reports the syntax error status as: “Accepted” when there are no syntax errors “Accepted, But Errors Were Noted” when there are syntax errors |
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. |
FAGeneration/RejectionRules/logicalErrorStatus EDITPA Variable
Default: Rejected
Note: When you are using non-standard processing,
Module for EDI does not use this EDITPA variable. Instead, it uses the
Logical Error Status setting that you set from the Interchange Information Detail panel of the module’s home page. For more information about accessing and using this panel, see
Defining Interchange-Level Sender/Receiver
Pair Information.
The FAGeneration/RejectionRules/logicalErrorStatus variable indicates how you want Module for EDI to report the logical error status.
Value | Description |
Rejected | Reports the logical error status as: “Accepted” when there are no logical errors “Rejected” when there are logical errors Use this setting when you want to reject the element (for example, transaction) because of logical errors. |
Accepted, But Errors Were Noted | Reports the logical error status as: “Accepted” when there are no logical errors “Accepted, But Errors Were Noted” when there are logical errors Use this setting when you want to know whether there were logical errors but do not want to reject the element (for example, transaction) because of logical errors. |
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. |
FAGeneration/RejectionRules/childTransactionRejectedStatus EDITPA Variable
Default: Rejected
Note: When you are using non-standard processing,
Module for EDI does not use this EDITPA variable. Instead, it uses the
Child Transaction Rejected Status setting that you set from the Interchange Information Detail panel of the module’s home page. For more information about accessing and using this panel, see
Defining Interchange-Level Sender/Receiver
Pair Information.
The
FAGeneration/rejectionRules/childTransactionRejectedStatus variable indicates how you want
Module for EDI 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". For more information, see
childTransactionRejectedStatus
Parameter.
Value | Description |
Rejected | Reports the child transaction rejected status as: “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”. Use this setting when the FA status of all of the child transactions are "Rejected." |
Partially Accepted | Reports the child transaction rejected status as: “Rejected” when the FA statuses of all of the child transactions are “Rejected”. “Partially Accepted” when the FA status of at least one child transaction is “Accepted”, but the FA status 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”. Use this setting when the FA status of at least one child transaction is “Accepted” and one is “Rejected”. |
Accepted, But Errors Were Noted | Reports the child transaction rejected status as: “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”. |
FAGeneration/MessageIdentifier/VersionNumber EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/VersionNumber variable specifies the version number that the wm.b2b.edi.util:generateFA service should place in the CONTRL message when automatically generating FAs.
FAGeneration/MessageIdentifier/ReleaseNumber EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/ReleaseNumber variable specifies the release number that the wm.b2b.edi.util:generateFA service should place in the CONTRL message when automatically generating FAs.
FAGeneration/MessageIdentifier/ControllingAgency EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/ControllingAgency variable specifies the name of the controlling agency that the wm.b2b.edi.util:generateFA service should place in the CONTRL message when automatically generating FAs.
FAGeneration/MessageIdentifier/AssociationCode EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/AssociationCode variable specifies the association code that the wm.b2b.edi.util:generateFA service should place in the CONTRL message when automatically generating FAs.
FAGeneration/MessageIdentifier/CodeListDirectoryVersionNumber EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/CodeListDirectoryVersionNumber variable specifies the version number of the code list directory that the wm.b2b.edi.util:generateFA service should place in the CONTRL message when automatically generating FAs.
FAGeneration/MessageIdentifier/MessageTypeSubFunctionIdentification EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/MessageTypeSubFunctionIdentification variable specifies the code that identifies the sub function of a message type, which the wm.b2b.edi.util:generateFA service should place in the CONTRL message when automatically generating FAs.
FAGeneration/DocumentSettings EDITPA Variable
Default: (no default)
The FAGeneration/DocumentSettings variables specify the auto FA generation settings for different group types (rather than for a sender/receiver pair). Click the Add Row icon to add the FA generation settings for a group type.
The
FAGeneration/DocumentSettings/groupType variable is used to specify the group type. The remaining variables in
FAGeneration/DocumentSettings function exactly the same as their corresponding
FAGeneration variables, except that they pertain to a particular group type. For more information about setting the FA generation variables for each group type, see
FAGeneration Variables.
Module for EDI processes inbound messages as follows:
When a document is received, the module identifies the TPA associated with the document and examines the
FAGeneration/DocumentSettings/groupType variable to determine the FA generation setting for the group type of the inbound message.
When the group type of the inbound message is listed and
autoGenerateFA for that group type is set to On, the module generates the FA for that particular group type as per the settings.
When the group type of the inbound message is not listed, the module examines the
FAGeneration/autoGenerateFA variable to determine whether an FA should be generated as follows:
When the
FAGeneration/DocumentSettings/autoGenerateFA variable is set to On, the module automatically generates an FA for the inbound message.
When the
FAGeneration/DocumentSettings/autoGenerateFA variable is set to Per Document, the module automatically generates an FA based on the indicator flag in the interchange header (for example, ISA14 or UNB09).
When the
FAGeneration/DocumentSettings/autoGenerateFA variable is set to Off, the module does not generate an FA for the inbound message.
Note: When more than one record exists for a group type, Module for EDI considers the first record it encounters for the group when generating the FA.
Important: Do not update and delete elements in the DocumentSettings array at the same time. Because no single identifier exists for these entries, there is no way for Module for EDI to identify which element was deleted and which one was modified. As a result, the message that the module logs to the Activity Log will not correctly reflect all of the changes that were performed. You should first delete the element to be deleted, save the TPA, and then modify the other elements as necessary.
FAGeneration/userFFSchemaForEnvelope EDITPA Variable
Default: (no default)
The FAGeneration/userFFSchemaForEnvelope variable indicates the schema to be used while generating FA for an inbound message. You can customize the schema to be used for validating the envelope. When you copy the wm.b2b.edi.EDIFFSchema:ICS4UNEDIFACTDEF_large schema and modify the copied schema to customize the schema, there are some limitations. For more information about the limitations, see the wm.b2b.edi.util:generateFA service description in webMethods Module for EDI Built-In Services Reference .