ISO 20022/SWIFT inbound ISO 20022 level envelope properties

When an inbound ISO 20022 envelope is viewed or edited, these Basic and Advanced properties are displayed. Not all properties can be edited.

Basic properties

See General properties.

Control numbers

See General properties.

Advanced properties: 1. ISO 20022 Transaction Inbound

These advanced properties are displayed when an ISO 20022 Transaction Inbound envelope is viewed or edited.
Accepter Lookup alias

Means of filtering the envelopes that are considered as candidates for matching. Recommended when no business header is supplied in the incoming document, in order to avoid ambiguous envelopes.

Valid value for inbound: 1-255 standard characters. Example: 
Set WFContent <No bulk envelope Parameter> alias
Generate an acknowledgment

Whether to generate an acknowledgment for the message.

Valid values: Yes, No (default)

These Acknowledgment options are displayed if Generate an Acknowledgment is set to Yes:
Generate acknowledgment type
When to generate an acknowledgment for an envelope or for a document.

Valid values: All (default), Rejected, Accepted, Accepted With Errors

Send Acknowledgment immediately

When to generate an acknowledgment for the message.

Valid values:
Yes
Send immediately.
No
Default. Acknowledgment is generated and stored in the SPE repository until a deferred enveloping operation is initiated.
Acknowledgment lookup alias
Envelope Accepter Lookup Alias for processing the outbound acknowledgment message. When the enveloping operation is initiated, either through setting Send Acknowledgment immediately to YES, or through deferred enveloping, this value is used to lookup the envelope used to process the acknowledgment. Required.

Valid value: 1 to 255 standard characters

Generate acknowledgment map type
How to determine what map to use to generate acknowledgments.
Valid values:
Default
(MT only) Use the provided map when generate an acknowledgment (default).
Specify
(MX, ISO 20022, and SEPA) Specify a map that you supply for use in generating the acknowledgment.

The custom acknowledgment generation map that you supply for MX, ISO 20022, and SEPA messages should be written to expect the original message as input card 1, and the InterchangeComplianceReport.xml document for input card 2.

If Generate acknowledgment map type is set to Specify, the following Generate acknowledgment map selection property is displayed:
Acknowledgment Generation Map
Specify the map to use when an acknowledgment is generated.

Valid value: Select a map that you have supplied.

Sender ID type
Type of sender identifier.
Valid values:
* (wildcard)
Default
BIC8
Nickname
Distinguished Name
If Sender ID Type is set to BIC8, this BIC Sender ID Options property is displayed:
Sender Branch Code
BIC sender branch code.

Valid value: String

Receiver ID Type

Type of receiver identifier. Optional.

Valid values:
* (wildcard)
Default
BIC8
Nickname
Distinguished Name
Receiver Branch Code
BIC receiver branch code. Displays if Sender ID Type is set to BIC 8.

Valid value: String

Message Format

The format of the message. Required.

Valid values:

* (wildcard)
Any XML
A pass-through value only. It is not processed by the SWIFT network.
MX/ISO 20022
Default
Message Business Area
Identifies the business area where the message type belongs. It is used to populate the message type list. Required.

Valid values: * (wildcard) (default), multiple additional generated values.

Message Type
Transaction message type as determined by the information type in the header of the message group, which includes the message, or as determined by the information type in the transaction message. This list includes SWIFT system messages. Required.

Valid values: * (wildcard), or a generated list that varies according to the selected Message Business Area

Use global control number

Whether this envelope definition must use a global transaction set number to uniquely identify a message group header. Required.

Valid values:
Yes
Indicates that you want to use a global number. You are asked to select one that is already created.
Yes (and generate name from data)

Indicates that a global number name is generated by using values from the inbound data or envelope definition.

No
Default. You want to specify a local control number that is owned by this envelope only.
If Use global control number is set to Yes or to No, this Control Number Options property is displayed:
Assign control number
The global control number to associate with this envelope. Required.

Valid values: Integer. Initial value: 1

If Use global control number is set to Yes (and generate name from data), these Generate Control Number properties are displayed:
Primary Name Format (Example: SWIFT[_SndrID][_SndrBranchCode][_RcvrID][_RcvrBranchCode][_MsgFormat][_MsgType][_ValFlag]_Inbound[_EnvFormat])

Information to include when a name is generated for a primary global control number . 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) (default)
  • 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 global control number name is located that matches the generated Primary Name Format. Optional.

Valid values: Yes (default), No

First Backup Name Format
Format of 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 global control number name is located that matches the Primary Name Format or the First Backup Name Format. Optional.

Valid values: Yes (default), No

Second Backup Name Format
The second backup name format to use if the Primary Name Format is not found. Optional.
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)
If Use global control number is set to No, these additional Control Number Options are displayed:
Sequence Type

Valid values: SPE (default), Database

If Sequence Type is set to SPE, this Locking Mode property is displayed:
Hold locks until commit

Whether to restrict access to messages until all changes are committed. Required.

Valid values: Yes, No (default)

Advanced properties: 2. Transform Map Options

Transform Map Name

