EDIFACT Outbound 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 outbound Syntax 4 UNB UNZ envelope properties at the interchange level:

Field
Description
* Syntax Identifier
Coded identifier of syntax rules. Valid value is four standard characters. Required.
* Syntax Version Number
Version number of syntax rules. Typically, this value is 1. Valid value is one standard characters. Required.
* Service Code List Directory Version Number
Version number of the service code list directory. Optional.
* Character Encoding, Coded
Coded character encoding used in the interchange. Optional.
* 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 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.
* 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
Internal interchange sub 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
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.
* Interchange Recipient Internal Identification
Internal interchange ID as it should appear on the interchange header segment received from a company or division. Valid value is 12 standard characters. Optional.
* Interchange Recipient Internal Sub-identification
Internal interchange sub ID as it should appear on the interchange header segment received from a company or division. Valid value is 12 standard characters. Optional.
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).
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 global control number. Optional. Valid values are:
  • Yes (default)
  • Yes (and generate name from data)
  • No
* Recipient Reference/Password
Reference or password as agreed between the communicating trading partners. Optional.
* Recipient Reference/Password Qualifier
Coded qualifier and password of the receiver as it should appear on the message group header sent to this company or division. Valid value is four standard characters. Optional.
* Application Reference
Reference identifier of Sterling B2B Integrator used by the sender. Valid value is 15 standard characters. Optional.
* Processing Priority Code
Code determined by the sender requesting processing priority for the interchange. Optional.
* Acknowledgement Request
Request an acknowledgement that notifies the sender that the receiver has received an interpretable interchange transmission. Optional.
* Acknowledgement overdue after (hours)
Amount of time, in hours, within which you must receive an acknowledgement. Valid value is four numeric characters. Optional.
* Acknowledgement overdue after (minutes)
Amount of time, in minutes, within which you must receive an acknowledgement. Valid value is four numeric characters. Optional.
* Interchange Agreement Identifier
Identification by name or code of the type of agreement under which the interchange takes place. Optional.
* Test Indicator
The structural level in the envelope containing the test indicator is a test. Optional.
* Global Interchange Control Reference
Interchange control reference number used globally. Select a previously defined number to reference. Valid value is nine standard characters. Required.
* Local Interchange Control Reference
Interchange control reference number used locally. Select a previously defined number to reference. Valid value is nine standard characters. Required. Default is 1.
Primary Name Format
Information to include when generating a name for a primary global number and finding the correct number to assign based on that name. Information includes:
  • Test Indicator

Check the appropriate information to use in the format. Optional.

Maximum number of documents per interchange
Maximum number of documents per interchange. Optional.
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
  • Use smallest transaction limit (default)
Note: The Use smallest transaction limit setting is specific to the limitation imposed by the standard.
  • 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.
Invoke Business Process for Each Interchange
Whether a business process is invoked for each interchange generated. Valid values are Yes and No (default). Required.
Note: If Invoke Business Process for Each Interchange is set to No, the service places the name of the business process specified in the envelope into process data using the key WFD_NAME. This business process is then invoked by the Invoke Business Process Service. If Invoke Business Process For Each Interchange is set to Yes, the service directly bootstraps an instance of the business process specified in the envelope, and does not set WFD_NAME in process data.
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.
Specify Non-Standard delimiters
Delimiters other than the default delimiters. Valid values are Yes and No (default). Required.
UNA Segments
Incorporate UNA segments in this envelope. Valid values are Yes and No (default). Required.
Stream Segments
Insert an end-of-line character after each segment record. 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.
Encode Document
Whether to specify character encoding for the document. Required. Valid values are Yes and No (default).
Encoding
Type of character encoding for the message group that includes this header. This field is used with the Encoding field. Valid value is six standard characters. Required only if Encode Document is set to Yes.
Determine the Business Process by
Select a business process that should run with extracted EDIFACT outbound Syntax 4 UNB/UNZ messages as the primary document. Required.

Valid values:

  • Looking up contract dynamically
  • Specifying a contract
  • Specifying a business process
  • Generating the business process name from the data
Business Process List
Select a business process to run when this envelope is processed. Optional.
Contract List
Select a previously created contract to associate with this envelope. Optional.
Primary Name Format
Check boxes to instruct what information to include when generating and matching a name for the business process name. Optional.

