Outbound SWIFT Envelope

You only need to create an Outbound SWIFT envelope if you are sending outbound SWIFT messages. However, if you are sending outbound SWIFT messages, you need to create a separate Outbound SWIFT envelope for each SWIFT message type you will be sending. The following table describes Outbound SWIFT envelope properties:

Note: An (*) asterisk indicates that a wildcard value can be used with that parameter. 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.

Field or Check Box

Description

Envelope Format

The format of the envelope. Required. Valid values are FIN (default) and SAA XML Format 2.

* Sender ID

Coded identifier of the supplier number or data sender. Valid value is eight standard characters for BIC 8. Required.

Note: This parameter enables you to type in a new ID or pick an ID that has already been used. When you start typing an ID, the Sterling B2B Integrator returns all matching IDs existing in the system and provides a combo-box from which you can select an ID by double-clicking it. There must be Sender ID Codes in the system for autocomplete to find matches and display a selection list.

It is possible to leave the Sender ID parameter blank under some circumstances. If you leave this parameter blank, it will cause errors during the enveloping process. You must type a valid value in the Sender ID parameter.

Sender ID Type

Type of sender identifier. Valid values are * (wildcard), BIC8 (default), and Distinguished Name. Required.

Note: The full address for BIC8 is a BIC12, which includes the one-character logical terminal (which is specified for the sender and is always "X" for receiver), and the 3-character branch code. These are combined to form the BIC12.

* Receiver ID

Coded identifier of the customer number or data source number. Valid value is eight standard characters for BIC 8. Required.

Note: This parameter enables you to type in a new ID or pick an ID that has already been used. When you start typing an ID, the Sterling B2B Integrator returns all matching IDs existing in the system and provides a combo-box from which you can select an ID by double-clicking it. There must be Receiver ID Codes in the system for autocomplete to find matches and display a selection list.

It is possible to leave the Receiver ID parameter blank under some circumstances. If you leave this parameter blank, it will cause errors during the enveloping process. You must type a valid value in the Receiver ID parameter.

Receiver ID Type

Type of receiver identifier. Valid values are * (wildcard), BIC8 (default), and Distinguished Name. Required.

Accepter Lookup Alias

Identifying string used with the Sender ID and the Receiver ID to look up this envelope with the EDI Encoder service. This alias associates a message with the service it requires. Valid value must be at least one limited standard character. Required. Default is FIN.

Use Correlation Overrides

When to use correlation overrides (when a SWIFT Reviewer chooses not to validate a message on resend). 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 (*). This is the default.
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).

Batching Options

When the EDI Encoder is used to prepare multiple messages for enveloping, you can either choose to process each message individually or concatenate them into a single file, with the messages separated by a ‘$'. Required.

Valid values are:

Use batching ("$" between messages) (default)
Do not batch messages

Enforce Message Size Limit

Specifies that the Sterling B2B Integrator will check the size of the message, and error out if the message exceeds it. If you select this check box, gives you the option to set the Maximum Message Size (which defaults to 10,000, the standard limit for SWIFT messages). Valid values are Yes (default) and No. Required.

User Reference (MT Message User Reference/MX Message Reference)

Indicates how to process the message user reference. The message user reference block is an optional section in the SWIFT envelope that the SWIFT network tracks for acknowledgement purposes. Valid values are:

Don't include a message user reference (default)
Use control number
Use value from process data

Note: You should only select Use value from process data if you are using immediate enveloping. With deferred enveloping, the process data values from the encoding step are not passed on to the enveloping step, so using a process data element will not work with deferred enveloping.

Note: Specify Use control number if you want to reconcile Delivery Notification (or Non-Delivery Warning message) with the Message Input Reference and the original input document.

Revision

The revision field. Values are 2.0.0. (default) and 2.0.1.

Note: This parameter is displayed on the SAA XML Format 2 Options screen when you select Envelope Format as SAA XML Format 2 when creating an outbound envelope.

Message Format

The format of the message. Valid values are MT (default), MX, and Any XML. Required.

Include MX Application Header

