EDIFACT inbound Syntax 4 UNH UNT (Message level) envelope properties

These properties display when you view or edit an inbound Syntax 4 UNH UNT (Message level) EDIFACT envelope. Not all properties can be edited.

Basic properties

For a description of these properties, see the General properties topic.

Control Numbers

For a description of these properties, see the General properties topic.

Advanced properties: 1. Inbound Properties

Parent UNG envelope to be used as the UNH envelope filter
The parent group envelope (UNG) that is used as the UNH envelope filter. Optional.

Valid value: Select from the list of available envelopes.

Identification Code Qualifier (sender from group or interchange)
Coded qualifier of the sender ID as it appears on the transaction header segment sent to this company or division. Optional.

Valid value: Four standard characters

Draft comment:
Verified on UI

Identification Code Qualifier (recipient from group or interchange)
Coded qualifier of the recipient ID as it appears on the transaction header segment that is received from this company or division. Optional.

Valid value: Four standard characters

Draft comment:
Verified on UI

(0065) 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. Required.

Valid value: Six standard characters

Draft comment:
Or should this be "up to 7?"

(0052) Message Version Number
Version number of the standard message. Required.

Valid value: Three standard characters

(0054) Message Release Number
Release number of the standard message. Required.

Valid value: Three standard characters

(0051) Controlling Agency, Coded
Agency that controls the code representing the name of the EDI service provider that is responsible for relaying the message group on the sending side. Required.

Valid value: Alphanumeric code with three standard characters

Draft comment:
Checked against UI

(0057) Association Assigned Code
Assigned associated code for the agency that controls the name of the sending EDI service provider and relaying the message group on the sending side.

Valid value: Alphanumeric code with six standard characters

(0113) Message Type Sub-Function Identification
Coded identifier of a subfunction of a message type.
Draft comment:
Checked against UI

Valid value: Six standard characters

Accepter Lookup Alias
Identifying string used with the Sender ID and the Receiver ID to look up this envelope. This alias associates a message with the service it requires. Optional.

Valid value: Up to 31 standard characters

Draft comment:
Verified against UI. Not in B2Bi

Use global control number
Whether this envelope definition must use a global control number to uniquely identify transactions.
Valid values:
Yes
Yes (and generate name from data)
No
The envelope definition must use its own global control number. Default.
Draft comment:
Check against UI and finish these
If Use global control number is set to No, these Assign control number properties are displayed:
(0062) Local Message Reference Number
Unique message reference number that is assigned by the sender.
Draft comment:

It must be unique within the interchange and across a sufficient number of interchanges from the same sender to allow enough time to avoid conflicts.

Sequence Type
The type of control number sequencing that is used.
Draft comment:
What's the difference between this one and the Sequence Type listed in 1 under "Assign control number"?

Valid values: SPE (default), Database

Hold locks until commit
Whether to restrict access to the messages until all changes are committed.
Draft comment:
Note that this does not appear in both sequence types here like it does in #6.

Valid values: Yes, No (default)

If Use global control number is set to Yes, this Assign control number property is displayed:
(0062) Global Message Reference Number
Unique message reference number that is assigned by the sender. Required.

Valid value: Select from the list of available global reference numbers.

If Use global control number is set to Yes (and generate name from data), these Generate control number properties are displayed:
Primary Name Format
Information to include when generating a name for a primary global number
Draft comment:
Verified against UI
and finding the correct number to assign based on that name. Optional.
Valid values:
  • Select All
  • (0065) Message Type (default)
  • Message Version and Release Number (default)
  • Test Indicator
Draft comment:
Values also verified against UI
Use first backup name format
Whether to use the first backup name format if a name cannot be generated and matched based on the Primary Name Format.

Valid values: Yes (default), No

Backup Name Format
Specifies what information to include when generating a name for a global number and finding the correct number to assign based on that name. Used when a valid name cannot be determined from the Primary Name Format.
Valid values:
  • Select All
  • (0065) Message Type (default)
  • Message Version and Release Number
  • Test Indicator
