ASC X12 Inbound 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.

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

Field
Description
* Sender ID
Coded identifier of the company or division sending the interchange. Valid value is 12 standard characters. Required.
Sender Organization
The sender organization. Optional.
Receiver ID
Coded identifier of the company or division receiving the transaction. Valid value is 12 standard characters. Required.
* Receiver Organization
The receiver organization. Optional.
* Transaction Set ID Code
Coded identifier of transaction set. Optional. Valid value is three standard characters.
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 Transaction Set Control Number
Transaction set 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.
  • Transaction Set ID Code (selected by default)
  • Implementation Convention Reference
  • 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.

  • Transaction Set ID Code (selected by default)
  • Implementation Convention Reference
  • 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.

  • Transaction Set ID Code
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code
  • Test Indicator
Local Transaction Set Control Number
Transaction set control reference number used locally. Select a previously defined number to reference. Valid value is nine standard characters. Required.
* Implementation Convention Reference
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.
Group Version Release ID Code
Release identifier for this version of the group. Valid value is 12 standard characters. Required.
Test Indicator
Mode of operation mode to use for this envelope. Required. Valid values are:
  • Test
  • Production
  • Information
  • Any Indicator (wildcard)
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 and IEA) into each transaction set extracted from the functional group. Valid values are Yes and No. Required.
Batch transactions received within a functional group into one output document
Whether to locate all similar transactions from a functional group into one output document. For example, all invoices would be put into one document. Valid values are Yes and No. Required.
Compliance Check Document
Whether to check the transaction set body for compliance. Valid values are Yes and No. Required.
Map Name Mode
Mode in which to specify the map to use to perform inbound translation. Valid values are:
  • Specify
  • Generate from data
Map Name
Which map to use to perform inbound translation. The map must already be checked in. Select the map. Optional.
Note: If you are using the WebSphere® Transformation Extender Maps in Sterling B2B Integrator and want to do inbound translation, you must select your inbound translation map.
Primary Name Format
Used to specify what information to include when generating a compliance check Map Name. Information includes the following:
  • EDI Standard (selected by default)
  • Sender ID (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. Used when Map Name Mode is set to Generate from data.

Backup Name Format
Used to specify what information to include when generating a compliance check Map Name. The Backup Name Formats are used when a valid map can not be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID (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 compliance check Map Name. The Backup Name Formats are used when a valid map can not be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID (selected by default)
  • 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 compliance check Map Name. The Backup Name Formats are used when a valid map can not be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID
  • 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 the translator cannot locate the specified map name. Valid values are Yes and No. Required.
Handling of non-compliant Transactions
Process to follow when non-compliant transactions are encountered. Required.

Valid values are:

  • Accept compliant and non-compliant transactions
  • Accept compliant transactions, reject non-compliant transactions
Translate transactions
Generate transactions according to the standard format from data groups in an EDI system and carry out reverse processing. By choosing to translate documents from within the envelope, you can reduce document processing time because you do not need to specify a separate Translation service step in the business process. Required. Valid values are Yes and No.
Validate translation output
Validate translated output (that is, documents sent to trading partners). Valid values are Yes and No. Required.
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)
Determine the Business Process by
Select a business process that should run with extracted X12 inbound ST/SE messages as the primary document. Required. Valid values are:
  • Looking up contract dynamically
  • Specifying a contract
  • Specifying a business process
  • Generating the business process name from the data
Contract List
Select a previously created contract to associate with this envelope. Required.
Business Process List
Select a business process to run when this envelope is processed. Optional.
Primary Name Format
Used to specify what information to include when generating a business process name. Information includes the following:
  • EDI Standard (selected by default)
  • Sender ID (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. Used when Determine the Business Process by is set to Generating the business process name from the data.

Backup Name Format
Used to specify what information to include when generating a business process name. The Backup Name Formats are used when a valid business process cannot be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID (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 business process name. The Backup Name Formats are used when a valid business process cannot be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID (selected by default)
  • Receiver ID
  • Transaction Set ID Code
  • 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 business process name. The Backup Name Formats are used when a valid business process cannot be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID
  • Receiver ID
  • Transaction Set ID Code
  • 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 business process name exists in the system
Generate an error message if the translator cannot locate the specified business process name. Valid values are Yes and No. Required.
Extraction Options
Required. Valid values are:
  • Determined by a business process
  • Extract to a file system directory
  • Extract to a mailbox
Error Business Process Name Mode
Mode in which to specify a business process to run if an error is encountered. Optional. Valid values are:
  • Specify
  • Generate from data

Only displayed if Extraction Options is set to Determined by a business process.

Business Process for Non-Compliant Documents
Business process to be used when non-compliant documents are encountered. Optional.
Primary Name Format
Used to specify what information to include when generating a business process name. Information includes the following:
  • EDI Standard (selected by default)
  • Sender ID (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 Error Business Process Name Mode is set to Generate from data.

Backup Name Format
Used to specify what information to include when generating a business process name. The Backup Name Formats are used when a valid business process cannot be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID (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 business process name. The Backup Name Formats are used when a valid business process cannot be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID (selected by default)
  • Receiver ID
  • Transaction Set ID Code
  • 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 business process name. The Backup Name Formats are used when a valid business process cannot be determined from the Primary Name Format. Information may include some or all of the following:
  • EDI Standard (selected by default)
  • Sender ID
  • Receiver ID
  • Transaction Set ID Code
  • 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 business process name exists in the system
Generate an error message if the translator cannot locate the specified business process name. Valid values are Yes and No. Required.
Data Extraction Directory
Directory for data extraction. Optional.
Data Extraction Filename
Filename for data extraction. Optional.
Data Extraction Mailbox
Mailbox for data extraction. Required.
Data Extraction Mailbox Message Name
Mailbox message name for data extraction. Optional.
For each document
Specified in the Determine Business Process by parameter. Required. Valid values are:
  • Invoke the business process
  • Set the business process name in the process data
Generate an error if no generated business process name or map name exists in the system
Generate an error message if the translator cannot locate the specified business process name or map name. Valid values are Yes and No. Required.

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