Whether the MX Application Header should be included, and, if so, what the format is. Valid values are None (default), Standard Application Header, and ISO20022 Business Application Header. Optional.

From Type

The type of sender. Optional. Only displayed for SAA XML Format 2, Standard Application Header.

From ID

The sender's identifier. Optional. Only displayed for SAA XML Format 2, Standard Application Header.

To Type

The type of receiver. Optional. Only displayed for SAA XML Format 2, Standard Application Header.

To ID

The receiver's identifier. Optional. Only displayed for SAA XML Format 2, Standard Application Header.

Service Name

The service name. Optional. Only displayed for SAA XML Format 2, Standard Application Header.

Message Name

The name of the message. Optional. Only displayed for SAA XML Format 2, Standard Application Header.

Duplicate Reference

Duplicate reference information, if any. Optional. Only displayed for SAA XML Format 2, Standard Application Header.

Duplicate Information

Information about a duplicate header, if applicable. Optional. Only displayed for SAA XML Format 2, Standard Application Header.

Character Set

The character set that will be used. Required.

Note: Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Add Identity

If necessary, allows you to add an identity to associate with the header. Optional.

Note: Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Name

Name of your organization. Required.

Reference URL

Internet address of your organization. Optional.

DUNS

Unique 9-13 character identification number of your organization, as issued by Dun & Bradstreet Corporation. Required.

Identifier

Primary ID of your organization. Use DUNS number. Required.

Address Line 1

Conventional mailing address of your organization. Required.

Address Line 2

Additional mailing address information of your organization. Optional.

City

City where your organization is located. Required.

State or Province

State or province where your organization is located. Required.

Zip or Postal Code

ZIP Code or postal code where your organization is located. Required.

E-mail Address

E-mail address of your organization. Required.

Telephone Number

Telephone number of your organization. Required.

Time Zone

Time zone where your organization is located. Optional.

Country or Region

Country or region where your organization is located. Optional.

VAT ID

The VAT transaction tax identifier. Optional.

Note: When you add VAT IDs to an identity, an associated permission ID is created, and the user is assigned that permission ID.

Internet Notification E-mail

The internal e-mail address to which you want error notifications to be sent. Optional.

Lookup ID

The identifier used to look up the agreement. Optional.

Lookup ID Comments

Any comments regarding the identifier used to look up the agreement. Optional.

Include ISO20022 Extensions

Whether to include ISO20022 extensions. Default is unchecked (do not included extensions). Optional.

ISO Type

The type of ISO. Valid selections are: Financial Institution (default), Organization, Branch, and Person. Optional.

Clearing System Member

The envelope for the clearing system member. Optional.

Other

Another envelope to use. Optional.

Address Type

The type of address. Valid selections are: Postal (default), Business, DeliveryTo, Residential, MailTo, and POBox. Optional.

Country or Region of Residence

The country or region of residence. Optional.

Department

The name of the department. Optional.

Sub-Department

The name of the sub-department, if any. Optional.

Street Name

The name of the street in the address. Optional.

Building Number

The building number in the address. Optional.

Address Line 3

Another address line, if necessary. Optional.

Address Line 4

Another address line, if necessary. Optional.

Address Line 5

Another address line, if necessary. Optional.

Address Line 6

Another address line, if necessary. Optional.

Address Line 7

Another address line, if necessary. Optional.

Issuer

The ISO20022 issuer. Optional.

Code

The code, if any. Optional.

Proprietary

Proprietary information, if any. Optional.

Clearing System Member ID

The clearing system member identifier. Optional.

From

The sender of the message. Required.

Note: Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

To

The receiver of the message. Required.

Note: Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Business Message Identifier

The business message identifier. Required.

Note: Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Message Definition Identifier

The message definition identifier. Required.

Note: Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Business Service

The business service. Optional.

Note: Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Copy Duplicate

Indicates whether the header is a duplicate or copy. Valid selections are: Copy of a Duplicate, Copy, and Duplicate. Optional.

Note: Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Possible Duplicate

Whether the header is a possible duplicate. Required. Valid values are Yes and No (default). Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Priority

