ASC X12 Outbound ST SE Envelope Properties, Transaction 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.

ST SE outbound envelopes use pointers to select next envelope. If the envelopes are not exported/imported as a set, the pointers may fail. Pointer names include a reference to the server on which the envelope was created. Therefore, if Envelope set (ST, GS, ISA) is created on machine1 and then exported and imported into machine2, the pointer names (Envelope ID) reference machine1. If the envelope set is deleted and recreated on machine2 using the same Sender ID and Receiver ID, and so forth, the pointer name (Envelope ID) of these envelopes now reference machine2. If just one envelope, for example the GS envelope, is then imported back to machine2, it will be added as a version of the original envelope under the original Envelope ID, but the pointer to the next envelope to use now points to an envelope ID that does not exist on machine1.

The following table describes X12 outbound ST SE envelope properties at the transaction level:

Field
Description
Next Envelope
Envelope to apply after this envelope. Optional.
Create Next Envelope
Allows you to create the GS envelope to be used as the next envelope in the set. Optional.
Sender ID Qualifier
Qualifier used in envelope lookup by EDI Encoder. Optional.
Sender ID
Coded identifier of the company or division sending the transaction. Valid value is 15 standard characters. Required.
* Sender Organization
The sender organization. Optional.
Receiver ID Qualifier
Qualifier used in envelope lookup by EDI Encoder. Optional.
Receiver ID
Coded identifier of the company or division receiving the transaction. Valid value is 15 standard characters. Required.
* Receiver Organization
The receiver organization. Optional.
* Transaction Set ID Code
Code identifier of the transaction set. Valid value is three standard characters. Required.
Use Correlation Overrides
Whether to use correlation overrides. Required. Valid values are:
  • Always - If a correlation override value is provided, always use that value instead of the value in the envelope (except for the Sender ID, Receiver ID, and Sender/Receiver Qualifier fields, which must have a * in the envelope definition to use the correlation override value).
  • Only when the envelope field has a wildcard value (*) - Only use correlation override values for fields in the envelope definition that are specified with a wildcard (*).
  • Never - Never use correlation overrides.
  • Use the default specified in enveloping.properties - The enveloping.properties file defines when to use correlation overrides if this choice is selected. The properties file will either define Always, Never, or Only when the envelope field has a wildcard (*) value. The applicable properties file property is enveloping.correl_override_default.[standard]. Allowed values are No (which means never), WildcardOnly, or All (which means always, except for the Sender ID, Receiver ID, and Sender/Receiver Qualifier fields, which must have a * in the envelope definition to use the correlation override value).
Control number handling
Specify how to handle control numbers. Required. Valid values are:
  • Global (default)
  • Global (and generate name from data)
  • Local
  • Always start at 1