Use second backup name format
Whether to use the second backup name format if a name for the global control number cannot be generated and matched based on the first Backup Name Format.

Valid values: Yes (default), No

Backup Name Format
A second option for specifying what information to include when generating a name for a global number and finding the correct number to assign based on that name. Used when a valid name cannot be determined from the first Backup Name Format.
Draft comment:
Verified again UI
Valid values:
  • Select All
  • (0065) Message Type
  • Message Version and Release Number
  • Test Indicator
(0035) Test Indicator
Operation mode to use for this envelope.
Valid values:
  • None (default)
  • Test
  • Syntax Only Test
  • Echo Request
  • Echo Response
  • 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: Yes, No (default)

Perform Duplicate Control Number Checking
Determine control number duplications.

Valid values: Yes, No (default)

Retain Enclosing Envelope
Copy the envelope segments (UNB and UNZ) into each message that is extracted from the transaction.

Valid values: Yes, No (default)

Batch transactions received within a functional group into one output document
Put all similar transactions from a functional group into one output document. For example, all invoices would be put into one document. The default is to output each transaction to a separate document.

Valid values: Yes (default), No

Advanced properties: 2. Acknowledgment Settings

Handling of non-compliant Messages
Process to follow when non-compliant transactions are encountered.
Valid values are:
Accept compliant and non-compliant transactions
Accept compliant transactions, reject non-compliant transactions
Default.

Advanced properties: 3. Translation/Compliance Checking

Translate and/or Compliance Check Document
Whether to translate the transaction set body or check it for compliance.

Valid values: Yes, No (default)

Draft comment:
Note: This setting applies only to data compliance, not to security/certificate compliance.
If Translate and/or Compliance Check Document is set to Yes, these Compliance Checking properties are displayed:
Translate transactions
Whether to generate transactions according to the standard format from data groups and carry out reverse processing. Required

Valid values: Yes, No (default)

Validate translation output
Validate translated output (that is, documents sent to trading partners). 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
Draft comment:
Required or optional?
If Map Name Mode is set to Specify, this Map Name property is displayed:
Map Name
Map to use to perform a compliance check. Optional.

Valid value: Select from the list of available maps.

Draft comment:
Verified against UI and B2Bi doc

If Map Name Mode is set to Generate from data, these Map Name properties are displayed:
Primary Name Format
Information to include when generating a compliance check Map Name:
  • Select All
  • EDI Standard (default)
  • Sender ID Code Qualifier (default)
  • Sender ID (default)
  • Recipient ID Code Qualifier (default)
  • Recipient ID (default)
  • (0065) Message Type (default)
  • Message Version and Release Number
  • Test Indicator
Use first backup name format
Whether to use a backup name format when generating a compliance check Map Name. Used when a valid map can not be determined from the Primary Name Format.

Valid values: Yes (default), No

Backup Name Format
Information to include when generating a backup compliance check map name. Used when a valid map cannot be determined from the Primary Name Format.
  • Select All
  • EDI Standard (default)
  • Sender ID Code Qualifier (default)
  • Sender ID (default)
  • Recipient ID Code Qualifier
  • Recipient ID
  • (0065) Message Type (default)
  • Message Version and Release Number
  • Test Indicator
A third Backup Name Format is also available with the defaults EDI Standard and (0065) Message Type.
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 (default)

Advanced properties: 4. Invoking an SPE Driver

Determine the SPE Driver by this criteria
The criteria by which the SPE driver is determined.
Draft comment:
Verified against UI
Valid values:
  • None (default)
  • Specifying a SPE Driver
  • Generating the SPE Driver name from the data
For each document
Defines how to process each document.
Draft comment:
Verified against UI
Valid values:
  • Invoke the SPE Driver (default)
  • Set the SPE Driver name in process data

If Determine the SPE Driver by this criteria is set to Specifying an SPE Driver, this SPE Driver for Compliant Documents property is displayed:
SPE Driver for Compliant Documents

Valid value: Select from the list of available drivers.