The network priority. Optional.

Note: Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Related

Enables you to specify a related envelope. Optional. Only displayed for SAA XML Format 2, ISO20022 Business Application Header.

Validate Sender and Receiver

Specify whether to validate the sender and receiver. Required. Valid values are Yes and No (default).

Note: This parameter allows you to enable (Yes) or disable (No, which is the default) address verification. Address verification is performed using the SWIFT_Addresses and SWIFT_BaseAddresses code lists. See Maintain the External Code Lists for more information on creating these code lists.

MX Business Area

The MX business area. Valid values are * (wildcard), Funds, Trade Services, Exceptions and Investigations, Cash Reporting, Bulk Payments, Cash Management, Proxy Voting, SCORE, Transaction Reporting, Alternative Funds, e-Mandate, and Funds Processing Passport. Required.

Note: Only displayed if you set Message Format to MX.

FIN/APC

For an MT message using XML Format 2, this indicates whether it is a system (APC) message or a user message (FIN). Required.

Valid values are * (wildcard—this is the default), APC, and FIN.

MX Message Area

Transaction message type as determined by the information type in the header of the message group, which includes the message, or determined by the information type in the transaction message. Required.

Valid selections are:

* (wildcard)
Bulk Payments
Cash Management
Cash Reporting
Clearing
Collateral Management
Corporate Actions
e-Mandate
Exceptions and Investigations
Funds
Alternative Funds
Funds Processing Passport
Proxy Voting
SCORE
Trade Services
Transaction Reporting

Note: The message area for MX messages. The lists of Message Types are generated from two property files. The first property file (ui_swift_message_types.properties) will contain the base lists of the types provided with the Sterling B2B Integrator. The second property file (ui_swift_message_types_customer.properties) is user-modifiable, and can also contain additional messages that you want to add. If you add Message Types to the ui_swift_message_types_customer.properties property file, modify it in the customer_overrides.properties file. You are not required to restart the Sterling B2B Integrator when you edit the ui_swift_message_types_customer.properties file. You can also select the default, which is * (wildcard).

Message Type

Note: The message type for MX messages are the full 4-component string (for example, camt.003.001.02). You are first allowed to select a Message Format of wildcard, MT, and MX. If you select a wildcard, this Message Type parameter is not displayed because it is assumed to be wildcard as well (since there is no reason to wildcard the format and then select a specific message). If you select MT as the Message Format, you will be given a list of MT messages for this Message Type parameter. If you choose MX, you receive a list of the “categories” (SWIFT Funds, SWIFT Trade Services, SWIFT Exceptions and Investigations, SWIFT Cash Reporting) for this Message Type parameter. Once you select the subtype, you are presented with a list of the message types for that category. The lists of Message Types are generated from two property files. The first property file (ui_swift_message_types.properties) will contain the base lists of the types provided with the Sterling B2B Integrator. The second property file (ui_swift_message_types_customer.properties) is user-modifiable, and can also contain additional messages that you want to add. If you add Message Types to the ui_swift_message_types_customer.properties property file, modify it in the customer_overrides.properties file. You are not required to restart the Sterling B2B Integrator when you edit the ui_swift_message_types_customer.properties file.

Service Identifier

A two-character numeric field indicating the type of data. The default is 01 for all the Sterling B2B Integrator and user-to-user messages, 21 for acknowledgements, and 03 for SELECT commands. Required.

FIN/APC

For an MT message using XML Format 2, this indicates whether it is a system (APC) message or a user message (FIN). Required.

Valid values are * (wildcard—this is the default), APC, and FIN.

Closed User Group

A specific set of trading partners defined within the SWIFT network. Optional.

Include sender full name

Whether to include the full name of the sender. Valid values are Yes and No (default). Required.

X1 (Institution BIC11)

The name of the sending institution. Optional.

Note: Only displayed for SAA XML Format 2.

X2 (Department or Application Name)

The name of the sending department or application name. Optional.

Note: Only displayed for SAA XML Format 2.

X3 (Routing Information/Surname)