Select from:

  • EDI Standard
  • Sender ID Code Qualifier
  • Sender ID
  • Recipient ID Code Qualifier
  • Recipient ID
  • (0065) Message Type
  • Message Version and Release Number
  • Test Indicator
Note: If you are using a generated business process name (Determine the business process by is set to Generating the business process name from data), Sterling B2B Integrator tries to generate and match the following business process:
  • First, it tries to generate and match the business process in the primary name format (replacing the values that are selected for the corresponding value in the message).
  • Second, it tries to generate and match the First Backup Name.
  • Third, it tries to generate and match the Second Backup Name.
  • Fourth, it tries to generate and match the Third Backup Name.
  • Fifth, if there is not an existing business process that matches the names generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process name exists in the system is set to Yes.

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
The first backup name format to use when generating a business process name. The system allows for three alternatives if the Primary Name Format is not found—checking for the First Backup Name Format and then, if that is not found, checking for the Second Backup Name Format, and then, if that is not found, checking for the Third Backup Name Format. Optional.

Select from:

  • EDI Standard
  • Sender ID Code Qualifier
  • Sender ID
  • Recipient ID Code Qualifier
  • Recipient ID
  • (0065) Message Type
  • Message Version and Release Number
  • Test Indicator
Note: If you are using a generated business process name (Determine the business process by is set to Generating the business process name from data), Sterling B2B Integrator tries to generate and match the following business process:
  • First, it tries to generate and match the business process in the primary name format (replacing the values that are selected for the corresponding value in the message).
  • Second, it tries to generate and match the First Backup Name.
  • Third, it tries to generate and match the Second Backup Name.
  • Fourth, it tries to generate and match the Third Backup Name.
  • Fifth, if there is not an existing business process that matches the names generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process name exists in the system is set to Yes.

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
The second backup name format to use when generating a business process name. The system allows for three alternatives if the Primary Name Format is not found—checking for the First Backup Name Format and then, if that is not found, checking for the Second Backup Name Format, and then, if that is not found, checking for the Third Backup Name Format. Optional.

Select from:

  • EDI Standard
  • Sender ID Code Qualifier
  • Sender ID
  • Recipient ID Code Qualifier
  • Recipient ID
  • (0065) Message Type
  • Message Version and Release Number
  • Test Indicator
Note: If you are using a generated business process name (Determine the business process by is set to Generating the business process name from data), Sterling B2B Integrator tries to generate and match the following business process:
  • First, it tries to generate and match the business process in the primary name format (replacing the values that are selected for the corresponding value in the message).
  • Second, it tries to generate and match the First Backup Name.
  • Third, it tries to generate and match the Second Backup Name.
  • Fourth, it tries to generate and match the Third Backup Name.
  • Fifth, if there is not an existing business process that matches the names generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process name exists in the system is set to Yes.

Use third backup name format
Whether to use the third backup name format (specified below). The default is selected (use the third backup name format).
Backup Name Format
The third backup name format to use when generating a business process name. The system allows for three alternatives if the Primary Name Format is not found—checking for the First Backup Name Format and then, if that is not found, checking for the Second Backup Name Format, and then, if that is not found, checking for the Third Backup Name Format. Optional.

Select from:

  • EDI Standard
  • Sender ID Code Qualifier
  • Sender ID
  • Recipient ID Code Qualifier
  • Recipient ID
  • (0065) Message Type
  • Message Version and Release Number
  • Test Indicator
Note: If you are using a generated business process name (Determine the business process by is set to Generating the business process name from data), Sterling B2B Integrator tries to generate and match the following business process:
  • First, it tries to generate and match the business process in the primary name format (replacing the values that are selected for the corresponding value in the message).
  • Second, it tries to generate and match the First Backup Name.
  • Third, it tries to generate and match the Second Backup Name.
  • Fourth, it tries to generate and match the Third Backup Name.
  • Fifth, if there is not an existing business process that matches the names generated in steps 1-4, an error is generated.

Only occurs if Generate an error if no generated business process name exists in the system is set to Yes.

Generate an error if no generated business process name exists in the system
Generate an error message if it cannot locate the specified business process name. Valid values are Yes (default) and No.
Extraction Options
Required. Valid values are:
  • Determined by a business process (default)
  • Extract to a file system directory
  • Extract to a mailbox
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.