Global Transaction Set Control Number
Transaction set control reference used globally. Select a previously defined global transaction set control reference. Valid value is nine standard characters. Required. Only displayed when Control number handling is set to Global.
Primary Name Format
Used to specify what information to include when generating a control number. Information includes the following:
  • Transaction Set ID Code (selected by default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code (selected by default)
  • Test Indicator

Check all that you want to use in the format. Used when Control number handling is set to Global (and generate name from data).

Backup Name Format
Used to specify what information to include when generating control number information. The Backup Name Formats are used when a valid control number cannot be determined from the Primary Name Format. Information includes the following:
  • Transaction Set ID Code (selected by default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code
  • Test Indicator

Check all that you want to use in the format. Used when Control number handling is set to Global (and generate name from data).

Backup Name Format
Used to specify what information to include when generating control number information. The Backup Name Formats are used when a valid control number cannot be determined from the Primary Name Format. Information includes the following:
  • Transaction Set ID Code
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code
  • Test Indicator

Check all that you want to use in the format. Used when Control number handling is set to Global (and generate name from data)

Local Transaction Set Control Number
Transaction set reference used locally. Select a previously defined global transaction set control reference. Valid value is nine standard characters. Required.
* Implementation Convention Reference (versions 4012 and above)
Identifier of the implementation convention reference. Valid value is up to 35 standard characters. Optional.
Note: When this field is present in the data input, it is used to select an appropriate implementation of a given transaction set definition.
Accepter Lookup Alias
Identifying string used with the sender ID and the receiver ID to look up this envelope with the EDI Encoder service. This alias associates a document with the service it requires. Valid value must be at least one limited standard character. Required.
Note: For 997 or 999 documents, the ALA format must be entered in the format as defined by the Inbound GS/GE envelope. For example, if an inbound 004030 document is received and the Accepter Lookup Alias for generated 997/999s is set to use 99X_[group version] format, then the ALA must be entered as 99X_004030.
Perform HIPAA compliance check
Whether HIPAA compliance is required. Valid values are Yes and No. Required.
HIPAA Validation Level
Select the HIPAA validation level from the list. Required.
Note: If you are not using a WTX map, you cannot select Level 1 or 2. To use Level 1 or 2 with a Sterling B2B Integrator map and translator, you must perform the check using your compliance map instead of a predefined map.
Values are:
  • Level 1 (WTX only)
  • Level 2 (WTX only)
  • Level 4 (including level 1, 2, and 3)
  • Level 5 (including level 1, 2, 3, and 4)
  • Level 6 (including level 1, 2, 3, 4, and 5)
Limit Interchange Size
Maximum size allowed for an interchange before a single interchange is split into multiple interchanges that are each under the maximum size limitation.

Valid values are:

  • No
  • Specify size limit
  • Use transaction set default in enveloping.properties (default)

Required.

Note: If you select Use transaction set default in enveloping.properties, you need to specify the size limit directly (in the Maximum Interchange Size parameter) or by setting properties in the enveloping.properties property file, which contains a property for each supported standard and more specific properties for each message type (for example, 810 and 850 for the ASC X12 standard) that can override the standard property.
Maximum Interchange Size
Specify the maximum size of each individual interchange. Required.
Note: Only displayed if you selected Specify size limit for the Limit Interchange Size parameter. If you choose to specify a maximum value, the value you specify is checked to make sure it is at least 249 bytes based on the header and trailer size for X12 standard.
Note: For performance reasons, the size is estimated for some components of the interchange (for example, control numbers) when determining the size. For this reason, the actual enforced size limit is slightly smaller than the value you specify.
Map Name Mode
Mode in which to specify the map to use to perform outbound translation. Required. Valid values are:
  • Specify
  • Generate from data
Map Name
Select the map to be used to perform outbound translation. The map must already be checked in. Optional. Only displayed when Map Name Mode is set to Specify.
Note: If you are using the WebSphere® Transformation Extender Maps inSterling B2B Integrator and want to do outbound translation, you must select your outbound translation map.
Primary Name Format
Used to specify what information to include when generating a map name. Information includes the following:
  • EDI Standard (selected by default)
  • Sender ID Code Qualifier (selected by default)
  • Sender ID (selected by default)
  • Receiver ID Code Qualifier (selected by default)
  • Receiver ID (selected by default)
  • Transaction Set ID Code (selected by default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code (selected by default)
  • Test Indicator

Check all that you want to use in the format. Only displayed when Map Name Mode is set to Generate from data.

Backup Name Format
Used to specify what information to include when generating a map name. The Backup Name Formats are used when a valid map name cannot be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID Code Qualifier (selected by default)
  • Sender ID (selected by default)
  • Receiver ID Code Qualifier (selected by default)
  • Receiver ID (selected by default)
  • Transaction Set ID Code (selected by default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code
  • Test Indicator

Check all that you want to use in the format

Backup Name Format
Used to specify what information to include when generating a map name. The Backup Name Formats are used when a valid map name cannot be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID Code Qualifier
  • Sender ID (selected by default)
  • Receiver ID Code Qualifier
  • Receiver ID
  • Transaction Set ID Code (selected by default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code
  • Test Indicator

Check all that you want to use in the format.

Backup Name Format
Used to specify what information to include when generating a map name. The Backup Name Formats are used when a valid map name cannot be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID Code Qualifier
  • Sender ID
  • Receiver ID Code Qualifier
  • Receiver ID
  • Transaction Set ID Code (selected by default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code
  • Test Indicator

Check all that you want to use in the format.

Generate an error if no generated map name exists in the system
Generate an error message if it cannot locate the specified map name. Optional. Valid values are Yes and No.
Validate translation input
Whether to validate the translation input. Valid values are Yes or No. Required.
Validate translation output
Whether to validate the translation output. Valid values are Yes or No. Required.

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