The routing information or surname of the sender. Optional.

Note: Only displayed for SAA XML Format 2.

X4 (Given Name)

The given name of the sender. Optional.

Note: Only displayed for SAA XML Format 2.

Financial Institution

The financial institution for the sender. Optional.

Note: Only displayed for SAA XML Format 2.

Branch Information

The branch information for the sender. Optional.

Note: Only displayed for SAA XML Format 2.

City Name

The name of the city for the sender. Optional.

Note: Only displayed for SAA XML Format 2.

Location

The location code for the sender. Optional.

Note: Only displayed for SAA XML Format 2.

Country or Region Code

The country or region code for the sender. Optional.

Note: Only displayed for SAA XML Format 2.

Include receiver full name

Whether to include the full name of the receiver. Valid values are Yes and No (default). Required.

X1 (Institution BIC11)

The name of the receiving institution. Optional.

Note: Only displayed for SAA XML Format 2.

X2 (Department or Application Name)

The name of the receiving department or application name. Optional.

Note: Only displayed for SAA XML Format 2.

X3 (Routing Information/Surname)

The routing information or surname of the receiver. Optional.

Note: Only displayed for SAA XML Format 2.

X4 (Given Name)

The given name of the receiver. Optional.

Note: Only displayed for SAA XML Format 2.

Financial Institution

The financial institution for the receiver. Optional.

Note: Only displayed for SAA XML Format 2.

Branch Information

The branch information for the receiver. Optional.

Note: Only displayed for SAA XML Format 2.

City Name

The name of the city for the receiver. Optional.

Note: Only displayed for SAA XML Format 2.

Location

The location code for the receiver. Optional.

Note: Only displayed for SAA XML Format 2.

Country or Region Code

The country or region code for the receiver. Optional.

Note: Only displayed for SAA XML Format 2.

Routing Code

The routing code. Optional.

Note: Only displayed for SAA XML Format 2.

Validation level

The level of validation. Required. Valid values are None (use SAA default), Minimum, Intermediate, Maximum.

Note: Only displayed for SAA XML Format 2.

Allow modification in SAA

Whether to allow modification in SAA. Required. Valid values are SAA Default (this is the default), Yes, and No.

Note: Only displayed for SAA XML Format 2.

Include routing instructions

Whether to include routing instructions. Required. Valid values are Yes and No (default).

Note: Only displayed for SAA XML Format 2.

Routing Function

The routing function. Required. Valid values are Route (default), DisposeToRoutingPoint, and DisposeToRoutingStep.

Note: Only displayed for SAA XML Format 2, if Include routing instructions is set to Yes.

Routing Point

The routing point. Optional.

Note: Only displayed for SAA XML Format 2, if Include routing instructions is set to Yes.

Routing Step

The routing step. Optional. Valid values are None (default), Verify, Authorise, Modify, and ReadyToSend.

Note: Only displayed for SAA XML Format 2, if Include routing instructions is set to Yes.

Network Priority

The network priority. Optional. Valid values are None (default), Normal, System, and Urgent.

Note: Only displayed for SAA XML Format 2.

Is Possible Duplicate

Whether the trailer is a possible duplicate. Required. Valid values are Don't include this tag (default), False, and True. Only displayed for SAA XML Format 2.

Request Notification

Whether delivery notification is requested. Required. Valid values are Don't Include (default), False, and True.

Note: Only displayed for SAA XML Format 2.

The Sterling B2B Integrator does not mark a message as accepted until the delivery notification or report has been received. Therefore, the Delivery Notification information is stored until the Transmission Report associating the SenderReference with the appropriate Reconciliation information is received.

Service

The network service used. Optional.

Note: Only displayed for SAA XML Format 2.

User Priority (FIN only; header field 113)

The user priority. Optional.

Note: Only displayed for SAA XML Format 2.

Value Added Service ID (FIN only)

The value-added network service used. Optional.

Note: Only displayed for SAA XML Format 2.

Standard Year (Version)

The SWIFT version (year of release). Optional.

Validation Identifier (FIN only; header field 119)

The validation identifier. Optional.

Note: Only displayed for SAA XML Format 2.

IsSigningRequested flag (ignored for FIN)

Whether or not a signature is requested as a security option. Optional. Valid values are None (use SAA emission profile configuration—this is the default), True, and False.

Note: Only displayed for SAA XML Format 2.

Request non-repudiation (SWIFTNet only)

Whether or not non-repudiation is requested as a security option. Optional. Valid values are None (use SAA emission profile configuration—this is the default), True, and False.

Note: Only displayed for SAA XML Format 2.

PAC Value

This the PAC value Optional

Note: Only displayed for SAA XML Format 2.

Sign the DataPDU

Whether to sign the protocol data unit (PDU) for a signature. Optional. Valid values are Yes or No (default).

Note: Only displayed if Envelope Format is set to either wildcard or SAA XML Format 2 is selected. The signature is optional.

Key Part 1

First part of the validation signature.

Key Part 2

Second part of the validation signature.

Message Priority

Specify the priority of the message delivery. Optional. Valid values are:

Normal (default)
Urgent
System

Note: If you are requesting Delivery Notification andNon-Delivery Warning messages, you need to set the Priority and Delivery Options in the envelope: Normal indicates None and Delivery Notification and Urgent indicates Non-Delivery Warning and Both Non-Delivery Warning and Delivery Notification.

Delivery Monitoring

One digit that indicates how monitoring will be performed by the SWIFT network. Optional.

Valid values are:

No Delivery Monitoring (default)
1 (Warning Message) indicates that a warning message will be given if the message is not delivered within a reasonable period
2 (Delivery Notification) indicates notification when the message is delivered
3 (Non-Delivery Warning and Delivery Notification) indicates that both the non-delivery warning and delivery notification will be given
Note: The allowable options are tied to the Message Priority: priority Urgent requires that the user select 1 or 3, priority Normal enables the user to select 2 or No Delivery Monitoring.

Note: If Delivery Monitoring is enabled, two Correlations are created when a message is sent. These Correlations are the same names used by the XML Format 2 envelope: MessageStatusIsSuccess and ReceiverDeliveryStatus. The values for both Correlations are initialized to WAITING. When the Delivery Notification or Non-Delivery Warning message is processed these Correlation values will be updated appropriately. If a Delivery Notification message is processed, that means the message has been delivered to the recipient. Therefore, ReceiverDeliveryStatus is set to RcvDelivered and MessageStatusIsSuccess is set to true. If a Non-Delivery Warning message is processed, then the ReceiverDeliveryStatus will be set to RcvDelayedNak, indicating that the a message has been rejected by FIN. For a Non-Delivery Warning message, MessageStatusIsSuccess is set to false. Likewise, if a NAK message is processed, the ReceiverDeliveryStatus is set to RcvDelayedNak because the message has been rejected by FIN and will not be delivered.

Obsolescence Period

Indicates the time after which a delayed message trailer will be added to the message by the SWIFT network if it has not yet been delivered. This is also the period after which a non-delivery warning will be generated by the SWIFT network, if the appropriate choice for the Delivery Monitoring parameter has been selected (that is, if you selected option 3 for Delivery Monitoring). Optional.

Note: This parameter must be three numerics. Each unit represents five minutes (so, for example, 003 equates to 15 minutes). SWIFT requires leading zeros, so the if the number of minutes is less than 3 digits, you must include leading zeroes.

Use MQHA Delivery Notification Reconciliation

Allows you to specify whether to reconcile Delivery Notification messages with the original message. Valid values are Yes and No (default - this specifies that just the ACK/NAK message will be reconciled). Required.

FIN Copy Service Code (tag 103):

A typical configuration requires that the FIN Copy Service Code tag be included in the envelope (usually set to COP). Optional.

The SWIFT network support the FIN Copy mode, in which a message is sent to an intermediary for approval before it goes to its final destination (or is just copied to the intermediary without requiring approval).

Banking Priority (tag 113):

A four-character optional tag indicating the banking priority. The allowed values are agreed on by you and your trading partner or partners. Optional.

