Contact Free trial Login

X12 Receive (Inbound) Settings

Partner Manager enables you to configure the X12 acknowledgments, validation rules, character encoding, and control numbers to apply when receiving an inbound X12 transmission.

Configure the Receive Settings

  1. In the left navigation menu, select the partner for whom to configure the send settings.

  2. In the Validation and acknowledgment settings section, under Send to <partner-name>, click X12.

  3. In the menu on the left, select the setting to configure:

  4. Click Save.

It can take up to five minutes or so for your configuration changes to sync with Mule.

Acknowledgment Settings

Use the following settings to configure acknowledgment settings:

Setting Description Default

Send TA1 for each transmission from <recipient>.

Provides a Technical Acknowledgment (TA1) to the Interchange sender that reports the status of the processing of an interchange header and trailer by the address receiver.

When the ISA and IEA of the received X12 message are valid, a positive TA1 ACK is sent, regardless of what the status of the other content is. If the ISA and IEA of the received X12 message is not valid, a TA1 ACK with an error code is sent.

The TA1 ACK is sent inside an ISA or IEA envelope. The ISA and IEA are no different than any other interchange.

Disabled

Send 997 functional acknowledgment when messages fail to route to a message flow

Provides a functional acknowledgment (the receipt and syntactical acceptability of a message) with the exchange. Functional acknowledgment settings are configured for each message flow, and only apply when there is a failure to route the message to one of the message flows.

Disabled

X12 997 Functional Acknowledgment

The X12 997 functional acknowledgment reports the status of a received interchange. It reports all the errors encountered while processing the received document.

As with all X12 transaction sets, the 997 functional acknowledgment is sent inside a GS or GE envelope.

The 997 functional acknowledgment is used to:

  • Acknowledge the receipt of an interchange or functional group.

  • Accept or reject one or more functional groups or transactions.

  • Verify and report compliance with the standard.

If an interchange contains multiple groups, then a 997 acknowledgment is returned for each group.

If a group contains multiple transaction sets, then the acknowledgment for that group contains multiple AK2 loops, that is, one for each transaction set. This applies only if the AK2 loops are generated for accepted transaction sets.

Validation Settings

Selecting the checkbox (enabling) for any of these options means that all the X12 documents meet this condition criteria and receive a 997 failure message:

Setting Description Default

Fail document when value length outside allowed range

If selected, a transaction with values that are too long or too short is rejected. If unselected, the values are used and the transaction is not rejected. In either case, the error is logged and reported in the 997 acknowledgments.

Enabled

Fail document when invalid character in value

If selected, a transaction with invalid characters is rejected. If unselected, the characters are either passed through or substituted and the transaction is not rejected. In either case, the error is reported in the 997 acknowledgments.

Disabled

Fail document if value is repeated too many times

If selected, a transaction with values that are repeated too many or too few times are rejected. If unselected, the values are accepted and the transaction is not rejected. In either case, the error is reported in the 997 acknowledgments.

Enabled

Fail document if unknown segments are used

If selected, a transaction containing any unknown segments is rejected. If unselected, unknown segments are ignored and the transaction is not rejected. In either case, the error is reported in the 997 acknowledgments.

Enabled

Fail document when segments are out of order

If selected, a transaction with segments that are out of order is rejected. If unselected, the segment can be reordered the transaction is not rejected. In either case, the error is reported in the 997 or 999 acknowledgments.

Enabled

Fail document when too many repeats of a segment

A transaction with a segment repeated too many times is rejected. The error is reported in the 997 or 999 acknowledgments.

Enabled

Fail document when unused segments are included

If selected, a transaction containing segments marked as unused in the schema is rejected. If unselected, the transaction is not rejected and the unused segments are ignored. In either case, the error is reported in the 997 or 999 acknowledgments.

Enabled

Control Numbers

Use these settings to apply validations related to your partners or your use of control numbers within the X12 message:

Setting Description Default

Requires unique interchange control number (ISA13)

If selected, Partner Manager records the interchange numbers previously processed and rejects any duplicate interchange numbers from the same partner (as determined by the interchange sender and receiver identification). If unselected, it allows processing of the received interchange to continue.

Disabled

Requires unique group control number (GS06)

If selected, Partner Manager enforces globally unique Group Control Numbers (GS06) for received functional groups. This configuration requires group numbers to be unique across all interchanges received from the same partner and application (as determined by the interchange sender and receiver identification, combined with the functional group sender and receiver application codes).

Disabled

Requires unique transaction set control number (ST02)

If selected, Partner Manager enforces globally unique Transaction Set Control Numbers (ST02) for received transaction sets. This configuration requires transaction set numbers to be unique across all functional groups received from the same partner and application (as determined by the interchange sender and receiver identification, combined with the functional group sender and receiver application codes).

Disabled

Character Sets

Use these settings to apply selected character set and encoding options pertaining to your partners and your X12 message:

Setting Description Default

Character set

This option is required and defines the characters allowed in string data. When set, invalid characters are replaced by the substitution character. If no substitution character is set or enabled for receive messages in the parser options, they are rejected as errors. Either way, the invalid characters are logged and are reported in the 997 functional acknowledgments for the receive messages.

Possible values include:

  • Basic

  • Extended

  • Unrestricted

Extended

Character encoding

Indicates the character encoding for messages. This character encoding is used for both send and receive messages.

Possible values include:

  • ASCII

  • ISO8859_1

  • UTF-8

Disabled

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub