MSIF transfer service options

The tables in this section list, for each of the options of a particular option type:

• The default value of the option
• Whether the option can be specified in a SendMsg, SendFile, ProvideFileForDownload, or DownloadFile request (does not apply to MsgReceived, FileReceived, or NotifReceived scenarios, which do not have requests)
• Whether the option can be specified in an option-set CO
• Whether the option can be specified in a default option-set CO
• The system default (if any) that is used when the option is not specified in a request or by means of an option-set CO
• For each scenario, whether the option is mandatory (M), optional (O), or not applicable (empty)

The transfer options specify:

• Information about a particular message or file transfer, such as the DNs of the parties participating in the transfer scenario
• The option-set COs that are to be used when corresponding option sets are not specified explicitly in a request

They are:

ReceiveEnabled

• Pseudo attribute
• This pseudo attribute determines whether this option-set CO is active for MsgReceived, FileReceived, and NotifReceived scenarios. If it is not set, this option-set CO is ignored when processing a request to receive a message or file. This option cannot be specified for the default transfer option-set CO (that is, the CO of type DnfEfaTransferOptionSet with the name default).

LocalDN

• string, 1…100 characters
• This option specifies the distinguished name of the local application that participates in the transfer:
  • For a SendMsg scenario:
    • This option is the RequestorDN of the outbound request that is to be passed to the SAG.
    • This DN must belong to the same organisation (that is, it must have the same values for its first two levels) as the AuthoriserDN specified in the SAG MP option set that is used for the message transfer.
  • For a MsgReceived scenario:
    • This option is compared with the ResponderDN specified in the inbound request that was received from the SAG. This option is used to determine which transfer option-set CO is to be used.
    • This DN must belong to the same organisation (that is, it must have the same values for its first two levels) as the AuthoriserDN specified in the SAG MP option set that is used for the message transfer.
  • For a SendFile scenario:
    • This option is the RequestorDN of the outbound request that is to be passed to the SAG.
    • This DN must belong to the same organisation (that is, it must have the same values for its first two levels) as the AuthoriserDN specified in the SAG MP option set that is used for the file transfer.
  • For a FileReceived scenario:
    • This option is compared with the ResponderDN specified in the inbound request that was received from the SAG. This option is used to determine which transfer option-set CO is to be used.
    • This DN must belong to the same organisation (that is, it must have the same values for its first two levels) as the AuthoriserDN specified in the SAG MP option set that is used for the file transfer.
  • For a DownloadFile scenario:
    • This option is the RequestorDN of the outbound request that is to be passed to the SAG.
    • This DN must belong to the same organisation (that is, it must have the same values for its first two levels) as the AuthoriserDN specified in the SAG MP option set that is used for the file transfer.
  • For a ProvideFileForDownload scenario:
    • This option is compared with the ResponderDN specified in the inbound request that was received from the SAG. This option is used to determine which transfer option-set CO is to be used.
  • For a NotifReceived scenario:
    • If a delivery notification is requested and no LocalDN Delivery Notification option is specified, this is the ResponderDN of the delivery notification.
  Notes:

  1. A transfer option-set CO that is used for a MsgReceived, FileReceived, ProvideFileForDownload, or NotifReceived scenario can specify a % character as a leading wildcard for its LocalDN option. This allows a LocalDN specification to match more than one ResponderDN. For example:

     %,o=xxxxdeff,o=swift

     All ResponderDNs that end with ,o=xxxxdeff,o=swift result in a match.

     %deff,o=swift

     All ResponderDNs that end with deff,o=swift result in a match.

     %

     All ResponderDNs result in a match.

     If the wildcard character is specified, it must be the first character. For example, you cannot specify cn=security% to represent all ResponderDNs that begin with cn=security.
  2. If a SendMsg, SendFile, or DownloadFile scenario uses the LocalDN specified by its transfer option-set CO, that LocalDN cannot contain a wildcard character.

RemoteDN

• string, 1…100 characters
• This option specifies the distinguished name of the remote application participating in the transfer:
  • For a SendMsg, SendFile, or DownloadFile scenario, this is the ResponderDN of the outbound request that is to be passed to the SAG.
  • For a MsgReceived, FileReceived, ProvideFileForDownload, or NotifReceived scenario, this is the RequestorDN specified in the inbound request that was received from the SAG. This option is used to determine which transfer option-set CO is to be used.
  Notes:

  1. A transfer option-set CO that is used for a MsgReceived, FileReceived, ProvideFileForDownload, or NotifReceived scenario can specify a % character as a leading wildcard for its RemoteDN option. This allows a RemoteDN specification to match more than one RequestorDN. For example:

     %,o=xxxxdeff,o=swift

     All RequestorDNs that end with ,o=xxxxdeff,o=swift result in a match.

     %deff,o=swift

     All RequestorDNs that end with deff,o=swift result in a match.

     %

     All RequestorDNs result in a match.

     If the wildcard character is specified, it must be the first character. For example, you cannot specify cn=security% to represent all RequestorDNs that begin with cn=security.
  2. If a SendMsg, SendFile, or DownloadFile scenario uses the RemoteDN specified by its transfer option-set CO, that RemoteDN cannot contain a wildcard character.

Service

• string, 1…30 characters
• This option specifies the name of the business service for which the transfer is conducted. This name is defined by the service administrator and must be approved by SWIFT. For example, the generic FileAct service provided by SWIFT for test purposes has the name swift.generic.fa!p. For more information about this type of service, see SWIFTNet Messaging Operations Guide.
  Notes:

  1. A transfer option-set CO that is used for a MsgReceived, FileReceived, ProvideFileForDownload, or NotifReceived scenario can specify a % character as a wildcard for its Service option to indicate that, when determining which transfer option-set CO is to be used, all services are to result in a match. The wildcard character cannot be combined with other characters. For example, you cannot specify a% to represent all services that begin with the letter a.
  2. If a SendMsg, SendFile, or DownloadFile scenario uses the Service option specified by its transfer option-set CO, that option cannot contain a wildcard character.

RequestType

• string, 1…30 characters
• This option specifies the request type used for the transfer. It is defined by the service administrator. This request type does not apply to delivery notifications, which use the request type described in Delivery notification options: DelNotifOptions.
  Notes:

  1. A transfer option-set CO that is used for a MsgReceived, FileReceived, ProvideFileForDownload, or NotifReceived scenario can specify a % character as a wildcard for its RequestType option to indicate that, when determining which transfer option-set CO is to be used, all request types are to result in a match. The wildcard character cannot be combined with other characters. For example, you cannot specify a% to represent all request types that begin with the letter a.
  2. If a SendMsg, SendFile, or DownloadFile scenario uses the RequestType option specified by its transfer option-set CO, that option cannot contain a wildcard character.

MsgSendOptionSet (SendOptionSet for a SendMsg request)

• string, 1…30 characters
• This option specifies the name of the message send option-set CO that is to be used if none is specified in a SendMsg request.

MsgReceiveOptionSet

• string, 1…30 characters
• This option specifies the name of the message receive option-set CO that is to be used.

FileSendOptionSet (SendOptionSet for a SendFile request)

• string, 1…30 characters
• This option specifies the name of the file send option-set CO that is to be used if none is specified in a SendFile request.

FileReceiveOptionSet

• string, 1…30 characters
• This option specifies the name of the file receive option-set CO that is to be used if none is specified in a FileReceived request. This option can be specified only if the FileReceiveOptionSetGroup option is not specified.

FileReceiveOptionSetGroup

• string, 1…30 characters
• This option specifies the name of the group that contains the file receive option-set CO that is to be used. This option can be specified only if the FileReceiveOptionSet option is not specified. The Group option of a file receive option-set CO determines the name of the group to which that CO belongs, if any.

  Which of the receive option sets in a group is used depends on the values of their FileInfo, TransferInfo, and HeaderInfo options and on the contents of the Sw:FileInfo, Sw:TransferInfo, and Sw:HeaderInfo fields of the inbound primitive. For more information about receive option-set CO groups, see File-receive option-set groups.

ProvideOptionSet

• string, 1…30 characters
• This option specifies the name of the provide option-set CO that is to be used if none is specified in a ProvideFileForDownload request.

DownloadOptionSet

• string, 1…30 characters
• This option specifies the name of the download option-set CO that is to be used if none is specified in a DownloadFile request.

DelNotifOptionSet

• string, 1…30 characters
• This option specifies the name of the delivery notification option set that is to be used if none is specified in a SendMsg, SendFile, or ProvideFileForDownload request.

FileOptionSet

• string, 1…30 characters
• This option specifies the name of the file option-set CO that is to be used if none is specified in a request.

SagMPOptionSet

• string, 1…30 characters
• This option specifies the name of the SAG MP option set that is to be used.
  Notes:

  1. This option is ignored if an SagMPOptionSetGroup is also specified.
  2. This option cannot be specified for a SendMsg scenario that uses an input channel. For such a scenario, the SAG MP option set or SAG MP option set group that is specified by the CO of type DnfEfaInputChannel that corresponds to the input channel is used.
  3. This option is ignored for a FileReceived or MsgReceived scenario that uses SnF mode. For such a scenario, the SAG MP option set CO that is specified for the output channel or SnF queue is used.

SagMPOptionSetGroup