Validation Flag (tag 119):

Specifies the validation flag. Required.

This is an optional part of the header that can contain a code word to indicate that certain types of validations should be performed on the enveloped message.

The valid values for this tag vary depending on the message type.

Note: Be sure to configure your SWIFT envelopes appropriately for the version of SWIFT that you are using.

Payment Release Information (tag 115):

Specifies the payment release information. Optional.

This is an envelope component used in FIN Copy that contains information from the central institution to the receiver of the payment message. The information from this parameter will be placed by the SWIFT network into the MT 097 FIN Copy Message Authorization/Refusal Notification in Y-copy mode.

Include Possible Duplicate Emission (PDE) Trailer

Indicates whether to include a trailer specifying that this message may be a duplicate. Required.

This is an optional component of the envelope that indicates that this message may already have been sent. For example, if the system crashes during the delivery of a message, another copy of the message could be sent, with this trailer included to indicate that it may be a duplicate.

Valid values are Yes and No (default).

Include Training (TNG) Trailer

Specifies whether to include a training (TNG) trailer. Required.

This is an optional component of the envelope that indicates the message contained is being sent for system testing purposes.

Valid values are Yes and No (default).

Sender Logical Terminal

Specifies the logical terminal for outbound FIN. This is a single alphanumeric character Required.

Note: This parameter is necessary to send messages through the WebSphere® MQ adapter using the FileAct protocol.

* Sender Branch Code

Three-character code that further refines the Sender ID. For example, if the SenderID is ROMANSFL, the branch code might be WAS to indicate the Washington branch. This parameter acts as the Sender ID qualifier for envelope matching. Required.

* Receiver Branch Code

Three-character code that further refines the Receiver ID. For example, if the ReceiverID is ROMANSFL, the branch code might be WAS to indicate the Washington branch. This parameter acts as the Receiver ID qualifier for envelope matching. Required.

Maximum Message Size

The maximum size of message that is allowed. The default is 10,000. This parameter only accepts numeric input.

Only displayed if you selected Yes for the Enforce Message Size Limit parameter. Required.

Expect an acknowledgement for messages sent using this envelope

Whether to expect an acknowledgement for messages that are sent using this envelope. Valid values are Yes and No (default). Required.

Acknowledgement overdue after this many hours

Amount of time, in hours, within which you must receive an acknowledgement. Valid value is four numeric characters. Optional.

Acknowledgement overdue after this many minutes

Amount of time, in minutes, within which you must receive an acknowledgement. Valid value is four numeric characters. Optional.

Use global control number

Whether to use a global control number. Required. Valid values are:

Yes (default)
Yes (and generate from data)

Note: If you select this option, you must select at least one parameter for Primary Name Format.

Displayed only if Message User Reference is set to Use Control Number.

Primary Name Format

Check boxes to instruct what information to include when generating a name for a primary global control number and finding the correct number to assign based on that name. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

Note: If you are using a generated global control number (Use global control number is set to Yes (and generate name from data)), the Sterling B2B Integrator tries to generate and match the following control numbers:

First, it tries to generate and match the control number in the primary name format (replacing the values that are selected for the corresponding value in the message). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the control number SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing control number that matches the names generated in steps 1-3, a control number with the name assigned in the first step is created.

Use first backup name format

Whether to use the first backup name format if the primary format does not generate a match. Default is selected (use first backup name format).

First Backup Name Format

The first backup name format to use when generating a global control number. The system allows for two 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. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

First, it tries to generate and match the control number in the primary name format (replacing the values that are selected for the corresponding value in the message). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the control number SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing control number that matches the names generated in steps 1-3, a control number with the name assigned in the first step is created.

Use second backup name format

Whether to use the second backup name format if the primary format does not generate a match. Default is selected (use second backup name format).

Second Backup Name Format

The second backup name format to use when generating a global control number. The system allows for two 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. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

First, it tries to generate and match the control number in the primary name format (replacing the values that are selected for the corresponding value in the message). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the control number SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing control number that matches the names generated in steps 1-3, a control number with the name assigned in the first step is created.

