ASC X12 Inbound GS GE Envelope Properties, Group Level

Edit online
Note: An (*) asterisk indicates that a wildcard value can be used with that parameter (the wildcard value is an (*) asterisk). For Inbound envelopes, a wildcard value in the envelope matches any value in the input document, while an empty value in the envelope matches only an empty value in the input document. For Outbound envelopes, a wildcard value is equivalent to an empty value in the envelope.

The following table describes X12 inbound GS GE envelope properties at the group level:

Field
Description
* Functional ID Code
Coded identifier of the functional ID as used in the interchange. Valid value is two standard characters. Required.
* Application Sender's Code
Coded identifier of Sterling B2B Integrator used by the sender. Valid value is 15 standard characters. Required.
Sender Organization
The receiver organization. Optional.
* Application Receiver's Code
Coded identifier of the Sterling B2B Integrator used by the receiver. Valid value is 15 standard characters. Required.
Receiver Organization
The receiver organization. Optional.
Use global control number
Whether this envelope definition must use a global transaction set number to uniquely identify message group headers. Valid values are:
  • Yes, indicates that you want to use a global number and you will be asked to select one that has already been created
  • Yes (and generate name from data), indicates that the global number name will be generated using values from the inbound data or envelope definition
  • No, indicates that you will be specifying a control number is owned only by this envelope
Global Group Control Number
Group control reference number used globally. Select a previously defined number to reference. Valid value is nine standard characters. Required.
Primary Name Format
Used to specify what information to include when generating a Global Number Name.
  • Functional ID Code (selected by default)
  • Version, Release, Industry Identifier Code (selected by default)
  • Test Indicator

Only displayed when Use global control number is set to Yes (and generate

name from data).

Backup Name Format
Used to specify what information to include when generating a Global Number Name. The Backup Name Formats are used when a valid name can not be determined from the Primary Name Format.
  • Functional ID Code (selected by default)
  • Version, Release, Industry Identifier Code
  • Test Indicator
Backup Name Format
Used to specify what information to include when generating a Global Number Name. The Backup Name Formats are used when a valid name can not be determined from the Primary Name Format.
  • Functional ID Code
  • Version, Release, Industry Identifier Code
  • Test Indicator
Local Group Control Number
Group control reference number used locally. Select a previously defined number to reference. Required. Valid value is nine standard characters. Required.
* Responsible Agency Code
Agency responsible for relaying the message group on the sending side. Valid value is alphanumeric code with two standard characters. Required.
* Version, Release, Industry Identifier Code
Version, release, and coded identifier of the industry for this interchange. Valid value is 12 standard characters. Required.
Perform Control Number Sequence Checking
Compare the sequence of control numbers in the data with the Control Number parameter for this envelope. Valid values are Yes and No. Required.
Perform Duplicate Control Number Checking
Whether to determine control number duplications. Valid values are Yes and No. Required.
Maximum age of Control Number History Records in days
Maximum days to retain a history of control numbers to use for duplication determinations. Valid value is nine standard characters. Optional.
Retain Enclosing Envelope
Whether to copy the envelope segments (ISA, GS and GE, IEA) into each transaction set extracted from the functional group. Valid values are Yes and No. Required.
Business Process for Non-Compliant Documents
Business process to be used when non-compliant documents are encountered. Required.
Handling of non-compliant Groups
Process to follow when non-compliant groups are encountered. Valid values are: Accept and Reject. Required.
* Generate an acknowledgement when this group is received
Whether to generate an acknowledgement that notifies the sender that the receiver has received an interpretable group transmission. Valid values are Yes and No. Required.
Acknowledgement Format
The format of the acknowledgement to be sent. The valid values are:
  • 997
  • 999

Required.

Acknowledgement Detail Level
Level of detail to send acknowledgements. If you select Segment level, the segment, transaction, and group levels are acknowledged. Optional.
Send acknowledgement immediately
Whether to send the acknowledgement immediately on receipt of the message. Valid values are Yes and No (default). Required.
Accepter Lookup Alias format for generated 997/999s
Alias for accepter lookup for generated 997 acknowledgements. Optional. Valid values are:
  • 99X
  • 99X_[group version]
  • 99X_[test indicator]
  • 99X_[group version]_[test indicator]
Note: If you selected an option other than 997 or 999 for the Inbound Accepter Lookup Alias for generated 997/999s parameter (inbound interchange envelope), the name of the acceptor lookup alias is generated based on values in the inbound interchange. This allows you to have multiple outbound envelopes for acknowledgements that use different versions and test modes to achieve the appropriate outbound response.

For example, if you have two ST outbound 997/999 envelopes with the same Sender ID, Receiver ID, and Acceptor Lookup Alias (because there are two different inbound versions (004010 or 004030) of a particular document), and you change the inbound GS envelope Accepter Lookup Alias for generated 997/999s to reference 99X_[group version] instead of just 997/999. Then, for the outbound 997/999 ST envelope, the acceptor lookup alias must be entered as 99X_004010.

In the Confirm page, verify your configuration and click Finish to save the envelope settings.