• string, 1…30 characters
• The Group option of an SAG MP option set determines the name of the group to which that CO belongs, if any:
  • For a SendMsg or SendFile scenario, the SAG MP option-set group is used when a scenario needs to switch among several SAG MP option sets.
  • For a MsgReceived, FileReceived, or RespondDownload scenario, the SAG MP option-set group is used for traffic distribution.
  For more information about SAG MP option-set groups, see Option-set groups.
  Notes:

  1. If both an SagMPOptionSetGroup and SagMPOptionSet option are specified, the SagMPOptionSetGroup option is used and the SagMPOptionSet option is ignored.
  2. This option cannot be specified for a SendMsg scenario that uses an input channel. For such a scenario, the SAG MP option set or SAG MP option set group that is specified by the CO of type DnfEfaInputChannel that corresponds to the input channel is used.
  3. This option is ignored for a FileReceived or MsgReceived scenario that uses SnF mode. For such a scenario, the SAG MP option set CO that is specified for the output channel or SnF queue is used.

The message send options specify how a message is to be sent to a counterpart:

Signed

• string, enumerated
• This option indicates whether the SAG is to sign the request digests:

  True

  The digests are to be signed using the SignerDN configured in the SAG MP option set.

  False

  The digests are not to be signed. This is the default.

Encrypted

• string, enumerated
• This option indicates whether the request is to be encrypted by the SAG:

  True

  The request is to be encrypted using the EncryptDN configured in the SAG MP option set. This value can be set only when CryptoMethod=CryptoBlock and NRIndication=False.

  False

  The request is not encrypted. This is the default.

CryptoMethod

• string, enumerated
• This option indicates which cryptographic method is to be used to sign the request digests (if Signed=True) or to encrypt the contents of the message (if Encrypted=True):

  CryptoBlock

  Use SWIFT CryptoBlock capability. This is the default.

  SignatureList

  Use SWIFT SignatureList capability. The SignerDN that is specified in the SAG MP option set is used to create the signature list (see SAG message partner options: SagMPOptions). This value can be set only when Encrypted=False.

Table 1 shows the valid combinations of the values of the Sign, Encrypt, and CryptoMethod options for messages that are to be sent. The combination of these options determines:

• Whether non-repudiation processing is possible, that is, whether the NRIndication option can be set to True
• Which DNs are used to authorize, sign, and encrypt a message before it is sent

The AuthoriserDN, SignerDN and EncryptDN are specified by the SAG MP option set (see SAG message partner options: SagMPOptions). If a DN is to be used but is not configured in the SAG MP option set, the request is returned to the application with an error.

Table 1. Valid combinations of Sign, Encrypt, and CryptoMethod options for messages

	Combination 1	Combination 2	Combination 3	Combination 4	Combination 5
Signed	False	True	True	False	True
Encrypted	False	False	False	True	True
CryptoMethod	(ignored)	CryptoBlock	SignatureList	CryptoBlock	CryptoBlock
	↓	↓	↓	↓	↓
Non-repudiation processing possible	no	yes	yes	no	no
DN used to authorize	AuthoriserDN	AuthoriserDN	AuthoriserDN	AuthoriserDN	AuthoriserDN
DN used to sign	-	SignerDN	SignerDN	-	SignerDN
DN used to encrypt	-	-	-	EncryptDN	EncryptDN

ReturnSignatureList

• string, enumerated
• This option specifies whether the signature list that was calculated by the sending SAG and was inserted into the InterAct primitive is to be returned to the sending application in the RequestSignatureList field of the response:

  True

  The signature is to be returned. This value can be set only if Signed=True and CryptoMethod=SignatureList.

  False

  The signature is not to be returned. This is the default.

NRIndication

• string, enumerated
• The ASP of a service specifies whether non-repudiation processing for that service is mandatory, optional, or not allowed. When non-repudiation processing is optional, the NRIndication option specifies whether the SIPN is to perform non-repudiation processing:

  True

  Non-repudiation processing is performed. Specify this value only if Signed=True.

  False

  Non-repudiation processing is not performed.

  When non-repudiation processing is mandatory or not allowed, the NRIndication option must either be unspecified, or must be specified correctly:

  ASP specifies that non-repudiation processing is…	Setting of the NRIndication option
  	True	False	(not specified)
  Mandatory	The SIPN performs non-repudiation processing.	The request is rejected as being invalid.	The SIPN performs non-repudiation processing.
  Optional	The SIPN performs non-repudiation processing.	The SIPN does not perform non-repudiation processing.	The SIPN does not perform non-repudiation processing.
  Not allowed	The request is rejected as being invalid.	The SIPN does not perform non-repudiation processing.	The SIPN does not perform non-repudiation processing.

DeliveryMode

• string, enumerated
• This option specifies the delivery mode:

  SNF

  Store-and-forward

  RT

  Real-time. This is the default.

SnFReturnBusMsg

• string, enumerated
• This option specifies whether, for a message sent in SnF delivery mode, the body of the response that is passed to the application is to contain the business message of the corresponding request:

  Yes

  It is, regardless of whether an error occurs.

  Error

  It is, but only if there was an error that prevented the request from being delivered to the SnF queue. This is the default.

  Note: This option applies only to messages sent in SnF delivery mode. If specified for a message sent in real-time mode:

  • If specified by means of a message-send option-set CO, it is ignored.
  • If specified explicitly in the SendMsg request, the MSIF transfer service issues a validation error.

DeliveryNotif

• string, enumerated
• This option specifies whether the SIPN is to send a successful-delivery notification after the counterpart receives and acknowledges a message that was sent in SnF mode:

  True

  The SIPN is to send a delivery notification. Specify this value only when DeliveryMode=SNF.

  False

  The SIPN is not to send a delivery notification. This is the default.

  Notes:

  1. This option does not apply to messages sent in real-time mode.
  2. If the receiver indicated to the SIPN that the message transfer was unsuccessful, or if the message was not delivered within 15 days, the SIPN creates a failed-delivery notification and sends it to the sender, regardless of the value of this option.

Priority

• string, enumerated
• This option specifies the priority of the request:

  Normal

  Normal priority. This is the default.

  Urgent

  Urgent priority

  If specified, this is transferred to the counterpart as a normalized value. The MSIF transfer service does not evaluate or alter the value of this option. For more information, see SWIFTNet Service Design Guide.

PayloadType

• string, 1…254 characters
• This option specifies the type of the request payload. Possible values are defined by the SWIFTNet service that is to be used.

RelativeExpiration

• duration
• This option specifies the amount of time that is available for the corresponding SendMsg scenario:
  • For a scenario that uses real-time delivery mode, or that uses SnF delivery mode and a queue session, the scenario must reach the Complete state before the end of the expiration period.
  • For a scenario that uses SnF delivery mode and a channel session, the scenario must reach the Initiated state at least once before the end of the expiration period. (Such a scenario might return to the Requested state due to resynchronization.)
  If the scenario exceeds its expiration period, the MSIF transfer service issues an error event and issues a response to the originating application. If this option is not specified, there is no limit to the amount of time available for the scenario.
  The value must have the form:

  PdDThHmM

  where:

  d

  The number of days

  h

  The number of hours (0 - 23)

  m

  The number of minutes (0 - 59)

  For example, if the scenario is to complete within 7 hours and 12 minutes after processing of the SendMsg request begins, specify:

  P0DT7H12M

ResponseCCSID

• string
• This specifies the coded character set (CCSID) in which the payload of the response from the SAG is to be encoded:

  1208

  The response payload is to be encoded using CCSID 1208, which corresponds to code page UTF-8. The Format field in the MQRFH2 of the request must contain one of the following values:

  MQFMT_STRING

  The CodedCharSetId field in the MQRFH2 must match the encoding of the payload.

  MQFMT_NONE

  The payload must be encoded using CCSID 1208, and the CodedCharSetId field in the MQRFH2 is ignored.

  request

  The same CCSID that was used for the request payload is to be used for the response payload. The value of the Format field in the MQRFH2 of the request must be MQFMT_STRING, and the value of the CodedCharSetId field in the MQRFH2 must match the encoding of the payload.

If the MSIF transfer service does not pass the request to the SAG (for example, due to an error), it generates a response and does not encode the response payload.

OverdueWarningDelay

• int, 5…1440
• The number of minutes after which, if the message was not delivered to or acknowleged by the counterpart, the SIPN is to consider the message to be overdue and send a non-delivery warning to the sender. The OverdueWarningDelay and OverdueTime options are mutually exclusive. There is no default; if OverdueWarningDelay and OverdueTime are both not specified, the SIPN does not send a non-delivery warning.

OverdueTime

• dateTime
• The date and time at which, if the message was not delivered to or acknowleged by the counterpart, the SIPN is to consider the message to be overdue and send a non-delivery warning to the sender. The OverdueWarningDelay and OverdueTime options are mutually exclusive. There is no default; if OverdueWarningDelay and OverdueTime are both not specified, the SIPN does not send a non-delivery warning. The OverdueTime option can be specified only in a request, not by means of an option-set CO.

Copy

• string, enumerated
• The ASP of a service specifies whether the use of Y-Copy or T-Copy mode for that service is mandatory, optional, or not allowed. When the use of a copy mode is optional, the Copy option specifies whether that copy mode is to be used:

  True

  The copy mode is to be used.

  Note: Because Y-Copy or T-Copy can be used only for SnF transfers, this value is not allowed when the DeliveryMode option is set to RT.

  False

  The copy mode is not to be used.

  When the use of copy mode is mandatory or not allowed, the Copy option must either be unspecified, or must be specified correctly:

  ASP specifies that use of a SWIFTNet Copy feature is…	Setting of the Copy option
  	True	False	(not specified)
  Mandatory	The copy mode is used.	The request is not processed.	The copy mode is used.
  Optional	The copy mode is used.	The copy mode is not used.	The copy mode is not used.
  Not allowed	The request is not processed.	The copy mode is not used.	The copy mode is not used.

AuthNotif