Global Message User Reference (MUR) Control Number

Select the control number with which to start generating control numbers. Optional.

Displayed only if Message User Reference is set to Use Control Number.

Process Data element from which to set the Message User Reference

Specify the process data element from which the MUR will be set.

Displayed only if Message User Reference is set to Use value from process data. Required.

Local Message User Reference (MUR)

The message user reference block is an optional section in the SWIFT envelope that the SWIFT network tracks for acknowledgement purposes. If you choose to use a local control number as the user reference, type the starting value of that control number in this parameter.

Translate documents prior to enveloping

Whether to translate the documents prior to enveloping them. Valid values are Yes or No (default). Required.

Map Name Mode

How to determine which map to use to translate the message. Required. Valid values are:

Specify (default)
Generate from data (this is useful if you want to share across envelopes)

Note: If you select this option, you must select at least one parameter for Primary Name Format. This parameter is displayed only if Translate document prior to enveloping set to Yes.

Treat message as a FileAct message for validation purposes (e.g. for rule 163)

Whether to treat the message as a FileAct message for validation purposes (for example, for rule 163). Valid values are Yes (default) and No. Required.

Map Name

Which map to use to perform a compliance check (if Translate document prior to enveloping set to Yes and Map Name Mode set to Yes). The map must already be checked in to the Sterling B2B Integrator. Optional.

Primary Name Format

Check boxes to instruct what information to include when generating and matching a name for the map. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

Note: If you are using a generated map name (Map Name Mode is set to Generate from data), the Sterling B2B Integrator tries to generate and match the following maps:

First, it tries to generate and match the map in the primary name format (replacing the values that are selected for the corresponding value in the message). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the control number SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing map that matches the names generated in steps 1-3, an error is generated.

Only occurs if Generate an error if no matching map is found is set to Yes.

Use first backup name format

Whether to use the first backup name format if the primary format does not generate a match. Default is selected (use first backup name format).

First Backup Name Format

The first backup name format to use when generating a map name. The system allows for two 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. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

Note: If you are using a generated map name (Map Name Mode is set to Generate from data), the Sterling B2B Integrator tries to generate and match the following maps:

First, it tries to generate and match the map in the primary name format (replacing the values that are selected for the corresponding value in the message). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the control number SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing map that matches the names generated in steps 1-3, an error is generated.

Only occurs if Generate an error if no matching map is found is set to Yes.

Use second backup name format

Whether to use the second backup name format if the primary format does not generate a match. Default is selected (use second backup name format).

Second Backup Name Format

The second backup name format to use when generating a map name. The system allows for two 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. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

Note: If you are using a generated map name (Map Name Mode is set to Generate from data), the Sterling B2B Integrator tries to generate and match the following maps:

First, it tries to generate and match the map in the primary name format (replacing the values that are selected for the corresponding value in the message). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the control number SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing map that matches the names generated in steps 1-3, an error is generated.

Only occurs if Generate an error if no matching map is found is set to Yes.

Generate an error if no matching map is found

Specifies whether to generate an error if the Map Name selected is not found. Valid values are Yes (default) and No.

Note: Only displayed if Map Name Mode is set to Generate from data.

On a translation error, determine the Business Process by

How to determine the business process name to use if there were errors in the translation process. Required. Valid values are:

Specifying a Business Process name (default)
Generating a Business Process name from the data (this is useful if you want to share across envelopes)

Note: If you select this option, you must select at least one parameter for Primary Name Format.

If you select a translation error business process, when a document with compliance errors is encountered an instance of the error business process is generated, using the non-compliant document as the primary document. The processing of that document within the enveloper is halted at that point, and the next document starts processing. If you do not specify a translation error business process, the enveloper continues to process the non-compliant document. In either case, the status report containing the translation errors is created.