If Determine the SPE driver by this criteria is set to Generating the SPE Driver name from the data, these Generate SPE Driver Name properties are displayed:
Primary Name Format
Information to include when generating a name for a map and finding the correct number to assign based on that name.
Valid values: Select those that you want use:
  • Select all
  • EDI Standard (default)
  • Sender ID Code Qualifier (default)
  • Sender ID (default)
  • Recipient ID Code Qualifier (default)
  • Recipient ID (default)
  • (0065) Message Type (default)
  • Message Version and Release Number (default)
  • Test Indicator
Use first backup name format
Whether to use the first backup name format when a name cannot be located with the primary name.

Valid values: Yes (default), No

First Backup Name Format
Information to include when generating a name for a map and finding the correct number to assign based on that name.
Valid values:
  • Select all
  • EDI Standard (default)
  • Sender ID Code Qualifier (default)
  • Sender ID (default)
  • Recipient ID Code Qualifier (default)
  • Recipient ID (default)
  • (0065) Message Type (default)
  • Message Version and Release Number
  • Test Indicator
Use second backup name format
Whether to use the second backup name format when a name cannot be located with either the primary name or the first backup name.

Valid values: Yes (default), No

Second Backup Name Format
Information to include when generating a name for a map and finding the correct number to assign based on that name.
Valid values:
  • Select all
  • EDI Standard (default)
  • Sender ID Code Qualifier (default)
  • Sender ID (default)
  • Recipient ID Code Qualifier
  • Recipient ID
  • (0065) Message Type
  • Message Version and Release Number
  • Test Indicator
Use third backup name format
Whether to use the third backup name format. Used when a name cannot be located with either the primary name or the first or second backup name.

Valid values: Yes (default), No

Third Backup Name Format
Information to include when generating a name for a map and finding the correct number to assign based on that name.
Valid values:
  • Select all
  • EDI Standard (default)
  • Sender ID Code Qualifier
  • Sender ID
  • Recipient ID Code Qualifier
  • Recipient ID
  • (0065) Message Type
  • Message Version and Release Number
  • Test Indicator
Generate an error if no generated SPE Driver name exists in the system
Whether to generate an error message if none of the specified map names can be located in the system.

Valid values: Yes (default), No

Draft comment:
This might be in as B2Bi only --would be BP if B2Bi only:
Extraction Options
Criteria by which the data is extracted by the SPE driver.
Valid values:
  • Determined by SPE Driver (default)
  • Extract to a file system directory

Advanced properties: 5. Invoking an Error SPE Driver

Determine the Error SPE Driver by this criteria
The criteria by which the SPE driver is determined.
Valid values:
  • None (default)
  • Specifying a SPE Driver
  • Generating the SPE Driver name from the data
If Determine the Error SPE Driver by this criteria is set to Specifying an SPE Driver, this Error SPE Driver List property is displayed:
SPE Driver for Non-Compliant Documents

Valid value: Select from the list of available drivers.

If Determine the Error SPE Driver by this criteria is set to Generating the SPE Driver name from the data, these Error SPE Driver List properties are displayed:

SPE Driver for Non-Compliant Documents
Driver to use when noncompliant documents are encountered. Select from the list of available drivers.
Draft comment:
Optional? Required?
These Error SPE Driver List properties are displayed if Determine the Error SPE driver by this criteria is set to Generating the SPE Driver name from the data:
Primary Name Format
Use first backup name format
First Backup Name Format
Use second backup name format
Second Backup Name Format
Use third backup name format
Third Backup Name Format
Generate an error if no generated SPE Driver name exists in the system

Valid values: Yes (default), No

Advanced properties: 6. Additional Control Number Options

Sequence Type
The type of control number sequencing that is used.
Draft comment:
What's the difference between this one and the Sequence Type listed in 1 under "Assign control number"?

Valid values: SPE (default), Database

Hold locks until commit
Whether to restrict access to the messages until all changes are committed.
Draft comment:
Appears for both sequence types--is this correct?

Valid values: Yes, No (default)

Advanced properties: 7. 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.