ISO 20022/SWIFT outbound Bulk level envelope properties

These properties are displayed when an ISO 20022/SWIFT Bulk level inbound envelope is selected for viewing or editing. Not all properties can be edited.

Basic properties

See General properties.

Control numbers

See General properties.

Advanced properties: 1. SWIFT/ISO 20022 Bulk Outbound

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

Valid value: One to 255 standard characters

Envelope Format

The format of the envelope. Required.

Valid values: , FIN, SAA XML Format 2
Pass-Through (No business headers)
FIN
SAA XML Format 2
Default
Message Format

The format of the message. Required.

Valid values: Displayed values vary with the Envelope Format:

AnyXML
MT
Default for FIN and for SAA XML Format 2
Service Message 21 - Acknowledgment of an MT (FIN) Message
MX/ISO 20022
Default for Pass-Through (No business headers)
If Envelope Format is set to FIN and Message Format is set to MT, this Message Priority Options property is displayed:
Message Priority
The priority for the delivery of this message. Required.
Valid values: Normal (default), Urgent, System
If Message Priority is set to Normal, this Message Delivery Options property is displayed:
Delivery Monitoring
Valid values:
1 (Non-Delivery Warning)
3 (Non-Delivery Warning and Delivery Notification)
If Delivery Monitoring is set to 3 (Non-Delivery Warning and Delivery Notification), these properties are displayed:
Obsolescence Period (5 minute increments)
Indicates the time after which a delayed message trailer is added to the message by the SWIFT network if it is not yet delivered. Also, the period after which a non-delivery warning is generated by the SWIFT network, if the appropriate choice for the Delivery Monitoring parameter is selected (that is, if you selected option 3 for Delivery Monitoring). Optional.

Valid value: A three-digit number. Each unit represents an increment of 5 minutes. Example: "003" equates to 15 minutes.

Restriction: SWIFT requires leading zeros if the value is fewer than 3 digits (that is, if the Obsolescence Period value is less than 100, which equals 500 minutes).
Use MQHA Delivery Notification Reconciliation
Allows you to specify whether to reconcile Delivery Notification messages with the original message. Required.
Valid values:
Yes
No
(Default.) Indicates that just the ACK/NAK message is reconciled.
Revision
Required.

Valid value: Choose from the list of available revision versions.

Translate documents prior to enveloping

Valid values: Yes, No (default)

Display if Envelope Format is set to Pass-Through (No business headers)

If Message Priority is set to Normal or Urgent, these Message Delivery Options are displayed :
Delivery Monitoring
Values: 1 (Non-Delivery Warning), 3 (Non-Delivery Warning and Delivery Notification)
If Envelope Format is set to SAA XML Format 2, this SAA XML Format 2 option is displayed:
Revision
These properties are the User Header Block Options. For descriptions, refer to SWIFT documentation.
FIN Copy Service Code (tag 103)
Banking Priority (tag 113)
Refer to SWIFT documentation.
Standard Year (Version)
Validation Flag (tag 119)
Payment Release Information (tag 115)
These properties are the User Trailer Options:
Include Possible Duplicate Emission (PDE) Trailer
Indicates whether to include a trailer that specifies that this message might be a duplicate. Required.
About PDE trailers: A PDE trailer is an optional component of an envelope that indicates that this message might have already been sent. Example: Assume that the system crashed during the delivery of a message and a PDE was indicated. In that case, another copy of the message is sent, with the PDE trailer included to indicate that the message might be a duplicate.

Valid values: Yes, No (default)

Include Training (TNG) Trailer
Specifies whether to include a training (TNG) trailer. Required.
About TNG trailers: A TNG trailer, an optional envelope component, indicates that the contained message is sent for system testing purposes.

Valid values: Yes, No (default)

Advanced properties: 2. Acknowledgment Settings

Expect an acknowledgment for messages sent using this envelope
Whether to expect the receiver to return an acknowledgment. Required.

Valid values: Yes (default), No

Acknowledgment Settings
Time limits after which acknowledgments are considered to be overdue. Displays if Expect an acknowledgment for messages sent using this envelope is set to Yes.
Acknowledgment overdue after this many hours
The number of hours after which the acknowledgment is considered overdue. Optional.
Acknowledgment overdue after this many minutes
The number of minutes after which the acknowledgment is considered overdue. Optional.
Acknowledgment overdue after this many seconds
The number of seconds after which the acknowledgment is considered overdue. Optional.

Advanced properties: 3. Invoking an SPE Driver

Because the advanced properties in the SPE Trading Partner UI can vary based on previous selections, properties are listed here in alphabetical order.

Drivers are used in SPE to run steps of a task. (One analogy is the use of business processes in Sterling B2B Integrator.)

Determine the SPE Driver by this criteria

How the choice of which SPE Driver to use for processing data is determined.

Valid values:
None
Specifying an SPE Driver
Generating the SPE Driver name from the data
First Backup Name Format
The first backup name format to use when an error driver is generated. If the Primary Name Format is not found, the system checks for the First Backup Name Format. If that is not found, it checks for the Second Backup Name Format. Optional.

Valid values are the same as the values for Primary Name Format, with this exception: the defaults are Sender ID, Receiver ID, and Envelope Format (FIN/XML2) only.