If HALT_ON_TRANS_ERROR is set to Yes or True in ProcessData, no more documents are processed after a non-compliant document is encountered. If HALT_ON_TRANS_ERROR is set to No or False in ProcessData, the rest of the documents will be processed after a non-compliant document is encountered. If HALT_ON_TRANS_ERROR is not defined, the behavior depends on the enveloping mode; IMMEDIATE mode behaves as if HALT_ON_TRANS_ERROR is set to True, and DEFERRED mode behaves as if HALT_ON_TRANS_ERROR is set to False.

Primary Name Format

Check boxes to instruct what information to include when generating and matching a name for the error business process name. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

Note: If you are using a generated error business process name (On a translation error, determine Error Business Process Name By is set to Generating a Business Process name from the data), the 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). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the business process SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing business process that matches the names generated in steps 1-3, 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 if the primary format does not generate a match. Default is selected (use first backup name format).

First Backup Name Format

The first backup name format to use when generating an error business process name. The system allows for two 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. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

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). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the business process SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing business process that matches the names generated in steps 1-3, 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 if the primary format does not generate a match. Default is selected (use second backup name format).

Second Backup Name Format

The second backup name format to use when generating an error business process name. The system allows for two 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. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

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). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the business process SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing business process that matches the names generated in steps 1-3, 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

Specify whether to generate an error if there is no match to the generated business process name in the system. Valid values are Yes (default) and No.

Note: Only displayed if On a translation error, determine the Error Business Process By is set to Generating the business process name from the data.

Specifying a business process

Select a previously created business process to associate with this envelope.

Displayed only if On a translation error, determine the Business Process by is set to Specifying a business process names. Optional.

Determine the Business Process By

How to determine the business process name to use if there were no errors in the compliance check. Required. Valid values are:

Specify a Business Process (default)
Generate Business Process Name (from the data)

Note: If you select this option, you must select at least one parameter for Primary Name Format.

Primary Name Format

Check boxes to instruct what information to include when generating and matching a name for the business process. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

Note: If you are using a generated business process name (Determine the Business Process By is set to Generating the business process name from the data), the 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). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the business process SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing business process that matches the names generated in steps 1-3, 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 if the primary format does not generate a match. Default is selected (use first backup name format).

First Backup Name Format

The first backup name format to use when generating a business process name. The system allows for two 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. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

Note: If you are using a generated business process name (Determine the Business Process By is set to Generating a Business Process name from the data), the 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). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the business process SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing business process that matches the names generated in steps 1-3, 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 if the primary format does not generate a match. Default is selected (use second backup name format).

Second Backup Name Format

The second backup name format to use when generating a business process name. The system allows for two 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. Optional.

Select from:

Sender ID
Sender Branch Code
Receiver ID
Receiver Branch Code
Message Format (MT/MX/Any XML)
Message Type
Validation Flag (MT only)
Envelope Format (FIN/XML2)

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). For example, if only message type is selected, and the message type is 100, the Sterling B2B Integrator checks for the business process SWIFT_100_Outbound_FIN.
Second, it tries to generate and match the First Backup Name.
Third, it tries to generate and match the Second Backup Name.
Fourth, if there is not an existing business process that matches the names generated in steps 1-3, 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

Specify whether to generate an error if there is no match to the generated business process name in the system. Required. Valid values are Yes (default) and No.

Note: Only displayed if Determine the Business Process By is set to Generate Business Process Name.

Business Process List

Select a previously created business process to associate with this envelope. Optional.

Displayed only if Determine the Business Process Name is set to Specify Business Process.

Extraction Options

Business process data extraction. Required.

Valid values:

Determined by business process (default)
Extract to a file system directory
Extract to a mailbox

Data Extraction Directory

Directory for data extraction. Displayed only if Extraction Options set to Extract to a file system directory. Optional.

Data Extraction Filename

Filename for data extraction. Displayed only if Extraction Options set to Extract to a file system directory. Optional.

Data Extraction Mailbox

Mailbox for data extraction. Displayed only if Extraction Options set to Extract to a mailbox. Optional.

Data Extraction Mailbox Message Name

Mailbox message name for data extraction. Displayed only if Extraction Options set to Extract to a mailbox. Optional.