• string, enumerated
• The ASP of a service specifies whether that service uses Y-Copy mode and, if so, whether sending an authorisation notification to the sender is mandatory, optional, or not allowed. If it is optional, the AuthNotif option specifies what is to be done after a third party authorizes or refuses a request:

  True

  The SIPN is to send an authorisation notification to the sender. This value is allowed only if:

  • SWIFTNet Y-Copy is used.
  • The ASP specifies that the service is allowed to send authorisation notifications.

  False

  The SIPN is not to send an authorisation notification to the sender.

  When the sending of authorisation notifications is mandatory or not allowed, the AuthNotif option must either be unspecified, or must be specified correctly:

  ASP specifies that sending an authorisation notification is…	Setting of the AuthNotif option
  	True	False	(not specified)
  Mandatory	The SIPN sends an authorisation notification.	The request is rejected as being invalid.	The SIPN sends an authorisation notification.
  Optional	The SIPN sends an authorisation notification.	The SIPN does not send an authorisation notification.	The SIPN does not send an authorisation notification.
  Not allowed	The request is rejected as being invalid.	The SIPN does not send an authorisation notification.	The SIPN does not send an authorisation notification.

InputChannelName

• string, 1…30 characters
• This option specifies that the InterAct message that corresponds to this SendMsg request is to be sent via an input channel session, and the name of the channel. The channel must already be created, and a corresponding CO of type DnfEfaInputChannel must already be configured. This option can be specified only if the SendMsg request also specifies that SnF delivery mode is to be used (that is, if DeliveryMode is set to SNF). If no input channel name is specified, the message is not sent via an input channel session.

SignatureOptionSet

• string, 1…30 characters
• This is the name of the signature option-set CO that is to be used for a SendMsg request (see Signature options: SignatureOptions). Specify this option only when a signature list is to be used, that is, when both Signed=True and CryptoMethod=SignatureList. When a signature list is to be used, a SignerDN must be specified in the SAG MP option set (see SAG message partner options: SagMPOptions).

ProductInfoOptionSet

• string, 1…30 characters
• This is the name of the product information option-set CO that is to be used for a SendMsg request (see Product information options: ProductInfoOptions).

ThirdPartyOptionSet

• string, 1…30 characters
• This is the name of the third-party information option-set CO that is to be used for the SendMsg request (see Third-party options: ThirdPartyOptions).

The file send options specify how a file is to be sent to a counterpart:

Signed

• string, enumerated
• This indicates whether the SAG is to sign the request digests:

  True

  The digests are to be signed using the SignerDN configured in the SAG MP option set.

  False

  The digests are not to be signed. This is the default.

CryptoMethod

• string, enumerated
• This indicates which cryptographic method is to be used to sign the request digests (if Signed=True):

  CryptoBlock

  Use SWIFT CryptoBlock capability. This is the default.

  SignatureList

  Use SWIFT SignatureList capability. The SignerDN that is specified in the SAG MP option set is used to create the signature list (see SAG message partner options: SagMPOptions).

Table 2 shows the valid combinations of the values of the Sign and CryptoMethod options for file-transfer requests. The combination of these options determines:

• Whether non-repudiation processing is possible
• Which DNs are used to authorize and sign a file-transfer request before it is sent

The AuthoriserDN and SignerDN are specified by the SAG MP option set (see SAG message partner options: SagMPOptions). If a DN is to be used but is not configured in the SAG MP option set, the request is returned to the application with an error.

Table 2. Valid combinations of Sign and CryptoMethod options for file-transfers

	Combination 1	Combination 2	Combination 3
Signed	False	True	True
CryptoMethod	(ignored)	CryptoBlock	SignatureList
	↓	↓	↓
Non-repudiation processing possible	no	yes	yes
DN used to authorize	AuthoriserDN	AuthoriserDN	AuthoriserDN
DN used to sign	-	AuthoriserDN	SignerDN

ReturnSignatureList

• string, enumerated
• This option specifies whether the signature list that was calculated by the sending SAG and was inserted into the FileAct primitive is to be returned to the sending application in the RequestSignatureList field of the response:

  True

  The signature is to be returned. This value can be set only if Signed=True and CryptoMethod=SignatureList.

  False

  The signature is not to be returned. This is the default.

NRIndication

• string, enumerated
• The ASP of a service specifies whether non-repudiation processing for that service is mandatory, optional, or not allowed. When non-repudiation processing is optional, the NRIndication option specifies whether the SIPN is to perform non-repudiation processing:

  True

  Non-repudiation processing is performed. Specify this value only if Signed=True.

  False

  Non-repudiation processing is not performed.

  When non-repudiation processing is mandatory or not allowed, the NRIndication option must either be unspecified, or must be specified correctly:

  ASP specifies that non-repudiation processing is…	Setting of the NRIndication option
  	True	False	(not specified)
  Mandatory	The SIPN performs non-repudiation processing.	The request is rejected as being invalid.	The SIPN performs non-repudiation processing.
  Optional	The SIPN performs non-repudiation processing.	The SIPN does not perform non-repudiation processing.	The SIPN does not perform non-repudiation processing.
  Not allowed	The request is rejected as being invalid.	The SIPN does not perform non-repudiation processing.	The SIPN does not perform non-repudiation processing.

DeliveryMode

• string, enumerated
• This specifies the delivery mode:

  SNF

  Store-and-forward

  RT

  Real-time. This is the default.

TransferDescription

• string, 0…256 characters (in message) or 254 characters (in option-set CO)
• This is a textual description of the file transfer and is not intended for automatic processing. The MSIF transfer service does not evaluate or alter the value of this option.

TransferInfo

• string, 0…256 characters (in message) or 254 characters (in option-set CO)
• This is structured information, in Backus-Naur form, about the file transfer to be conducted:
  • A list of entries of the form key=value separated by semicolons.
  • Keys are arbitrary. SWIFT recommends that distinct values be used.
  For more information, see SWIFTNet Link: Interface Specification.

DeliveryNotif

• string, enumerated
• This specifies whether the SIPN is to send a delivery notification after the counterpart has received the file and acknowledged that the file transfer was successful:

  True

  The SIPN is to send a delivery notification

  False

  The SIPN is not to send a delivery notification. This is the default.

  Note: If the receiver indicated to the SIPN that the file transfer was unsuccessful, or if file was transferred in SnF mode and was not delivered within 15 days, the SIPN creates a failed-delivery notification and sends it to the sender, regardless of the value of this option.

Priority

• string, enumerated
• Specifies the priority of the request:
  • Normal (this is the default)
  • Urgent
  If a priority is specified for a SendFile request, the MSIF transfer service sets the priority of the SNL primitive to the corresponding value. For more information, see SWIFTNet Service Design Guide.

RelativeExpiration

• duration
• This option specifies the amount of time that is available for the corresponding SendFile scenario. The scenario must reach the Complete state before the end of the expiration period. If the scenario exceeds its expiration period, the MSIF transfer service issues an error event and issues a response to the originating application. If this option is not specified, there is no limit to the amount of time available for the scenario.
  The value must have the form:

  PdDThHmM

  where:

  d

  The number of days

  h

  The number of hours (0 - 23)

  m

  The number of minutes (0 - 59)

  For example, if the scenario is to complete within 7 hours and 12 minutes after processing of the SendFile request begins, specify:

  P0DT7H12M

Copy

• string, enumerated
• The ASP of a service specifies whether the use of Y-Copy or T-Copy mode for that service is mandatory, optional, or not allowed. When the use of a copy mode is optional, the Copy option specifies whether that copy mode is to be used:

  True

  The copy mode is to be used.

  Note: Because Y-Copy or T-Copy can be used only for SnF transfers, this value is not allowed when the DeliveryMode option is set to RT.

  False

  The copy mode is not to be used.

  When the use of copy mode is mandatory or not allowed, the Copy option must either be unspecified, or must be specified correctly:

  ASP specifies that use of a SWIFTNet Copy feature is…	Setting of the Copy option
  	True	False	(not specified)
  Mandatory	The copy mode is used.	The request is not processed.	The copy mode is used.
  Optional	The copy mode is used.	The copy mode is not used.	The copy mode is not used.
  Not allowed	The request is not processed.	The copy mode is not used.	The copy mode is not used.

AuthNotif

• string, enumerated
• The ASP of a service specifies whether that service uses Y-Copy mode and, if so, whether sending an authorisation notification to the sender is mandatory, optional, or not allowed. If it is optional, the AuthNotif option specifies what is to be done after a third party authorizes or refuses a request:

  True

  The SIPN is to send an authorisation notification to the sender. This value is allowed only if:

  • SWIFTNet Y-Copy is used.
  • The ASP specifies that the service is allowed to send authorisation notifications.

  False

  The SIPN is not to send an authorisation notification to the sender.

  When the sending of authorisation notifications is mandatory or not allowed, the AuthNotif option must either be unspecified, or must be specified correctly:

  ASP specifies that sending an authorisation notification is…	Setting of the AuthNotif option
  	True	False	(not specified)
  Mandatory	The SIPN sends an authorisation notification.	The request is rejected as being invalid.	The SIPN sends an authorisation notification.
  Optional	The SIPN sends an authorisation notification.	The SIPN does not send an authorisation notification.	The SIPN does not send an authorisation notification.
  Not allowed	The request is rejected as being invalid.	The SIPN does not send an authorisation notification.	The SIPN does not send an authorisation notification.

OverdueWarningDelay

• int, 5…1440
• The number of minutes after which, if the file was not delivered to or acknowleged by the counterpart, the SIPN is to consider the file to be overdue and send a non-delivery warning to the sender. The OverdueWarningDelay and OverdueTime options are mutually exclusive. There is no default; if OverdueWarningDelay and OverdueTime are both not specified, the SIPN does not send a non-delivery warning.

