EDIFACT Outbound Syntax 4 UNH UNT Envelope Properties, Transaction Level

Edit online

Note: An (*) asterisk indicates that a wildcard value can be used with that parameter (for mandatory fields, the wildcard value is an (*) asterisk and for optional fields, the wildcard value is leaving the field blank). 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 EDIFACT outbound Syntax 4 UNH UNT envelope properties at the transaction level:

Field

Description

Sender ID

Coded identifier of the company or division sending the transaction. Valid value is 12 standard characters. Required.

* Sender Organization

The sender organization. Optional for envelopes managed by Sterling B2B Integrator.

* Identification Code Qualifier (Sender ID)

Coded qualifier of the sender ID as it should appear on the interchange header segment sent to this company or division. Valid value is four standard characters. Optional.

Recipient ID

Coded identifier of the company or division receiving the interchange. Valid value is 12 standard characters. Required.

* Receiver Organization

The receiver organization. Optional for envelopes managed by Sterling B2B Integrator.

* Identification Code Qualifier (Recipient ID)

Coded qualifier of the recipient ID as it should appear on the interchange header segment sent to this company or division. Valid value is three standard characters. Optional.

Next Envelope

Envelope to apply after this envelope. Required.

Create Next Envelope

Adds transaction level envelope to use as the next envelope. Optional. Valid values are:

UNG/UNE Syntax 4
UNB/UNZ Syntax 4

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

How to handle control numbers. Required. Valid values are:

Global (default)
Global (and generate name from data)
Local
Always start with 1

* Message Type

Transaction message type as determined by the information type in the header of the message group, which includes the message or by the information type in the transaction message. Valid value is six standard characters. Required.

* Message Version Number

Version number of the standard message. Valid value is three standard characters. Required.

* Message Release Number (Required for EDIFACT, optional for ODETTE)

Release number of the standard message. Valid value is three standard characters. Required for EDIFACT and AUTACK. Optional for ODETTE.

* Controlling Agency, Coded

Agency controlling the code representing the name of the sending EDI service provider and relaying the message group on the sending side. Valid value is alphanumeric code with three standard characters. Optional.

* Association Assigned Code

Assigned associated code for the agency controlling the name of the sending EDI service provider and relaying the message group on the sending side. Valid value is alphanumeric code with six standard characters. Optional.

* Code List Directory Version Number

Previously defined version number of a code list to implement in this message. Valid value is numeric code with six limited standard characters. Optional.

* Message Type Sub-Function Identification

Coded identifier of a sub-function of a message type. Valid value is six standard characters. Optional.

* Common Access Reference

Key used for referencing related all subsequent transfers of data to the same business case or file. Optional.

* Sequence Of Transfers

Number assigned by the sender indicating the transfer sequence of a message related to the same topic. The message could be an addition or a change to an earlier transfer related to the same topic. Valid value is two standard characters. Optional.

* First And Last Transfer

First and last message in a sequence of messages related to the same topic. Valid value is one standard character. Optional.

* Message Subset Identification

Coded identifier of a message subset by its identifier, version, release, and source. Valid value is 15 standard characters. Optional.

* Message Subset Version Number

Version number of the message subset. Valid value is three standard characters. Optional.

* Message Subset Release Number

Release number of the message subset. Valid value is three standard characters. Optional.

Message Subset Controlling Agency, Coded

Agency controlling the code representing the name of the message subset. Valid value is alphanumeric code with three standard characters. Optional.

* Message Implementation Guideline Identification

Coded identifier of a message implementation guideline by its identifier, version, release, and source. Valid value is 14 standard characters. Optional.

* Message Implementation Guideline Version Number

Version number of a message implementation guideline. Valid value is three standard characters. Optional.

* Message Implementation Guideline Release Number

Release number of a message implementation guideline. Valid value is three standard characters. Optional.

*Message Implementation Controlling Agency, Coded

Agency controlling the code representing the name of the message implementer. Valid value is alphanumeric code with three standard characters. Optional.

* Scenario Identification

Coded identifier of a scenario by its identifier, version, release, and source. Valid value is 14 standard characters. Optional.

* Scenario Version Number

Version number of a scenario. Valid value is three standard characters. Optional.

