ASC X12/HIPAA inbound ST SE (Transaction level) envelope properties

These properties are displayed when you view or edit an ASC X12/HIPAA inbound ST SE (Transaction level) envelope. Not all properties can be edited.

Basic properties

See General properties.

Control Numbers properties

See General properties.

Advanced properties: 1. Inbound Properties

Parent GS envelope to be used as the ST envelope filter
The parent Group envelope (GS) to use as the Transaction (ST) envelope filter.

Valid value: Select from the list of available envelopes.

(ST01) Transaction Set ID Code
Coded identifier of transaction set. A wildcard value * (asterisk) can be used. Required.

Valid value: Three standard characters

Accepter Lookup Alias
Means of filtering the envelopes that are considered as candidates for matching. Required for outbound. Optional.

Valid value: One to 31 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:
Yes
Select an existing global number.
Yes (and generate name from data)
Global number name is generated using values from the inbound data or envelope definition.
No
Specify a control number that is owned only by this envelope.
If Use global control number is set to Yes, this Assign control number property is displayed:
(ST02) Global Transaction Set Control Number
Transaction set control reference number used globally. Select a previously defined number to reference. Required.

Valid value: Nine standard characters

If Use global control number is set to Yes (and generate from data), these Generate control number properties are displayed:

Primary Name Format
Information to include when generating a global number name from data.
  • Select All
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (version 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code (default)
  • Test Indicator
Use first backup name format
Whether to use the Backup Name Format to generate a control number name when a valid name cannot be determined from the Primary Name Format. Default.

Valid values: Yes (default), No

Backup Name Format
Information to include to generate a backup global number name.
Valid values:
  • Select All
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (version 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator
Use second backup name format
Whether to use an additional Backup Name Format to generate a control number name when a valid name cannot be determined from the Primary Name Format. Default.
Valid values:
Yes
Use second Backup Name Format. Specify properties to include.
No
Do not use second backup name format.
Backup Name Format
Information to include to generate a second backup global number name. Used when a valid name cannot be determined from the Primary Name Format or the first Backup Name Format.
Valid values:
  • Select all
  • (GS01) Functional ID Code
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator

If Use global control number is set to No, these Assign control number properties are displayed:

Local Transaction Set Control Number
Transaction set control reference number used locally. Select a previously defined number to reference. Required.

Valid value: Nine standard characters

Sequence Type
Type of control number sequencing to use.

Valid values: SPE, Database

If Sequence Type is set to SPE, this Locking Mode property is displayed:
Hold locks until commit
Whether to restrict access to the messages until all changes are committed.

Valid values: Yes, No (default)

Transaction Implementation Convention Reference (versions 4012 and above)
Identifier of the implementation convention reference. A wildcard value * (asterisk) can be used. Optional.

Valid values: * (asterisk) as wildcard, up to 35 standard characters

Note: When this field is present in the data input, it is used to select the appropriate implementation for the transaction set definition.
Group Version Release ID Code
Release identifier for this version of the group. Required.

Valid value: 12 standard characters

Test Indicator
Mode of operation mode to use for this envelope. Required. Valid values are:
  • Test
  • Production (default)
  • 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. Required.

Valid values: Yes, No (default)

Perform Duplicate Control Number Checking
Whether to determine control number duplications. Required.

Valid values: Yes, No (default)

Retain Enclosing Envelope
Whether to copy the envelope segments (ISA and IEA) into each transaction set extracted from the functional group. Required.

Valid values: Yes, No (default)

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. Required.

Valid values: Yes, No

Compliance Check Document
Whether to check the transaction set body for compliance. Required.

Valid values: Yes (default), No

Map Name Mode
Mode in which to specify the map to use to perform inbound translation. Valid values:
  • Specify
  • Generate from data
Map Name
Select the map to use to perform inbound translation. Optional.
Primary Name Format
Information to include when generating a compliance check Map Name:
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID (default)
  • Transaction Set ID Code (default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code (default)
  • Test Indicator

Used when Map Name Mode is set to Generate from data.

Backup Name Format
Information to include when generating a compliance check Map Name. Used when a valid map can not be determined from the Primary Name Format.
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID (default)
  • Transaction Set ID Code (default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code
  • Test Indicator

Alternate formats are also listed, with different defaults.

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. Required.

Valid values: Yes, No

Handling of non-compliant Transactions
Process to follow when noncompliant transactions are encountered. Required.

Valid values:

  • Accept compliant and noncompliant 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. Required.

Valid values: Yes, No.

Validate translation output
Validate translated output (that is, documents sent to trading partners). Required.

Valid values: Yes, No

Perform HIPAA compliance check
Whether HIPAA compliance is required. Required.

Valid values: Yes, No

HIPAA Validation Level
Select the HIPAA validation level from the list. Required.
Note: If you are not using a type WTX map, you cannot select Level 1 or 2.
Values are:
  • Level 1 (WTX map only). 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.
  • Level 2 (WTX map only). 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.
  • Level 4
  • Level 5
  • Level 6
  • Level 7
Determine the service by
Select a service that should run with extracted X12 inbound ST/SE messages as the primary document. Required. Valid values are:
  • Specifying a driver
  • Specifying a business process

    Value for SPE integration with Sterling B2B Integrator.

  • Generating a driver name
  • Generating the business process name from the data

    Value for SPE integration with Sterling B2B Integrator.

Primary Name Format
Information to include when generating a service name:
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID (default)
  • Transaction Set ID Code (default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code (default)
  • Test Indicator
Backup Name Format
Information to include when generating a service name,S and name cannot be determined from the Primary Name Format:
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID (default)
  • Transaction Set ID Code (default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code
  • Test Indicator

Alternate backup formats are also given, with other defaults.

Generate an error if no generated name exists in the system
Generate an error message if the translator cannot locate the specified name. Valid values: Yes, No. Required.
Extraction Options
Required. Valid values are:
  • Determined by a business process
  • Extract to a file system directory
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 an SPE Driver or (SPE and Sterling B2B Integrator integrations only) Determined by a business process.

Driver for Non-Compliant Documents
Driver to use to route non-compliant documents. Optional.
Business Process for Non-Compliant Documents
Business process to be used when non-compliant documents are encountered. Optional.
Primary Name Format
Information to include when generating a driver name:
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID selected by default)
  • Transaction Set ID Code (default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code (default)
  • Test Indicator

Only displayed when Determine the SPE Driver by this criteria or (Sterling B2B Integrator hosted installations only) Determine the business process by this criteria is set to Generate from data.

Backup Name Format
Information to include when generating a business process name and a valid name format cannot be determined from the Primary Name Format:
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID (default)
  • Transaction Set ID Code (default)
  • Implementation Convention Reference
  • Version, Release, Industry Identifier Code
  • Test Indicator

Alternate backup name formats are also displayed that specify other defaults.

Generate an error if no generated driver name exists in the system
Generate an error message if the translator cannot locate the specified driver or (SPE and Sterling B2B Integrator integrations) business process name. Required.

Valid values: Yes, No.

Data Extraction Directory
Directory for data extraction. Optional.

Displayed if Extraction Options are set to Extract to a File System directory.

Data Extraction Filename
Filename for data extraction. Optional.

Displayed if Extraction Options are set to Extract to a File System directory.

For each document
Specified in the Determine Business Process by parameter. Required.
Valid values:
  • 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. Required.

Valid values: Yes, No.

Advanced properties: 4. Invoking an Error SPE Driver or Business Process

The following properties are displayed for a default installation of SPE:
Determine the Error SPE Driver by this criteria

Valid values: None (default), Specifying an Error SPE Driver, Generating the SPE Driver name from the data

If Determine the Error SPE Driver by this criteria is set to Specifying an Error SPE Driver, this Error SPE Driver list property is displayed:
SPE Driver for Non-Compliant Documents
SPE error driver to use when noncompliant documents are encountered. Optional.

Valid values: Select from the list of available SPE driverSs.

If Determine the Error SPE Driver by this criteria is set to Generating the Business Process name from the data, this Generate Error SPE Driver names from data property is displayed:
Primary Name Format

Information to include when a name is generated for an error SPE driver. Required.

Select one or more of the following checkboxes:
  • Select All
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID (default)
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code (default)
  • Test Indicator
Use first backup name format
Whether to use the first backup name format if no error SPE driver is located that matches the Primary Name Format. Optional.

Valid values: Yes (default), No

First Backup Name Format
Format for the first backup name.
Select one or more of the following checkboxes:
  • Select All
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID (default)
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator
Use second backup name format
Whether to use the second backup name format if no error SPE Driver is located that matches the Primary Name Format or the first Backup Name Format. Optional.

Valid values: Yes (default), No

Second Backup Name Format
Select one or more of the following checkboxes:
  • Select All
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID
  • (ST01) Transaction Set ID Code
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator

The option to use a third backup name format is also displayed, with EDI Standard as the default value for the format.

Generate an error if no generated SPE driver name exists in the system

Valid values: Yes (default), No

For each document
Valid values:
  • Invoke the SPE Driver
  • Set the SPE Driver name in process data
The following properties are displayed for a Sterling B2B Integration hosted installation of SPE:
Determine the Error Business Process by this criteria

Valid values: None (default), Specifying an Error Business Process, Generating the Business Process name from the data

This Error Business Process list property is displayed if Determine the Error Business Process by this criteria is set to Specifying an Error Business Process:
Business process for Non-Compliant Documents
Business process to use when noncompliant documents are encountered. Optional.

Valid values: Select from the list of available business processes.

This Generate Error Business Process names from data property displays if Determine the Error Business Process by this criteria is set to Generating the Business Process name from the data:
Primary Name Format

Information to include when a name is generated for an error business process. Required.

Select one or more of the following checkboxes:
  • Select All
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID (default)
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code (default)
  • Test Indicator
Use first backup name format
Whether to use the first backup name format if no error business process is located that matches the Primary Name Format. Optional.

Valid values: Yes (default), No

First Backup Name Format
Select one or more of the following checkboxes:
  • Select All
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID (default)
  • (ST01) Transaction Set ID Code (default)
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator
Use second backup name format
Whether to use the second backup name format if no error business process is located that matches the Primary Name Format or the first Backup Name Format. Optional.

Valid values: Yes (default), No

Second Backup Name Format
Select one or more of the following checkboxes:
  • Select All
  • EDI Standard (default)
  • Sender ID (default)
  • Receiver ID
  • (ST01) Transaction Set ID Code
  • Transaction Implementation Convention Reference (versions 4012 and above)
  • (GS08) Version, Release, Industry Identifier Code
  • Test Indicator

The option to use a third backup name format is also displayed, with EDI Standard as the default value for the format.

Generate an error if no generated business process name exists in the system

Valid values: Yes (default), No

Advanced properties: 5. User Data parameters

User data name n
A user-supplied name that is set in the process data of an envelope as part of a name-value pair for use in later steps of the process flow.

Valid value: String

User data value n
A user-supplied value that is set in the process data of an envelope as part of a name-value pair for use in later steps of the process flow.

Valid value: String

Versions

See Working with versions.

Usage

See Viewing the usage of an envelope.