OverdueTime

• dateTime
• The date and time at which, if the file was not delivered to or acknowleged by the counterpart, the SIPN is to consider the file to be overdue and send a non-delivery warning to the sender. The OverdueWarningDelay and OverdueTime options are mutually exclusive. There is no default; if OverdueWarningDelay and OverdueTime are both not specified, the SIPN does not send a non-delivery warning. The OverdueTime option can be specified only in a request, not by means of an option-set CO.

ProductInfoOptionSet

• string, 1…30 characters
• This is the name of the product information option-set CO that is to be used for the SendFile request (see Product information options: ProductInfoOptions).

ThirdPartyOptionSet

• string, 1…30 characters
• This is the name of the third-party information option-set CO that is to be used for the SendFile request (see Third-party options: ThirdPartyOptions).

The provide options determine how a file is to be made available for downloading by counterparts:

DeliveryNotif

• string, enumerated
• This specifies whether each counterpart that downloads the file is to send a successful-delivery notification after the download is complete:

  True

  The counterpart is to send a successful-delivery notification.

  False

  The counterpart is not to send a successful-delivery notification.

  If the download is unsuccessful, the counterpart does not send a delivery notification.

RelativeExpiration

• duration
• This option specifies the amount of time that is available for the corresponding ProvideFileForDownload scenario. The scenario must reach the Complete state before the end of the expiration period. If the scenario exceeds its expiration period, the MSIF transfer service issues an error event and issues a response to the originating application. If this option is not specified, there is no limit to the amount of time available for the scenario.
  The value must have the form:

  PdDThHmM

  where:

  d

  The number of days

  h

  The number of hours (0 - 23)

  m

  The number of minutes (0 - 59)

  For example, if the scenario is to complete within 7 hours and 12 minutes after processing of the ProvideFileForDownload request begins, specify:

  P0DT7H12M

PassSignatureList

• string, enumerated
• This specifies whether the signature list of each request to download the file is to be passed to the application that provided the file for downloading:

  True

  The signature list is to be passed.

  False

  The signature list is not to be passed. This is the default.

ProductInfoOptionSet

• string, 1…30 characters
• This is the name of the product information option-set CO that is to be used to send information about the application that provides the file for download (see Product information options: ProductInfoOptions).

The download options determine how a file is to be downloaded from a counterpart:

Signed

• string, enumerated
• This indicates whether the SAG is to sign the request digests:

  True

  The digests are to be signed using the SignerDN configured in the SAG MP option set.

  False

  The digests are not to be signed. This is the default.

CryptoMethod

• string, enumerated
• This indicates which cryptographic method is to be used to sign the request digests (if Signed=True):

  CryptoBlock

  Use SWIFT CryptoBlock capability. This is the default.

  SignatureList

  Use SWIFT SignatureList capability. The SignerDN that is specified in the SAG MP option set is used to create the signature list (see SAG message partner options: SagMPOptions).

Table 3 shows the valid combinations of the values of the Sign and CryptoMethod options for file-download requests. The combination of these options determines:

• Whether non-repudiation processing is possible
• Which DNs are used to authorize and sign a file-download request before it is sent

The AuthoriserDN and SignerDN are specified by the SAG MP option set (see SAG message partner options: SagMPOptions). If a DN is to be used but is not configured in the SAG MP option set, the request is returned to the application with an error.

Table 3. Valid combinations of Sign and CryptoMethod options for file-download requests

	Combination 1	Combination 2	Combination 3
Sign	False	True	True
CryptoMethod	(ignored)	CryptoBlock	SignatureList
	↓	↓	↓
Non-repudiation processing possible	no	yes	yes
DN used to authorize	AuthoriserDN	AuthoriserDN	AuthoriserDN
DN used to sign	-	AuthoriserDN	SignerDN

ReturnSignatureList

• string, enumerated
• This option specifies whether the signature list that was calculated by the sending SAG and was inserted into the FileAct primitive is to be returned to the sending application in the RequestSignatureList field of the response:

  True

  The signature is to be returned. This value can be set only if Signed=True and CryptoMethod=SignatureList.

  False

  The signature is not to be returned. This is the default.

NRIndication

• string, enumerated
• The ASP of a service specifies whether non-repudiation processing for that service is mandatory, optional, or not allowed. When non-repudiation processing is optional, the NRIndication option specifies whether the SIPN is to perform non-repudiation processing:

  True

  Non-repudiation processing is performed. Specify this value only if Signed=True.

  False

  Non-repudiation processing is not performed.

  When non-repudiation processing is mandatory or not allowed, the NRIndication option must either be unspecified, or must be specified correctly:

  ASP specifies that non-repudiation processing is…	Setting of the NRIndication option
  	True	False	(not specified)
  Mandatory	The SIPN performs non-repudiation processing.	The request is rejected as being invalid.	The SIPN performs non-repudiation processing.
  Optional	The SIPN performs non-repudiation processing.	The SIPN does not perform non-repudiation processing.	The SIPN does not perform non-repudiation processing.
  Not allowed	The request is rejected as being invalid.	The SIPN does not perform non-repudiation processing.	The SIPN does not perform non-repudiation processing.

TransferDescription

• string, 0…256 characters (in message) or 254 characters (in option-set CO)
• This is a textual description of the file transfer and is not intended for automatic processing. The MSIF transfer service does not evaluate or alter the value of this option.

TransferInfo

• string, 0…256 characters (in message) or 254 characters (in option-set CO)
• This is structured information, in Backus-Naur form, about the file transfer to be conducted:
  • A list of entries of the form key=value separated by semicolons.
  • Keys are arbitrary. SWIFT recommends that distinct values be used.
  For more information, see SWIFTNet Link: Interface Specification.

MaxFileSize

• int, 0…2147483647
• This is one of two options that specify the maximum size, in bytes, that the file that is to be received must not exceed. The other is the MaxFileSize option specified in the SAG communications option set, which are described in SAG communication options: SagCommOptions. An attempt to download a file that exceeds the smaller of these two MaxFileSize settings is rejected. For compressed files, this option applies to the size of the file before decompression.
  Note: Restrictions imposed by applications and other system components might affect the value you specify for this option, for example:

  • If the SAG is to pass the downloaded file to the MSIF transfer service by means of IBM MQ messages, and if such files are not to be divided into chunks (see the description of the LftChunking option in SAG communication options: SagCommOptions), the size of the file before decompression must be less than 104857600 bytes (100 MB).
  • If the MSIF transfer service is to pass the downloaded file to the application by means of IBM MQ messages, the size of the file after decompression must be less than 104857600 bytes (100 MB).
  The default values are:
  • If TargetDirectory and TargetHLQ are both not specified: 104857600 (100 MB)
  • If either TargetDirectory or TargetHLQ is specified: 2147483647 bytes (2 GB)

Priority

• string, enumerated
• This specifies the priority of the request:
  • Normal (this is the default)
  • Urgent
  If specified, this option is transferred to the counterpart as a normalized value. The MSIF transfer service does not evaluate or alter the value of this option. For more information, see SWIFTNet Service Design Guide.

RelativeExpiration

• duration
• This option specifies the amount of time that is available for the corresponding DownloadFile scenario. The scenario must reach the Complete state before the end of the expiration period. If the scenario exceeds its expiration period, the MSIF transfer service issues an error event and issues a response to the originating application. If this option is not specified, there is no limit to the amount of time available for the scenario.
  The value must have the form:

  PdDThHmM

  where:

  d

  The number of days

  h

  The number of hours (0 - 23)

  m

  The number of minutes (0 - 59)

  For example, if the scenario is to complete within 7 hours and 12 minutes after processing of the DownloadFile request begins, specify:

  P0DT7H12M

ProductInfoOptionSet

• string, 1…30 characters
• This is the name of the product information option-set CO that is to be used to send information about the application that downloads a file for download (see Product information options: ProductInfoOptions).

DeliveryMode

• string, enumerated
• This option specifies how a file that was downloaded from a counterpart is delivered to a business application. It can be specified whether a file is copied or moved from an internal MSIF data directory to the specified target directory. The value Move is faster, especially for large files, because no data must be copied. This option is only valid if the MSIF and target directories use the file system. It is only applied if the target file is a HFS file and no data set.

  Copy

  A file is copied into the target directory. This is the default.

  Move

  If the file is a HFS file then it is moved into the target directory, otherwise it is copied.

The signature options are:

DigestRefx

• string, 1…128 characters
• A reference that describes the data that was used or is to be used to calculate a digest value. Each digest reference is of one of the following types:

  SNL-processable

  If a digest reference begins with Sw., it is said to be SNL-processable, and identifies the elements in the SNL primitive that the SAG is to use to calculate the corresponding digest value. The request cannot specify a corresponding digest value.

  Non-SNL-processable

  If a digest reference does not begin with Sw., it is said to be non-SNL-processable, and refers to the data that was used to calculate the corresponding digest value specified in the request. A request that specifies a non-SNL-processable digest reference must specify a corresponding digest value.

DigestAlgorithmx

• string, 1…20 characters
• The algorithm that was used or is to be used to calculate the digest. A digest algorithm (DigestAlgorithmx option) can be specified only if the corresponding digest reference (DigestRefx option) is also specified. The default is SHA-256. If an SNL-processable digest reference is used, the digest algorithm must be SHA-256.

DigestValuex

• string, 1…50 characters
• The value, encoded in base64, of the digest that was calculated based on the data referred to by the corresponding digest reference. A digest value can be specified only for a non-SNL-processable digest reference. It can be specified only in a request; it cannot be specified by means of a signature option-set CO. If a request specifies a digest value, a corresponding non-SNL-processable digest reference must also be specified, either in the request or by means of a signature option set.