* Scenario Release Number

Release number of a scenario. Valid value is three standard characters. Optional.

Message Scenario Controlling Agency, Coded

Agency controlling the code representing the message scenario. Valid value is alphanumeric code with three standard characters. Optional.

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.

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 global default in enveloping.properties

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, INVOIC for the EDIFACT standard) that can override the standard property.

Specify Non-Standard Delimiters

Whether you want to specify non-standard delimiters. Valid values are Yes and No (default). Required.

Data Element Separator

EDI delimiter to use to separate elements. Optional.

Segment Terminator

EDI delimiter to use to indicate the end of segments. Optional.

Component Element Separator

EDI delimiter used to separate components. Optional.

Release Character

Character to use to release an EDI delimiter. Optional.

Repetition Separator

Character to use to separate a group of repeated elements. Optional.

Decimal Separator

Character to use to identify different multi details. Optional.

Stream Segments

Insert an end-of-line character after each segment record. Valid values are Yes and No (default). Required.

Primary Name Format

Information to include when generating a name for a global number and finding the correct number to assign based on that name. Optional. Information includes:

Message Type
Message Version and Release Number
Test Indicator

Check each that you want to use in the format.

Use first backup name format

Whether to use the first backup name format (specified below). The default is selected (use the first backup name format).

Backup Name Format

Check boxes to indicate what information to include when generating a name for a global number and finding the correct number to assign based on that name. Optional. Information includes:

Message type
Message version and release number
Test Indicator

Check each that you want to use in the format.

Use second backup name format

Whether to use the second backup name format (specified below). The default is selected (use the second backup name format).

Backup Name Format

Check boxes to indicate what information to include when generating a name for a global number and finding the correct number to assign based on that name. Optional. Information includes:

Message type
Message version and release number
Test Indicator

Check each that you want to use in the format.

Global Message Reference Number

Message control reference number used globally. Select a previously defined number to reference. Valid value is nine standard characters. Required.

Local Message Reference Number

Message control reference number used locally. Select a previously defined number to reference. Valid value is nine standard characters. Required.

Maximum Interchange Size (bytes)

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 173 bytes based on the header and trailer size for EDIFACT 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 a compliance check. Valid values are:

Specify
Generate from data

Map Name

Select the map to be used to perform a compliance check. The map must already be checked in. Optional.

Primary Name Format

Information to include when generating a name for a map and finding the correct number to assign based on that name. Information may include some or all of the following:

EDI Standard
Sender ID Code Qualifier
Sender ID
Recipient ID Code Qualifier
Recipient ID
Message Type
Message Version and Release Number
Test Indicator

Check all that you want to use in the format. Optional.

Use first backup name format

Whether to use the first backup name format (specified below). The default is selected (use the first backup name format).

Backup Name Format

Information to include when generating a name for a map and finding the correct number to assign based on that name. Information may include some or all of the following:

EDI Standard
Sender ID Code Qualifier
Sender ID
Recipient ID Code Qualifier
Recipient ID
Message Type
Message Version and Release Number
Test Indicator

Check all that you want to use in the format. Optional.

Use second backup name format

Whether to use the second backup name format (specified below). The default is selected (use the second backup name format).

Backup Name Format

Information to include when generating a name for a map and finding the correct number to assign based on that name. Information may include some or all of the following:

EDI Standard
Sender ID Code Qualifier
Sender ID
Recipient ID Code Qualifier
Recipient ID
Message Type
Message Version and Release Number
Test Indicator

Check all that you want to use in the format. Optional.

Generate an error if no generated map name exists in the system

Generate an error message if it cannot locate the specified map name. Valid values are Yes and No. Required.

Validate translation input

Whether to validate the translation input. Valid values are Yes (default) or No. Required.

Validate translation output

Whether to validate the translation output. Valid values are Yes (default) or No. Required.

Use Security

Use previously checked in trusted certificates to verify a secured document transmission. Valid values are Yes and No (default). Required.

Note: This option must be set to Yes when using secure AUTACK messages in EDIFACT.

Scope of Security Application

Security header and message body referenced in the digital certificate. Required. Valid values are:

1 - Security header and message body (default)
3 - Whole related message, package, group, or interchange