The name of the map to use to modify inbound data. Optional.

Valid value: Select an available map from the list.

Advanced properties: 3. Compliance Settings

Compliance check message
Whether to check the message body for compliance. Required.
Valid values: Yes (default), No
If Compliance check message is set to Yes, these Compliance Checking Options properties are displayed:
Use WebSphere Transformation Extender compliance checking
Whether to use the WebSphere Transformation Extender framework driver map for compliance checking.

Valid values: Yes (default), No

If Use WebSphere Transformation Extender compliance checking is set to Yes, these WebSphere Transformation Extender Compliance Checking options are displayed:
SEPA validation
Whether to perform SEPA validation with the sepvaild.mmc map supplied by the product.
Valid values:
Always
Never
Default
Data-dependent
Perform validation if it is warranted. If this option is selected, you supply an XPath and the value to satisfy in order for SEPA validation to be successful.
If SEPA validation is set to any Always or Never, this property is displayed:
Batch good and bad transactions into respective documents
Batch individual good transactions and bad transactions as separate documents.
Valid values:
Yes
Batch output transactions into a single good and a single bad document.
No
Default. Each output transaction is returned as a separate document, except for SEPA messages. If SEPA validation is applied, transactions are automatically batched into a single good and a single bad document.
If Batch good and bad transactions into respective documents is set to Yes, these properties are displayed:
Retain group header

Valid value: Yes, No

If Retain group header is set to Yes, this property is displayed:
Group header XPath
Customer-defined XPath to the group header of a payments message. The group header can be used to construct each split transaction. Required if Retain group header is set to Yes.

Valid values: String

Transaction XPath
Customer-defined XPath to the repeating element where each repeating element instance defines a "transaction." Used to split a message into individual transactions. Required if Batch good and bad transactions into respective documents is set to Yes.

Valid values: String

These properties are the Message XPath Options:
Message matching XPath 1
Location that is used to match and identify messages in cases where transaction splitting is not used.
Message matching XPath value 1
Value that is used to match and identify messages in cases where transaction splitting is not used.
If SEPA validation is set to Always or Data-dependent, these SEPA validation options properties are displayed:
Validate SEPA Universal Financial Industry (UNIFI) rules
Validate whether document conforms to UNIFI rules, a subset of SEPA rules.

Valid values: Yes (default), No

Displays if SEPA validation is set to Always or to Data-dependent

Validate European Banking Authority (EBA) Clearing STEP2 rules based on data
Validate whether document conforms to EBA Clearing STEP2 rules, a subset of SEPA rules.

Valid values: Yes (default), No

Displays if SEPA validation is set to Always or to Data-dependent

If Use WebSphere Transformation Extender compliance checking is set to Yes for any message format, these SWIFT MX validation options are displayed:
Validate BIC addresses
Whether to validate BIC addresses against entries in the SWIFT_Addresses code list, the list of BIC addresses and their respective subtypes used to validate data within transactions (i.e., outside of a header).

Valid values: Yes (default), No

Validate IBAN data
Whether to validate IBAN data in transactions against the IBAN country formats listed in the CODE_LISTS_SWIFT_Validation.xml file, as contained in the spe_install_dir/packs/fsp/codelists file.

Valid values: Yes (default), No

Validate currency codes
Whether to validate currency codes.
Code list used for validation:
If a WebSphere® Transformation Extender compliance map is used, the SWIFT_Currencies_Countries list of currency codes in CODE_LISTS_SWIFT_Validation.xml is used to validate data within transactions. If a Sterling B2B Integrator map is used, the SWIFT_Currencies list of currency codes is used.

Valid values: Yes (default), No

Validate amount and the number of decimal digits
Whether to use the number of allowed number of decimal digits that is specified in the CODE_LISTS_SWIFT_Validation.xml file to validate data within transactions.
Code list used for validation:
If a WebSphere Transformation Extender compliance map is used, the SWIFT_Currencies_Countries list of currency codes in CODE_LISTS_SWIFT_Validation.xml is used to validate data within transactions. If a Sterling B2B Integrator map is used, the SWIFT_Currencies list of currency codes is used.

Valid values: Yes (default), No

Validate country codes
Whether to validate against the list of country codes in the CODE_LISTS_SWIFT_Validation.xml file.

Valid values: Yes (default), No

Validate Via Custom ISO20022 Schema
Whether to validate ISO20022 data by using an available schema.

Valid values: Yes, No

If Validate Via Custom ISO20022 Schema is set to Yes, this additional property is displayed:
Custom Validation Schema
Schema to use for ISO20022 validation.

Valid value: Select from the list of available schema.

Transform non-compliant transactions
Whether to transform noncompliant transactions.
Valid values:
Yes
Accept and transform both compliant and noncompliant transactions.
No
(Default.) Accept compliant transactions, reject noncompliant transactions.
Keep compliance map translated document

Whether to retain the translated document after the compliance check. Required.

Valid values: Yes, No (default)
Yes
Replace the primary document with the translated document after the compliance check.
No
(Default.) Do not replace the primary document with the translated document.
Validate translation output