The product information options are:

VendorNamex

• string, 1…8 characters
• The name of the vendor who is responsible for the software product that processed the message. If ProductNamex is specified, this option is mandatory.

ProductNamex

• string, 1…8 characters
• The name of the software product that processed the message. If VendorNamex is specified, this option is mandatory.

ProductVersionx

• string, 1…8 characters
• The version of the software product that processed the message. Specify this option only if the VendorNamex and ProductNamex options are also specified.

Each SendMsg or SendFile request specifies, by means of its Service transfer option, the service that is to be used for the corresponding message or file transfer. If this service uses the SnF delivery mode and if it is to use the SWIFTNet Copy feature, its ASP might require that the request specify the third party or third parties to which information is to be routed. If so, use the third-party options to specify the distinguished names (DNs) of these third parties:

• When a Y-copy service is used, at most one third party DN can be specified.
• When a T-copy service is used, up to 10 third party DNs can be specified.

The DNs specified by means of third-party options must be among the candidates listed in the ASP.

The file options specify information about a file that is to be transferred to or from a counterpart:

AppCodepage

• string, 1…40 characters
• This is the name of the code page in which the contents of a file, data set or MQ message that is passed between an application and the MSIF transfer service is encoded. This option can be specified only if NetworkCodepage is also specified. The value must be the name of a code page supported by your Java™ virtual machine. To obtain a list of these code page names, run the dniclcs.sh shell script, which is described in Listing character set names. If this option is not specified, no code page conversion is performed when data is passed between an application and the MSIF transfer service.

NetworkCodepage

• string, 1…40 characters
• This is the name of the code page in which the contents of a file that is passed between the MSIF transfer service and the SIPN is encoded. This option can be specified only if AppCodepage is also specified. The value must be the name of a code page supported by your Java virtual machine. To obtain a list of these code page names, run the dniclcs.sh shell script, which is described in Listing character set names. If this option is not specified, no code page conversion is performed when data is passed between the MSIF transfer service and the SIPN.

Compression

• string, enumerated
• This is the method used to compress a file to be sent, or to decompress a file that was received:

  None

  The file is not compressed or decompressed. This is the default.

  Zip

  The file to be compressed or decompressed employs the Zip file format:

  • A file that is to be sent is compressed using the Deflate algorithm as implemented by the IBM Java virtual machine, and is converted into a Zip archive that contains exactly one file.
  • A file that was received is a Zip archive that contains exactly one file and was compressed using the Deflate algorithm.

  For a SendFile or ProvideFileForDownload request, you can also specify the EntryNameInContainer and CompressionLevel options.

  Gzip

  The file to be compressed or decompressed employs the Gzip file format. For a SendFile or ProvideFileForDownload request, you can also specify the CompressionLevel option.

  For a received file, the specified method must match the method that was used by the sender to compress the file. If the specified compression method does not match to the compression of the file, then the error events DNFO1230E and DNFO3600E are issued and the file transfer is aborted. In this case cancel the file transfer, specify the correct compression method, and ask the sender to resend the file.

CompressionLevel

• string, enumerated
• This specifies the level of compression to be used by the compression algorithm specified by the Compression option:

  DefaultCompression

  The default compression level. This is the default.

  BestCompression

  The compression level for maximum size reduction.

  BestSpeed

  The compression level for fastest compression.

  This option applies only to SendFile and to ProvideFileForDownload requests, and only for requests for which the Compression option must be set to either Zip or Gzip.

EntryNameInContainer

• string, 1…1023 characters (in message) or 254 characters (in option-set CO)
• This is the name of the compressed file within a Zip archive. It is valid only if the Compression option was set to Zip. You can specify any file name without its directory information. If no value is specified, the following applies:
  • If the source file is an HFS file, the name of the compressed file is the HFS file name.
  • If the source file is a data set, the name of the compressed file is the data set name.
  • If the source file is contained in the body of a SendFile, ProvideFileForDownload, or DownloadFile request, the name of the compressed file is specified by the Response.Reference field of that request.

FileDescription

• string, 0…256 characters (in message) or 254 characters (in option-set CO)
• This is a textual description of the file to be processed and is not intended for automatic processing. The MSIF transfer service does not evaluate or alter the value of this option.

FileInfo

• string, 0…256 characters (in message) or 254 characters (in option-set CO)
• This is structured information, in Backus-Naur form, about the file to be processed. For more information, see SWIFTNet Link: Interface Specification.
  For files that are to be sent to a counterpart, the MSIF transfer service checks this option to determine how to handle file compression:

  • If the file transfer request specifies the Compression option:
    • If the FileInfo option contains a SwCompression= tag, it must be at the first position in the String, and its value must match the value specified for the Compression option; otherwise, the request is rejected.
    • If the FileInfo option does not contain a SwCompression= tag, one is added at the first position in the String, and its value is set to the value of the Compression option.
  • If the file transfer request does not specify the Compression option:
    • If the FileInfo option contains a SwCompression= tag, it must be at the first position in the String. Its value is ignored.
    • If SwCompression= tag is missing, the MSIF transfer service adds this tag to the first position in the String and sets value to none.

HeaderInfo

• XML subtree, 0…51200 characters (in message) or 254 characters (in option-set CO)
• This is structured information written in XML, for example:

  <ApplSpcfc xmlns="urn:swift:xsd:ApplSpcfc.TxsCntr.01">
  <TxsCntr>
  <TtlNbOfTxs>335</TtlNbOfTxs>
  </TxsCntr>
  </ApplSpcfc>

  It corresponds to the Sw:Headerinfo field of a primitive. Subfolders, fields, and their possible values are defined by SWIFT. For more information, see SWIFTNet FileAct: Using the Enhanced Header.

The SAG message partner options specify:

• For a SendMsg, SendFile, or DownloadFile scenario, information about the SAG message partner and endpoints involved in the transfer
• For a ProvideFileForDownload scenario, the SAG that is to handle download requests
• For an input-channel, output-channel, or SnF queue, information about the SAG message partner and endpoints that its sessions are to use
• The authoriser DN that is to be used for the response or delivery notification
• The local authentication (LAU) key name that is to be used to authenticate messages that are transferred between the MSIF transfer services and an SAG

They are:

Group

• string, 1…30 characters
• This is the name of the SAG MP option-set group to which this SAG MP option set belongs, if any. All SAG MP option sets with the same value for this option belong to the same group. If no value is specified for this option, the SAG MP option set is not a member of any group.
  Notes:

  1. Each SAG MP option set specifies the SNL ID of an SAG. The SAGs specified by the members of an SAG MP option-set group must all have the same SWIFTNet release level. The SWIFTNet release level is specified by the SWIFTNetVersion SAG communication option (see SAG communication options: SagCommOptions).
  2. This option is ignored for the default SAG MP option set (that is, the CO of type DnfEfaSagMPOptionSet with the name default).

SnlId

• string, 1…8 characters
• This specifies, in lowercase characters, the ID of the SNL that is to be used for the transfer. This SNL ID is identical to the name of the SAG communication option-set CO that is to be used (see SAG communication options: SagCommOptions).

MP

• string, 1…20 characters
• This specifies the message partner that is to send a request or response.

SnlEP

• string, 1…15 characters
• This specifies the name of the SNL endpoint to which messages are to be routed if they are received via an SnF session that was acquired for an SnF queue using that SagMPOptionSet.

AuthoriserDN

• string, 1…100 characters
• This distinguished name (DN) is used to:
  • Authorize a request message for a SendMsg scenario as described in Table 1
  • Authorize the response to a request message that was received during a MsgReceived scenario
  • Authorize or sign (or both) a request message as described in Table 2 (for a SendFile scenario) or Table 3 (for a DownloadFile scenario)
  • Authorize the response to a request message that was received during a FileReceived or RespondDownload scenario
  • Authorize a delivery notification that was created for a FileReceived or RespondDownload scenario
  • Authorize the messages (including delivery notifications) and files received from an SnF queue after an output channel to that queue is opened or after the queue is acquired
  • Authorize the sending of responses to delivery notifications
  There must be a corresponding certificate for this DN on the SAG specified by the SAG MP option set. This DN must belong to the same organization (that is, it must have the same values for its first two levels) as the LocalDN specified in the transfer option-set CO that is used.

SignerDN

• string, 1…100 characters
• This distinguished name (DN) is used to:
  • Sign a message transfer for a SendMsg scenario as described in Table 1
  • Encrypt a file transfer as described in Table 2 (for a SendFile scenario) or Table 3 (for a DownloadFile scenario)

EncryptDN

• string, 1…100 characters
• This distinguished name (DN) is used to encrypt a message transfer for a SendMsg scenario as described in Table 1.

NotifSnFQueue

• string, 1…30 characters
• This specifies the name of the store-and-forward (SnF) queue in which the MSIF transfer service expects to find the delivery notification that results from a SendMsg or SendFile request in which the DeliveryMode option was set to SnF.

lkn

• string, characters
• The name of the local authentication key. This specifies the name of the configuration object (CO) of type DnfLAUKeyMP that contains the LAU key value.

The following SAG communication options apply to both message transfers and file transfers:

enabled

This pseudo attribute indicates whether the SAG is enabled for use with the MSIF transfer service. To prepare an SAG communication option-set CO but keep it inactive until it is ready to be used, configure all its attributes except this one. If this attribute is not configured, any attempt by the MSIF transfer service to use the SAG is rejected. If this attribute is configured and then removed, scenarios that are in progress and that already use the SAG are allowed to run to completion, but any attempt to initiate a new scenario that uses the SAG, or to switch to the SAG as a result of SAG MP option set switching, is rejected.