Generate an error if no generated SPE Driver name exists in the system
Specifies whether to generate an error if there is no match for the generated driver name in the system. The primary, first backup, and second backup names (if used) are evaluated in an attempt to find a match.

Displays only if Determine the SPE Driver by this criteria is set to Generating the SPE Driver name from the data.

Valid values: Yes (default), No

Generate SPE Driver Name from data

If Determine the SPE Driver by this criteria is set to Generating the SPE Driver name from the data, the following group of properties displays.

Primary Name Format
Information to include when a name is generated for a SPE driver. Required if Generating the SPE Driver name from the data is selected. Format example:
SWIFT[_SndrID][_SndrBranchCode][_RcvrID][_RcvrBranchCode][_MsgFormat][_MsgType][_ValFlag]_Outbound[_EnvFormat][_Error]
Valid values: One or more of the following properties:
  • Select All
  • Sender ID (default)
  • Sender Branch Code (applies for BIC only) (default)
  • Receiver ID
  • Receiver Branch Code (applies for BIC only) (default)
  • Message Format(MT/MX/AnyXML)
  • Message Type (default)
  • Validation Flag (applies for MT only)
  • Envelope Format (FIN/XML2 (default)

If the driver name is being generated for an error SPE driver, _Error is appended to the name.

Second Backup Name Format
The second backup name format to use if the Primary Name and First Backup Name formats are not found when a driver name is generated. Optional.

Valid values are the same as the values used for Primary Name Format, with the exception that Envelope Format (FIN/XML2) is the only default.

SPE Driver for Non-Compliant Documents
Driver to use to route noncompliant documents. Select from the list of available drivers.

Displays under the heading SPE Driver List when the value Specifying an SPE Driver is selected for the Determine the SPE Driver by this criteria property.

Valid values:
None
Default
CheckPendingAcknowledgments

Checks for outbound documents whose inbound functional acknowledgments are overdue. If an entry is waiting but is overdue, this service updates the database to mark the acknowledgment as overdue.

Deenvelope
Parses an envelope, checks it for compliance, and extracts the transaction sets that it contains for further processing.
DocumentExtraction
Splits individual documents out of a batch file to make each a separate document. It can also be used to initiate enveloping and outbound document processing, or to batch multiple XML documents for processing.
Envelope
Translates and envelopes messages.
ResourceEncoder
Determines which envelope to use on the document. If translations are specified in an envelope, the service determines which map to use.
TranslationService
Translates the primary document by using a specified map, and replaces the primary document with the result of the translation.
TypingService
Replaces specified required and optional parameters into process data. It also identifies the correct map to use to translate a document into XML.
Use first backup name format
Use the first backup name format if the Primary Name format is not found when a driver name is generated. Required.

Valid values: Yes (default), No

Use second backup name format
Use the second backup name format if the Primary Name and the First Backup Name formats are not found when a driver name is generated. Required.

Valid values: Yes (default), No

Advanced properties: 4. Invoking an Error SPE Driver

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

How to specify the SPE error driver to use when noncompliant documents are encountered.

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

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 (Example: SWIFT[_SndrID][_SndrBranchCode][_RcvrID][_RcvrBranchCode][_MsgFormat][_MsgType][_ValFlag]_Outbound[_EnvFormat]_Error)

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

Select one or more of the following checkboxes:
  • Select All
  • Sender ID (default)
  • Sender Branch Code (applies for BIC only) (default)
  • Receiver ID (default)
  • Receiver Branch Code (applies for BIC only)
  • Message Format (MT/MX/AnyXML)
  • Message Type (default)
  • Validation Flag (applies for MT only)
  • Envelope Format (FIN/XML2) (default)
Use first backup name format
Whether to use the first backup name format if no error SPE driver is located that matches the 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
  • Sender ID (default)
  • Sender Branch Code (applies for BIC only)
  • Receiver ID (default)
  • Receiver Branch Code (applies for BIC only)
  • Message Format (MT/MX/AnyXML)
  • Message Type
  • Validation Flag (applies for MT only)
  • Envelope Format (FIN/XML2) (default)
Use second backup name format
Whether to use the second backup name format if no error SPE Driver is located that matches the Name Format or the first Backup Name Format. Optional.

Valid values: Yes (default), No

Second Backup Name Format
Format for the second backup name.
Select one or more of the following checkboxes:
  • Select All
  • Sender ID
  • Sender Branch Code (applies for BIC only)
  • Receiver ID
  • Receiver Branch Code (applies for BIC only)
  • Message Format (MT/MX/AnyXML)
  • Message Type
  • Validation Flag (applies for MT only)
  • Envelope Format (FIN/XML2) (default)
Generate an error if no generated SPE driver name exists in the system
Specify whether to generate an error if there is no match to the generated SPE driver name in the system.

Valid values: Yes (default), No

For each document
Specified in the Determine SPE driver by parameter
Valid values:
  • Invoke the SPE Driver
  • Set the SPE Driver name in process data

Advanced properties: 5. User Data parameters

To add user name-value pairs, click the Add icon above the first User data name parameter.

User data name n
A user-supplied name that is set in the process data of an envelope. It is part of a name-value pair that is used 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. It is part of a name-value pair that is used in later steps of the process flow.

Valid value: String

Versions

See Working with versions.

Usage

See Viewing usage of an envelope.