Whether to validate the output. based on how map handles it.

Valid values: Yes (default), No

Accept non-compliant transactions

Whether to accept noncompliant transactions.

Valid values: Yes, No (default)
Yes
Accept compliant and noncompliant transactions
No
(Default.) Accept compliant transactions and reject noncompliant transactions
Specify translated document encoding

Whether to specify the coded character encoding that is used to translate the message group that includes this header. Required.

Valid values: Yes, No (default)

Map Name Mode

How to determine what map to use to perform a compliance check. Required.

Valid values:
Specify
Default. Select an available compliance map.
Generate from data
This option is useful if you want to share across envelopes. If you select this option, you must select at least one parameter for Primary Name Format.
If Map Name mode is set to Specify, this Map Name property is displayed:
Compliance Map Name
Name of map to use for compliance checking. Does not apply to MT messages. Maps can be either of two types:
  • Supplied with the product
  • Custom compliance map that you import to perform additional compliance checks based on non-mandatory rule books (for example, Cash Management)

Valid values: Select from the list of available maps.

Displays if Map Name Mode is set to Specify.

If Map Name Mode is set to Generate from data, these Map Name properties are displayed:
Primary Name Format (Example: SWIFT[_SndrID][_SndrBranchCode][_RcvrID][_RcvrBranchCode][_MsgFormat][_MsgType][_ValFlag]_Inbound[_EnvFormat])

Information to include when a name is generated for compliance map. 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)
Use first backup name format
Whether to use the first backup name format if no map is located that matches the Primary Name Format. Optional.

Valid values: Yes (default), No

First Backup Name Format
Backup name format to locate if no map is located that matches the Primary Name Format. 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 map is located that matches the Primary Name Format or the First Backup Name Format. Optional.

Valid values: Yes (default), No

Second Backup Name Format
Backup name format to locate if no map is located that matches either the Primary Name Format or the Secondary Name format. 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 matching map is found
Specifies whether to generate an error if no map name is found in any of the selected formats.

Valid values: Yes (default), No

Enforce Message Size Limit
Check the size of the message, and error out if the message exceeds the limit. Optional.
Valid values:
Yes (specify maximum size)
Yes (use SWIFT-specified maximum size for message type)
2000 or 10000, as specified in the SWIFT documentation
No
Do not enforce a limit (default)
If Enforce Message Size Limit is set to Yes, this Message Size Limit property is displayed:
Maximum Message Size
Check the size of the message, and error out if the message exceeds the limit. Required.

Valid value: Numeric. Default: 10,000

Displays if Enforce Message Size Limit is set to Yes (specify maximum size).

Advanced properties: 4. XPath Options

Sender ID XPath
Complete XPath to the Sender ID.

Valid value: String

Receiver ID XPath
Complete XPath to the Receiver ID.

Valid value: String

Advanced properties: 5. Invoking an SPE Driver

Determine the SPE Driver by this criteria
(Standalone SPE installations only) How to determine the driver to use for routing if there are no errors in the compliance check. Required.

Valid values: None (default), Specifying an SPE Driver, Generating the SPE Driver name from the data

SPE Driver for Compliant Documents

Driver to use when compliant documents are encountered. Optional.

Valid values: Select from the list of available drivers.

Displayed if Determine the SPE Driver by this criteria is set to Specifying an SPE Driver.

These properties are displayed if Determine the SPE Driver by this criteria is set to Generating the SPE Driver name from the data:
Primary Name Format (Example: SWIFT[_SndrID][_SndrBranchCode][_RcvrID][_RcvrBranchCode][_MsgFormat][_MsgType][_ValFlag]_Outbound[_EnvFormat])

Information to include when a name is generated for the SPE driver name. Required if Determine the SPE driver by this criteria is set to Generating the SPE Driver name from the data.

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) (default)
  • 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 SPE driver is located that matches the Primary Name Format. Optional.

Valid values: Yes (default), No

First Backup Name Format
Backup name format to locate if no SPE driver is located that matches the Primary Name Format. 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 SPE driver is located that matches the Primary Name Format or the First Backup Name Format. Optional.

Valid values: Yes (default), No

Second Backup Name Format
Backup name format to locate if no SPE driver is located that matches either the Primary Name Format or the Secondary Name format. 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

Valid values: Yes (default), No

Advanced properties: 6. SPE Driver Data Extraction

Extraction options

Business process data extraction. Required.

Valid values:
Determined by SPE Driver
Default.
Extract to a file system directory
Directory for data extraction. Optional. If selected, you are directed to select a directory and filename:
Data Extraction Directory
Directory for data extraction. Optional.
Data Extraction Filename
File name for data extraction. Optional.

Advanced properties: 6. 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 Primary 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 Primary Name Format or the first Backup Name Format. Optional.

Valid values: Yes (default), No

Second Backup Name Format
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

Valid values: Yes (default), No

For each document
Valid values:
  • Invoke the SPE Driver
  • Set the SPE Driver name in process data

Advanced properties: 8. 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 usage of an envelope.