SagRequestQueue

• string, 1…48 characters
• This is the name of the specific client request queue of the SAG, that is, the queue from which the SAG is to retrieve requests.

SagQueueManager

• string, 1…48 characters
• This is the name of the queue manager used by the SAG. The default is the queue manager of the message broker on which the MSIF transfer service runs.

SWIFTNetVersion

• string, 2 characters
• This option indicates the SWIFTNet release level that is to be used for a transfer.

  70

  SWIFTNet Release 7

MaxAutoRecoverCount

• int, 0…100
• This option specifies:
  • The default for the following recovery options (see Recovery options: RecoveryOptions):
    • MsgSndMaxRecoverCount
    • FileSndMaxRecoverCount
    • FileRcvMaxRecoverCount
    • NotifSndMaxRecoverCount
    • NotifRcvMaxRecoverCount
  • The maximum number of times that the MSIF transfer service is to automatically attempt to recover a DownloadFile scenario that encountered a recoverable error while sending a delivery notification
  A value of 0 indicates that no automatic recovery attempt is to be made if the initial attempt fails. This is the default.

AutoRecoverInterval

• int, 0…3600
• If automatic recovery is to be used (that is, if the automatic recovery count is greater than 0), and if a DownloadFile scenario encounters a recoverable error while sending a delivery notification, this option specifies the number of seconds that the MSIF transfer service is to wait before attempting to automatically recover the scenario. This option also specifies the default for the following recovery options (see Recovery options: RecoveryOptions):
  • FileSndRecoverInterval
  • FileRcvRecoverInterval
  • MsgSndRecoverInterval
  • NotifSndRecoverInterval
  • NotifRcvRecoverInterval
  The default is 120.
  Note: Because the MSIF transfer service checks for errors only every 180 seconds, the interval between the error occurring and the automatic recovery attempt can be up to 180 seconds longer that the specified value.

TimeToRecover

• duration
• This option specifies the amount of time available to the MSIF transfer service to reprocess an SnF MsgReceived or FileReceived scenario for which processing was interrupted due to a recoverable error. If the scenario is not reprocessed within this amount of time, the MSIF transfer service changes the transfer condition of the scenario from running to finished and issues an error event. Table 4 shows the transfer state of the scenario before and after reprocessing begins.

  Table 4. Transfer states of recoverable SnF MsgReceived or FileReceived scenarios

  Scenario type	Transfer state
  	Before reprocessing begins	After reprocessing begins
  MsgReceived	Error	Initial
  FileReceived	Error	Responded
  	Failed	Accepted

  The MSIF transfer service begins reprocessing such a scenario when it receives a request primitive that contains a PDMHistory indicator. This can happen when:

  • The original session was interrupted before transfer could be completed. This applies to both MsgReceived and FileReceived scenarios.
  • The original session was interrupted before the acknowledgment (ACK) for it could be sent. This applies only to FileReceived scenarios.
  • A protocol error occurred, for example, an error due to an invalid response primitive. This applies to both MsgReceived and FileReceived scenarios.
  Table 5 lists the situations for which a PDM can be received, and the actions that the MSIF transfer service takes in response.

  Table 5. Situations for which a PDM can be received

  Situation	Scenario
  	MsgReceived	FileReceived
  PDM for an unrecognized request primitive	The MSIF transfer service changes the transfer status of the scenario to Accepted. When the scenario completes, it delivers a MsgReceived notification to the receiving application.	The MSIF transfer service changes the transfer status of the scenario to Accepted. When the scenario completes, it delivers a FileReceived notification to the receiving application.
  PDM for a request primitive for which the previous transfer attempt failed
  PDM for a request primitive for which the previous transfer attempt succeeded	The MSIF transfer service responds to the SIPN and flags the transfer as a duplicate. It does not deliver a second MsgReceived notification to the receiving application.	The MSIF transfer service responds to the SIPN and flags the transfer as a duplicate. It does not deliver a second FileReceived notification to the receiving application.
  PDM for a request primitive for which the time to recover has expired	The MSIF transfer service sends a server error indication to the SIPN via the SAG.	The MSIF transfer service sends a server error indication to the SIPN via the SAG.

  The value of the TimeToRecover option must have the form:

  PdDThHmM

  where:

  d

  The number of days.

  h

  The number of hours (0 - 23).

  m

  The number of minutes (0 - 59).

  For example, if a MsgReceived request is to be processed within 7 hours and 12 minutes, specify:

  P0DT7H12M

  The default is P1DT0H0M (one day).

RTRecoveryOptionSet

• The name of a CO of type DnfEfaRecoveryOptionSet that specifies the recovery options that are to be used for real-time transfers (see Recovery options: RecoveryOptions).

SnFRecoveryOptionSet

• The name of a CO of type DnfEfaRecoveryOptionSet that specifies the recovery options that are to be used for SnF transfers (see Recovery options: RecoveryOptions).

EventMP

• string, one of two formats:

  SAG message partner name, 1...20 characters

  An SAG message partner name only.

  For example:

  FT_SRVEVT

  list of MSIF transfer service names and the corresponding SAG message partner name, 1...122 characters

  A comma separated list of MSIF transfer service names and the corresponding SAG message partner name to be used by this service. White spaces are not allowed. Each entry is of the form:

  service_name=message_partner

  where:

  service_name

  The name of the MSIF transfer service. An MSIF transfer service name can be specified only once. Possible values are:

  • DNF_O_FT
  • DNF_O_FT1
  • DNF_O_FT2
  • DNF_O_FT3

  message_partner

  The name of the SAG message partner, each name can be specified only once, 1...20 characters.

  For example:

  DNF_O_FT=FT_SRVEVT,DNF_O_FT1=FT1SRVEVT

• This specifies one or more SAG message partners that are to receive events associated with file transfers or InterAct SnF traffic. These message partners must be configured so that messages do not expire. They are not used to receive SAG requests and responses: those are received by the message partner specified by the MP option of the SAG MP option.
• If only the name of one SAG message partner name is specified, the MSIF transfer service DNF_O_FT uses this SAG message partner to subscribe for SNL events. Only DNF_O_FT can process file transfers.
• If a list of services and SAG message partner names is specified, the MSIF transfer services listed subscribe to receive SNL events via the corresponding SAG message partners. Only the listed MSIF transfer services can process file transfers.
• To support local authentication for events that are received from an SAG, create in DNFSYSOU for each message partner a configuration object (CO) of type DnfEfaSagMPOptionSet where the name of the LAU key is specified.

The following SAG communication options apply to file transfers only:

TransferEP

• string, 1…30 characters
• If a remote file handler (RFH) is used, this specifies the SAG endpoint assigned to that RFH.

SagDirectory

• string, 1…254 characters
• This is the directory used by the SAG or RFH workstation that contains the SAG subdirectory (SagSubDirectory). The SAG subdirectory contains files to be transferred.
  Notes:

  1. The sum of the lengths of the name of the SAG directory (SagDirectory) and SAG subdirectory (SagSubDirectory) must not exceed 204 characters.
  2. If LFT is used (that is, if CommType is set to MQHA), this directory must correspond to the setting of the MQHA FileDirectory parameter.
  3. If the SAG MP option set is a member of a group, and if the group is to be used for SendFile scenarios, the SAG directory (SagDirectory) and SAG subdirectory (SagSubDirectory) must be identical for all of the COs in the group. This assures that the fully qualified name of the file is the same for all of the SAGs that might be called upon to send it.

SagSubDirectory

• string, 1…254 characters
• This is the subdirectory of the SAG directory that contains files to be transferred:
  • If LFT is used (that is, if CommType is set to MQHA), this is a physical directory on the SAG workstation.
  • If NFS is used (that is, if CommType is set to LOCAL), this is the name of the logical directory that resulted when the transfer directory was mounted from the SAG or RFH workstation.
  For files to be sent, this subdirectory corresponds to the transfer directory specified in this CO. Files that are received are stored in this subdirectory before being moved to the host system.
  Notes:

  1. The sum of the lengths of the name of the SAG directory (SagDirectory) and SAG subdirectory (SagSubDirectory) must not exceed 204 characters.
  2. Do not specify a leading slash or backslash for this subdirectory.
  3. If an SAG MP option set is a member of a group, and if the group is to be used for SendFile scenarios, the SAG directory (SagDirectory) and SAG subdirectory (SagSubDirectory) must be identical for all of the COs in the group. This assures that the fully qualified name of the file is the same for all of the SAGs that might be called upon to send it.

TransferDirectory

• string, 1…254 characters
• The directory on the host that contains files to be transferred. This directory:
  • Is a subdirectory of the MSIF data directory, which is specified by the EfaDataDirectory attribute of the DnfEfaParameters CO (see Setting global parameters and mapping message partners)
  • Corresponds to the SAG subdirectory specified by the SagSubDirectory option of this SAG communications option-set CO
  Note: If an SAG MP option set is a member of a group, and if the group is to be used for SendFile scenarios, the transfer directories must be identical for all of the SAGs used by the group. This assures that the file is available to all of the SAGs that might be called upon to send it.

CommType

• string, enumerated
• This specifies how files are passed between the SAG or RFH and the host system:

  LOCAL

  The file is stored in an NFS directory that is shared by both the SAG or RFH and the host. This is the default.

  MQHA

  The file data is exchanged between the host and the SAG by means of IBM MQ messages (local file transfer, or LFT).

LftPutFileQueue

• string, 0…48 characters
• This specifies the name of the queue used to transfer files from the host to the SAG when the CommType option is set to MQHA. The queue manager of this queue is the queue manager specified by the SagQueueManager option. If the CommType option is set to LOCAL, this option is ignored.

