EDIFACT Inbound Syntax 4 UNB UNZ Envelope Properties, Interchange 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 inbound Syntax 4 UNB UNZ envelope properties at the interchange level:

Field
Description
* Sender ID
Interchange ID as it should appear on the interchange header segment sent to this company or division. Valid value is 12 standard characters. Required.
* Sender Organization
The sender organization. Optional for envelopes managed by Sterling B2B Integrator.
* Identification Code Qualifier
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.
* Interchange Sender Internal Identification
Internal interchange ID as it should appear on the interchange header segment sent to this company or division. Valid value is 12 standard characters. Optional.
* Interchange Sender Internal Sub-identification
Sub-identification ID as it should appear on the interchange header segment sent to this company or division. Valid value is 12 standard characters. Optional.
* Recipient ID
Interchange ID as it should appear on the interchange header segment received from this company or division. 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 received from this company or division. Valid value is four standard characters. Optional.
* Interchange Recipient Internal Identification
Internal interchange ID as it should appear on the interchange header segment received from this company or division. Valid value is 12 standard characters. Optional.
* Interchange Recipient Internal Sub-identification
Sub-identification ID as it should appear on the interchange header segment received from this company or division. Valid value is 12 standard characters. Optional.
* Test Indicator
The value to be used to identify test interchanges. For production interchanges it should be set to None. Required. Valid values are:
  • None (default)
  • Test
  • Syntax Only Test
  • Echo Request
  • Echo Response
  • Any Indicator (wildcard)
Note: If the value of deenveloping.EDIFACT.ProcessUNBTestIndicatorOfZeroAsProduction in the enveloping.properties file is set to true, all transactions that contain a 0 or a blank in the test indicator field will be processed as production data.
Use global control number
Whether this envelope definition must use a global control number to uniquely identify transactions. No indicates that the envelope definition must use its own local control number. Required. Valid values are:
  • Yes (default)
  • Yes (and generate name from data)
  • No
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 are Yes and No (default).
Perform Duplicate Control Number Checking
Determine control number duplications. Required. Valid values are Yes and No (default).
Note: If this value is set to Yes and the Maximum age of Control Number History Records in days parameter is not given a value, entries are created in the TRANSACT_REGISTER table with a null value for the ARCHIVE_DATE. These entries are not purged automatically.
If sequence or duplicate checking, EDI Post Processor should
How the EDI Post Processor service should perform sequence and duplicate checking. When multiple interchanges for the same trading partner are processed in parallel, subprocesses for transactions will always be a direct child to the process that did the deenveloping. If the interchange is out of sequence, the post processor re-runs until the time-out is reached. Required.

Valid values:

  • Process all interchanges in the EDI Sequence Check Queue (recommended and the default)
  • Process only the current interchange
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
Copy the envelope segments (UNB and UNZ) into each group or message extracted from the interchange. Required. Valid values are Yes and No.
Business Process for Non-Compliant Documents
Business process to be used when non-compliant documents are encountered. 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 options include the following:
  • Test Indicator
* Global Interchange Control Reference
Interchange control reference number used globally. Select a previously defined number to reference. Valid value is nine standard characters. Required.
Handling of non-compliant Interchanges
Process to follow when non-compliant interchanges are encountered. Required. Valid values:
  • Accept
  • Reject (default)
Generate an acknowledgement
Generate an acknowledgement that notifies the sender that the receiver has received either a non-compliant interchange or an interpretable interchange transmission. Required. Valid values are Yes (default) and No.
Acknowledgement Detail Level
Level of detail to which acknowledgements are sent. If you select Segment level, the segment and message levels are acknowledged. Optional.

Valid values are:

  • Interchange Level
  • Group Level
  • Message Level
  • Segment Level
  • Data Element Level (default)
Send acknowledgement immediately
Send specified level of acknowledgement immediately after interchange transmission occurs. Valid values are Yes and No (default). Required.
Acceptor Lookup Alias format for generated CONTRLs
Optional. Valid values are:
  • CONTRL (default)
  • CONTRL_[syntax version]
  • CONTRL_[test_indicator]
  • CONTRL_[syntax version]_[test_indicator]
  • [message type (first one if multiple)]
* Local Interchange Control Reference
Interchange control reference number used locally. Select a previously defined number to reference. Valid value is nine standard characters. Required.
Write S002 and S003 subelements
Whether to write the S002 and S003 subelements. Valid values are Yes and No (default). Required.
Syntax 1,2,3 Action Response (UCI 0083)
If using EDIFACT Syntax 3 lower, and UNB 0031 is “1” or Generate Acknowledgements is selected. Allows you to send receipt for UCI 0083. Optional. Valid values are:
  • Acknowledged or Rejected (compliance based) (default)
  • Received