LftGetFileQueue

• string, 0…48 characters
• This specifies the name of the queue used to transfer files from the SAG to the host when the CommType option is set to MQHA. The queue manager of this queue is the queue manager specified by the SagQueueManager option. If the CommType option is set to LOCAL, this option is ignored.

LftTimeOut

• int, 1…n
• This is a positive integer that specifies:
  • The number of seconds that a local file transfer (LFT) message containing a file remains in the LftPutFileQueue or LftGetFileQueue before it expires
  • The number of seconds that an LFT request remains in the SagRequestQueue before it expires
  • If the LftMaxRetryCount option is set to 2 or more, the number of seconds the MSIF transfer service waits between attempts to copy a file to the SAG or retrieve a file from the SAG
  The default is 90.

LftMaxRetryCount

• int, 1…1276
• If the CommType option is set to MQHA, the LftMaxRetryCount option specifies the maximum number of times that the MSIF transfer service is to issue an LFT PUT command (to copy a file to the SAG) or an LFT GET command (to retrieve a file from the SAG) if a recoverable error occurs. For example, setting this option to 1 causes only one initial attempt and no subsequent retry attempts to be made. The default is 2 (one initial attempt and, if needed, one retry).

  If the MSIF transfer service and the SAG use different queue managers, it can happen that the SAG attempts to process an LFT PUT command or to respond to an LFT GET command before the corresponding file data is in position. The larger the file, the more pronounced this effect. To ensure that such commands can be successfully processed, increase the value of the LftMaxRetryCount option. This increases the amount of time available to process the command.

LftChunking

If CommType=MQHA, this pseudo attribute determines whether files are to be divided into chunks before being passed between the MSIF transfer service and the SAG. This allows files that are larger than 104857600 bytes (100 MB) to be passed. If the LftChunking attribute is not set, attempts to transfer such files are rejected. The size of the chunks is determined by the LftChunkSize option.

LftChunkSize

• int, 1…100
• If CommType=MQHA and the LftChunking option was set, this specifies the size, in MB, of the chunks into which a file is divided before it is passed to or from the SAG by means of LFT. The LFT chunk size must be less than or equal to the value of both the following parameters:
  • The maximum LFT message size, which is set by the SAG configuration parameter MaxLFTMessageSize
  • The maximum message length of the MQ channel, which is set by the IBM MQ parameter MAXMSGL
  The default value is 4.

MaxFileSize

• int, 0…2147483648
• This is the maximum size, in bytes, that a file to be sent, provided for downloading, received, or downloaded can have:
  • For a SendFile or ProvideFileForDownload scenario, an attempt to send or provide for downloading a file that, after compression, exceeds this size is rejected.
  • For a FileReceived or DownloadFile scenario, this option complements the MaxFileSize receive or download option. An attempt to receive or download a file the size of which, before decompression, exceeds the smaller of these two MaxFileSize values is rejected.
  Note: Restrictions imposed by applications and other system components might affect the value you specify for this option, for example:

  • If an SAG 70 is to pass a file to or from the MSIF transfer service, the size of the file after compression or before decompression must be less than 262144000 bytes (250 MB).
  • If the SAG is to pass a file to or from the MSIF transfer service by means of IBM MQ messages, and if such files are not to be divided into chunks (see the description of the LftChunking option in SAG communication options: SagCommOptions), the size of the file after compression or before decompression must be less than 104857600 bytes (100 MB).
  • If the MSIF transfer service is to pass a file to or from an application by means of IBM MQ messages, the size of the file after decompression or before compression must be less than 104857600 bytes (100 MB).
  The default values are:
  • If CommType=MQHA and file chunking is not used (that is, LftChunking is not specified), the default is 104857600 (100 MB).
  • If CommType=LOCAL, or if CommType=MQHA and file chunking is used (that is, LftChunking is specified), the default is 2147483647 bytes (2 GB).

FileWindowSize

• int, 0…n
• The size of the file transfer window. This window limits the maximum number of requests or delivery notifications that are associated with file transfers and for which a response can be outstanding at any one time. If this limit is reached, the MSIF transfer service buffers new requests and delivery notifications until the number for which a response is outstanding drops back below the window size, at which time it passes the buffered requests and delivery notifications to the SAG. If this option is set to 0, the window size is unlimited and no requests or delivery notifications are buffered. This is the default. The recommended window size is five times the number of FileAct client processes on the SAG. The transfer window is described in Flow control for file transfers.

Recovery options determine which settings apply in the following situations:

• A SendMsg scenario encounters a recoverable error while sending a message.
• A SendFile scenario encounters a recoverable error while sending a file.
• A FileReceived scenario encounters a recoverable error while receiving a file, or encounters a recoverable error while sending a delivery notification.
• A NotifReceived scenario encounters a recoverable error while receiving a delivery notification for a file transfer.

For more information about recoverable errors, see Automatic recovery.

There are two types of recovery option:

MaxRecoverCount options

A MaxRecoverCount option specifies the maximum number of times that the MSIF transfer service is to automatically attempt to recover a scenario when it encounter a recoverable error:

MsgSndMaxRecoverCount

For a SendMsg scenario that encounters a recoverable error while sending a message.

FileSndMaxRecoverCount

For a SendFile scenario that encounters a recoverable error while sending a file.

FileRcvMaxRecoverCount

For a FileReceived scenario that encounters a recoverable error while receiving a file.

NotifSndMaxRecoverCount

For a FileReceived scenario that encounters a recoverable error while sending a delivery notification.

NotifRcvMaxRecoverCount

For a NotifReceived scenario that encounters a recoverable error while receiving a delivery notification for a file transfer.

For each MaxRecoverCount option, the default is the value of the MaxAutoRecoverCount option, which is specified by the SAG communications option set (see SAG communication options: SagCommOptions).

RecoverInterval options

If the value of a MaxRecoverCount option is greater than 0, the corresponding RecoverInterval option specifies the number of seconds that the MSIF transfer service is to wait before attempting to automatically recover the scenario:

MsgSndRecoverInterval

For a SendMsg scenario that encounters a recoverable error while sending a message. For SendMsg scenarios that use the SnF delivery mode and an input channel, this applies only to the second and later recovery attempts; the first recovery attempt is made immediately.

FileSndRecoverInterval

For a SendFile scenario that encounters a recoverable error while sending a file.

FileRcvRecoverInterval

For a FileReceived scenario that encounters a recoverable error while receiving a file.

NotifSndRecoverInterval

For a FileReceived scenario that encounters a recoverable error while sending a delivery notification.

NotifRcvRecoverInterval

For a NotifReceived scenario that encounters a recoverable error while receiving a delivery notification for a file transfer.

For each RecoverInterval option except FileRcvRecoverInterval for SnF transfers, the default is the value of the AutoRecoverInterval option, which is specified by the SAG communications option set (see SAG communication options: SagCommOptions). For FileRcvRecoverInterval for SnF transfers, the default is the value of the SNLRequestExpiration global parameter (see Setting global parameters and mapping message partners).

For a particular scenario, which recovery options are used is determined by one of the following SAG communication options:

RTRecoveryOptionSet

For scenarios that use real-time delivery mode.

SnFRecoveryOptionSet

For scenarios that use SnF delivery mode.

Each of these SAG communication options (they are described in SAG communication options: SagCommOptions) specifies the name of a CO of type DnfEfaRecoveryOptionSet. The options specified by this CO are the recovery options that are used for scenarios that use the corresponding delivery mode.

Before you can create or open an input channel, you must first configure it. This applies also for a default input channel.

The name of the input channel CO is identical to the name of the input channel. An input channel name is up to 30 characters long and can have one of the following forms:

• bic8_name
• bic8_name!p

where:

bic8

The BIC8, which must comprise only lowercase letters and numbers.

name

Either the string generic, or the name that was (or will be) specified when the channel was (or will be) created. This name must comprise only lowercase letters, numbers, or the following characters:

!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ 

If the name is followed by the suffix !p, the channel is a pilot channel in the live network. If no suffix is specified, the channel is a regular channel in the live network.

A CO of type DnfEfaInputChannel can be used to set the following attributes for an input channel:

SagMPOptionSet or SagMPOptionSetGroup

Opening and using an SnF input channel requires message partner options. These options are specified by an SAG MP option set, and are described in SAG message partner options: SagMPOptions. All transfers that use this channel use the SAG message partner options specified by this option set.

• If a channel is always to use a particular set of SAG MP options, specify the name of the corresponding SAG MP option set CO as the value of the SagMPOptionSet attribute.
• If a channel is to be able to use several SAG MP option sets and automatically switch in case of errors, specify the name of the SAG MP option-set group that is to be used as the value of the SagMPOptionSetGroup attribute. For more information about SAG MP option-set groups, see Option-set groups.

If both an SagMPOptionSetGroup and SagMPOptionSet option are specified, the SagMPOptionSetGroup option is used and the SagMPOptionSet option is ignored.

WindowSize

An integer from 1 to 100 that specifies the channel window size proposed by the MSIF transfer service when the input channel is opened. The default value is 12.

Before you can create or open an output channel, you must first configure it. This applies also for a default output channel.

The name of the output channel CO is identical to the name of the output channel. An output channel name is up to 30 characters long and can have one of the following forms:

• bic8_name
• bic8_name!p

where:

bic8

The BIC8, which must comprise only lowercase letters and numbers.

name

Either the string generic, or the name that was (or will be) specified when the channel was (or will be) created. This name must comprise only lowercase letters, numbers, or the following characters:

!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~

If the name is followed by the suffix !p, the channel is a pilot channel in the live network. If no suffix is specified, the channel is a regular channel in the live network.

A CO of type DnfEfaOutputChannel can be used to set the following attributes for an output channel:

SagMPOptionSet

Opening and using an SnF output channel requires message partner options. These options are specified by an SAG MP option set CO (see SAG message partner options: SagMPOptions). All transfers that are conducted via the output-channel session that is established when the output channel is opened use the SAG message partner options specified by this CO.

When using an output channel, the SNL ID specified by the SAG MP option set that is used must correspond to an SAG at release level 7.0 or higher.

WindowSize

An integer from 1 to 100 that specifies the channel window size proposed by the MSIF transfer service when the output channel is opened. The default value is 10.

DefaultDeliverySubsetList

A list of one or more delivery subsets, separated from each other by a comma (,). The listed delivery subsets determine which of the primitives on the SnF queue to which the output channel is connected are to be received via the output channel, and in what order. The default is that all types of primitives are received in "first in, first out" order, that is, in the same order in which they were added to the queue. A list of delivery subsets must conform to the following rules:

Rule 1

A list of delivery subsets can contain only the following values, each separated from its neighbors (if any) by a comma (,):

Value	Description
FileAct	FileAct primitives, regardless of their priority (Urgent or Normal)
InterAct	InterAct primitives, regardless of their priority (Urgent or Normal)
System	System messages, regardless of their priority (Urgent or Normal)
Normal	Messages with normal priority, regardless of whether they are FileAct, InterAct, or System messages
Urgent	Messages with urgent priority, regardless of whether they are FileAct, InterAct, or System messages
FileAct_Normal	FileAct primitives with normal priority
FileAct_Urgent	FileAct primitives with urgent priority
InterAct_Normal	InterAct primitives with normal priority
InterAct_Urgent	InterAct primitives with urgent priority
System_Normal	System messages with normal priority
System_Urgent	System messages with urgent priority

Rule 2

A list cannot contain more than six subsets.

Rule 3

A list cannot specify the same subset more than once. For example, the following subset list is not valid:

System,InterAct_Urgent,FileAct_Urgent,InterAct_Urgent

Rule 4

A list cannot specify a subset that specifies both a priority and a service after a subset that specifies a service only. For example, the following subset list is not valid:

InterAct,InterAct_Normal

Rule 5

A list cannot specify a subset that specifies both a priority and a service after a subset that specifies a priority only. For example, the following subset list is not valid:

Urgent,InterAct_Urgent

Rule 6

A list cannot specify all three subsets for a particular service. For example, the following subset list is not valid:

InterAct_Urgent,InterAct_Normal,InterAct

SnFQueueName

If more than one output channel is to connect to a particular SnF queue, use this attribute to specify the name of the SnF queue to which this output channel is to connect. Specify this attribute only if the name of the output channel is different from the name of the SnF queue to which it is to connect.

The name of the SnF queue CO is the name of the SnF queue as it is known to the SIPN. An SnF queue name is up to 30 characters long and can have one of the following forms:

• bic8_name
• bic8_name!p

where:

bic8

The BIC8, which must comprise only lowercase letters and numbers.

name

A name determined by the service provider, for example:

• For the SWIFT service swift.fin, this name is fin.
• For the SWIFTNet service swift.rma, this name is rma.

This name can contain up to 12 alphanumeric characters.

If the name is followed by the suffix !p, the queue is a pilot queue in the live network. If no suffix is specified, the queue is a regular queue in the live network.

For example:

xxxxusny_rma

The SnF queue in the Live network that the destination XXXXUSNY uses to exchange relationships with other destinations.

xxxxusny_rma!p

The pilot SnF queue in the Live network that the destination XXXXUSNY uses to exchange relationships with other destinations.

A CO of type DnfEfaSnFQueue can be used to set the following attributes for an SnF queue:

SagMPOptionSet

The SAG MP option-set CO that specifies the message partner options that are to be used by the queue session that is established when the SnF queue is acquired. All transfers that are conducted via the queue session use the SAG message partner options specified by this CO (see SAG message partner options: SagMPOptions).

OrderBy

The default of the -order parameter of the acquire command when that command is issued for this queue:

fifo

The messages are retrieved from the queue in "first in, first out" (FIFO) order, that is, in the same order in which they were added to the queue. This is the default.

urgent

Messages with urgent priority are retrieved from the queue in FIFO order. Only after all urgent messages were processed are messages with normal priority retrieved from the queue, also in FIFO order.

fileact

FileAct messages are retrieved from the queue in FIFO order. Only after all FileAct messages were processed are InterAct messages retrieved from the queue, also in FIFO order.

interact

InterAct messages are retrieved from the queue in FIFO order. Only after all InterAct messages were processed are FileAct messages retrieved from the queue, also in FIFO order.

RecoveryMode

The default (true or false) of the -rm parameter of the acquire command when that command is issued for this queue. If true, the session is opened in recovery mode. In recovery mode, messages that already have an output sequence number are sent first, regardless of the selected ordering.

Each request processed by the MSIF transfer service specifies the name of the SWIFT service that is to be used. Before a SWIFT service can be used, you must configure a CO of type DnfEfaSWIFTService for it. The name of this CO must be identical to the name of the service, for example:

swift.generic.fa

Replace the following items in the copy of the script as required:

TrialBehavior

This attribute specifies how the MSIF transfer service is to behave when it encounters, during the trial stage of RMA deployment for the SWIFT service, a request that is not authorized, that is, for which there is not a corresponding authorisation in the RM data store. Such a request would not be sent or received during the mandatory usage stage. Possible values are:

Pass

The MSIF transfer service is to continue processing the scenario. This is the default.

Block

The MSIF transfer service is to reject the request.

DnfFlagMwh

This attribute specifies whether message warehouse data is to be recorded for the SWIFT service. Its setting (Yes or No) overrides the setting of the DnfFlagMwh attribute of a CO of type DnfEfaOptionsMwh, as described in Recording data in the message warehouse. There is no default; if this attribute is not set, the setting of the DnfFlagMwh attribute of a CO of type DnfEfaOptionsMwh determines whether message warehouse data is recorded.

The source options can be specified only in a request, not by means of an option-set CO. They specify the name of the source file, that is, the file to be sent or provided for downloading:

DatasetName

• string, 1…44 characters
• Fully qualified name of the data set to be sent or provided for downloading.

FileName

• string, 1…1023 characters
• The fully qualified name of a UNIX file to be sent or provided for downloading.

The payload of an InterAct primitive that contains a business message might contain an application header. An application header provides information that is used by the applications that are to route and process the business message, and can be of either of the following types:

• ISO 20022 business application header
• InterAct application header

The application header (AppHdr) elements of an MSIF request, response, or notification specify the contents of an application header:

For a SendMsg scenario

The SWIFT service determines which type of application header can or must be used. The MSIF transfer service uses options specified in the AppHdr folder of the request to create an application header of the appropriate type and insert it into the payload of the resulting InterAct primitive (these options can be specified only in a request, not by means of an option set):

To generate an ISO 20022 business application header

Specify the application header as an XML structure within an Hdr folder. The first element of this XML structure must be a second AppHdr folder, and there must be no other elements in the first AppHdr folder besides the Hdr folder and the elements that the Hdr folder contains. For example:

  :
<AppHdr>   [this is the beginning of the first AppHdr folder]
 <Hdr>
  <AppHdr xmlns="urn:iso:std:iso:20022:tech:xsd:head.001.001.01"...>
     [the line above is the beginning of the second AppHdr folder]
   <CharSet>value</CharSet>
   <Fr>value</Fr>
   <To>value</To>
   <BizMsgIdr>value</BizMsgIdr>
   <PssblDplct>true</PssblDplct>
     :
  </AppHdr>  [end of the second AppHdr folder]
 </Hdr>
</AppHdr>      [end of the first AppHdr folder]
  :

To generate an InterAct application header

Specify an InterAct application header in either of the following ways:

• Specify the application header as an XML structure within an Hdr folder. The first element of this XML structure must be a second AppHdr folder, and there must be no elements in the first AppHdr folder except the Hdr folder and the elements that the Hdr folder contains. For example:

    :
  <AppHdr>  [this is the beginning of the first AppHdr folder]
   <Hdr>
    <AppHdr xmlns="urn:swift:xsd:$ahV10">
      [the line above is the beginning of the second AppHdr folder]
     <MsgRef>Ref123</MsgRef>
     <CrDate>2011-08-24T09:00:00</CrDate>
     <From>
      <Type>DN</Type>
      <Id>o=ptsadejj,o=swift</Id>
     </From>
     <To>
      <Type>DN</Type>
      <Id>o=ptsadejj,o=swift</Id>
     </To>
     <Dup>
      <Ref>value</Ref>
      <Info>value</Info>
     </Dup>
    </AppHdr> [end of the second AppHdr folder]
   </Hdr>
  </AppHdr>     [end of the first AppHdr folder]
    :

• Specify one or more of the following elements:
  • From (folder)
  • To (folder)
  • SvcName (field)
  • MsgName (field)
  • MsgRef (field)
  • CrDate (field)
  • Dup (folder)
  These elements are described in Application header options for an InterAct application header.

For a MsgReceived scenario

The MSIF transfer service removes all application headers from the payload of the received InterAct primitive and puts each of them, unaltered and unvalidated, into a separate AppHdr folder in the ReceiveDetails.AppHdr.Hdr folder of a MsgReceived notification (if automatic response mode is used) or MsgReceived request (if flexible response mode is used). For an InterAct application header, it also includes the elements described in Application header options for an InterAct application header. It then passes the notification or request to the receiving application.