FileReceived notification

If the file is provided in the payload of the message, the Format field in the MQRFH2 is set to MQFMT_NONE, and the CodedCharSetId field in the MQRFH2 is to be ignored. This means, the payload cannot be converted with the MQGET of the notification message.

<ComIbmDni>
  :
  <Function>
    <DNF_O_FT>
      :
      <FileReceived>
        <Notification>
            <Reference>value</Reference>
            <ReceiveDetails>
               <LocalDN>value</LocalDN>
               <RemoteDN>value</RemoteDN>
               <Service>value</Service>
               <RequestType>value</RequestType>
               <LogicalFileName>value</LogicalFileName>
               <FileSize>value</FileSize>
               <TransferDescription>value</TransferDescription>
               <TransferInfo>value</TransferInfo>
               <FileDescription>value</FileDescription>
               <FileInfo>value</FileInfo>
               <Priority>value</Priority>
               <E2EMsgId>value</E2EMsgId>
               <RequestRef>value</RequestRef>
               <TransferRef>value</TransferRef>
               <OverdueTime>value</OverdueTime>
               <RequestSignatureList>value</RequestSignatureList>
               <SnFInputTime>value</SnFInputTime>
               <SnFSessionId>value</SnFSessionId>
               <SnFOutputSeq>value</SnFOutputSeq>
               <DeliveryTime>value</DeliveryTime>
               <SwiftTime>value</SwiftTime>
               <HeaderInfo>value</HeaderInfo>
               <SenderInfo>value</SenderInfo>
               <CopyState>value</CopyState>
               <ThirdPartyInfo>value</ThirdPartyInfo>
               <InformCopyList>
                 <InformCopy>
                   <InformCopyName>value</InformCopyName>
                   <InformCopyState>value</InformCopyState>
                   <ThirdPartyInfo>value</ThirdPartyInfo>
                  </InformCopy>
                  :
               </InformCopyList>
               <DistributionInfo>
                 <OrigSnfRef>value</OrigSnfRef>
                 <RecipientList>
                   <RecipientDN>value</RecipientDN>
                   :
                 </RecipientList>
               </DistributionInfo>
               <SnFInfo>value</SnFInfo>
            </ReceiveDetails>
            <RetrievalDetails>
              <Sequence>value</Sequence>
              <Final>value</Final>
              <ReceiveDetails>
                <PDIndication>value</PDIndication>
                <HeaderInfo>value</HeaderInfo>
                <RetrievalSnFRef>value</RetrievalSnFRef>
                <E2EMsgId>value</E2EMsgId>
                <RetrievalUserRef>value</RetrievalUserRef>
                <RequestSignatureList>value</RequestSignatureList>
                <SwiftTime>value</SwiftTime>
                <CopyState>value</CopyState>
                <ThirdPartyInfo>value</ThirdPartyInfo>
                <InformCopyList>
                  <InformCopy>
                    <InformCopyName>value</InformCopyName>
                    <InformCopyState>value</InformCopyState>
                    <ThirdPartyInfo>value</ThirdPartyInfo>
                  </InformCopy>
                  :
                </InformCopyList>
                <DistributionInfo>
                  <OrigSnfRef>value</OrigSnfRef>
                  <RecipientList>
                    <RecipientDN>value</RecipientDN>
                    :
                  </RecipientList>
                </DistributionInfo>
                <SnFInfo>value</SnFInfo>
              </ReceiveDetails>
              <SendDetails>
                <PDIndication>value</PDIndication>
                <HeaderInfo>value</HeaderInfo>
                <RetrievalUserRef>value</RetrievalUserRef>
                <MSIFReference>value</MSIFReference>
                <E2EMsgId>value</E2EMsgId>
                <AuthNotif>value</AuthNotif>
                <Copy>value</Copy>
                <DeliveryMode>value</DeliveryMode>
                <DeliveryNotif>value</DeliveryNotif>
                <OverdueWarningDelay>value</OverdueWarningDelay>
                <OverdueTime>value</OverdueTime>
                <ThirdPartyOptions>
                  <ThirdPartyDN1>value</ThirdPartyDN1>
                  :
                  <ThirdPartyDN10>value</ThirdPartyDN10>
                </ThirdPartyOptions>
              </SendDetails>
            </RetrievalDetails>
            <FileOptions>
               <AppCodepage>value</AppCodepage>
               <NetworkCodepage>value</NetworkCodepage>
               <Compression>value</Compression>
            </FileOptions>
            <TargetOptions>
               <FileName>value</FileName>
               
            </TargetOptions>
            <Completion>
              <Code>value</Code>
              <ReasonList>
                <Reason>
                  <Code>value</Code>
                  <Value>value</Value>
                  <Explanation>value</Explanation>
                  <Parameter1>value</Parameter1>
                  <Parameter2>value</Parameter2>
                  <Parameter3>value</Parameter3>
                  <Parameter4>value</Parameter4>
                  <Parameter5>value</Parameter5>
                  <Parameter6>value</Parameter6>
                  <Parameter7>value</Parameter7>
                  <Parameter8>value</Parameter8>
                  <Parameter9>value</Parameter9>
                  <Parameter10>value</Parameter10>
                </Reason>
              </ReasonList>
              <Explanation>value</Explanation>
            </Completion>
        </Notification>
      </FileReceived>
    </DNF_O_FT>
  </Function>
  :
</ComIbmDni>
Function
  • Rep. 1
  • This folder specifies information for FTM SWIFT services. Contents:
    • DNF_O_FT (folder)
DNF_O_FT in Function
  • Rep. 1
  • This folder specifies information for the MSIF transfer service. Contents:
    • FileReceived (folder)
FileReceived in Function.DNF_O_FT
  • Rep. 1
  • This folder specifies information for a FileReceived scenario. Contents:
    • Notification (folder)
Notification in Function.DNF_O_FT.FileReceived
  • Rep. 1
  • This folder contains the elements of the notification:
    • Reference (field)
    • ReceiveDetails (folder)
    • FileOptions (folder)
    • TargetOptions (folder)
    • Completion (folder)
Reference in Function.DNF_O_FT.FileReceived.Notification
  • bin.hex, 48 chars (hex double byte rep. of MQBYTE24), rep. 1
  • The MSIF reference, which is an ID generated by MSIF transfer service that uniquely identifies a scenario. It is identical to the MQMD.MsgId of the message containing the FileAct request primitive that the SAG passed to the MSIF transfer service.
ReceiveDetails in Function.DNF_O_FT.FileReceived.Notification
  • Rep. 1
  • This folder contains the elements that provide information about the received file:
    • LocalDN (field)
    • RemoteDN (field)
    • Service (field)
    • RequestType (field)
    • LogicalFileName (field)
    • FileSize (field)
    • TransferDescription (field)
    • TransferInfo (field)
    • FileDescription (field)
    • FileInfo (field)
    • Priority (field)
    • E2EMsgId (field)
    • RequestRef (field)
    • TransferRef (field)
    • OverdueTime (field)
    • RequestSignatureList (field)
    • SnFInputTime (field)
    • SnFSessionId (field)
    • SnFOutputSeq (field)
    • DeliveryTime (field)
    • SwiftTime (field)
    • HeaderInfo (folder)
    • SenderInfo (field)
    • CopyState (field)
    • ThirdPartyInfo (field)
    • InformCopyList (folder)
    • DistributionInfo (folder)
    • SnFInfo (folder)
LocalDN in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 1...100 characters, rep. 1
  • Distinguished name to which the FileAct request primitive was addressed.
RemoteDN in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 1...100 characters, rep. 1
  • Distinguished name used by the counterpart that initiated the file transfer.
Service in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 1...30 characters, rep. 1
  • Name of the business service that is used to receive the file. This name is defined by the service administrator and must be approved by SWIFT.
RequestType in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 1...30 characters, rep. 1
  • Request type defined by the service provider.
LogicalFileName in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 1...254 characters, rep. 1
  • The logical name of the received file, that is the file name as transferred over the SIPN. The counterpart provided this name in its SendFile request.
FileSize in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • int, 0...n, rep. 1
  • The size of the received file in bytes after any decompression or conversion.
TransferDescription in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 0...256 characters, rep. 0…1
  • A textual description of the file transfer as specified by the counterpart. It is not intended for automatic processing. The MSIF transfer service does not evaluate or alter the content.
TransferInfo in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 0...256 characters, rep. 0…1
  • Structured information about the file transfer as specified by the counterpart. The MSIF transfer service does not evaluate or alter the content.
    The value of this option is specified according to the Backus-Naur form:
    • A list of entries of the form key=value separated by semicolons.
    • Keys are arbitrary. SWIFT recommends distinct values.
    For more information, see SWIFTNet Link: Interface Specification.
FileDescription in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 0...256 characters, rep. 0…1
  • A textual description of the file as specified by the counterpart.
FileInfo in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 0...10240 characters, rep. 0…1
  • Structured information about the file to be processed. The MSIF transfer service does not evaluate or alter the content.
    The value of this option is specified according to the Backus-Naur form:
    • A list of entries of the form key=value separated by semicolons.
    • Keys are arbitrary. SWIFT recommends distinct values.
    For more information, see SWIFTNet Link: Interface Specification.
Priority in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, enumerated, rep. 0…1
  • Classifies the priority of the transfer as specified by the counterpart. The MSIF transfer service does not evaluate or alter the content.

    Possible values:

    • Normal. This is the default.
    • Urgent
E2EMsgId in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 0...42 characters, rep. 0…1
  • A reference, set by the MSIF transfer service, that uniquely identifies the corresponding FileAct primitive. It is set to the value of the Sw:MsgId field of the Sw:RequestE2EControl block of the FileAct primitive.
    If a received FileAct primitive contains a possible duplicate indication (PDI), the MSIF transfer service sets the fields of the Completion.ReasonList.Reason folder of the corresponding notification to the following values:
    Code
    PartialOk
    Value
    DNFO1210I
    By comparing the E2EMsgId field of such a notification with the E2EMsgId field of all other notifications, an application can determine whether it has already processed a FileAct request that is flagged as being a possible duplicate.
TransferRef in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 1...30 characters, rep. 1
  • A transfer reference, set by the SIPN, that uniquely identifies a FileAct file transfer. An application can use this reference to check for duplicate file transfers by comparing it to the TransferRef of other file transfers. The format is that of the Sw:TransferRef field of the primitive, which is described in SWIFTNet Link: Interface Specification. In case of a Store-and-forward file transfer, the TransferRef is identical to the Sw:SnFRef of the FileAct primitive.
OverdueTime in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • dateTime, rep. 0...1
  • The date and time at which the message is considered to be overdue. The sender specified this value when sending the message. A notification contains this field only if SWIFT sent a non-delivery warning to the sender.
RequestRef in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 30 characters, rep. 0…1
  • The request reference, which is a string that the sender of the original request primitive specified in its SwInt:RequestRef field to uniquely identify the primitive.
RequestSignatureList in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • XML subtree, rep. 0…1
  • This element contains the signature list of the received FileAct request. The signatures in this list are Sw:SignatureList XML structures in the after-sign form. For more information, see SWIFTNet Link: Interface Specification.
SnFInputTime in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 24 characters, rep. 0…1
  • This element is deprecated. Use the element Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo.Sw:SnFInputTime instead.

    For a request that was sent using SnF delivery mode, this field indicates the date and time that the request was stored by SWIFT for subsequent processing.

SnFSessionId in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 1...40 characters, rep. 0...1
  • This element is deprecated. Use the element Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails.SnFInfo. Sw:SnFOutputInfo.Sw:SnFSessionId instead.

    This field specifies the ID of the SnF session in which the file was received.

SnFOutputSeq in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • int, 0...n, rep. 0...1
  • This element is deprecated. Use the element Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails.SnFInfo. Sw:SnFOutputInfo.Sw:SnFOutputSeq instead.

    If the file was received in SnF delivery mode, this field indicates the SnF output sequence number used for the channel transfer. An application can use this number to find out the sequence in which files were received from SWIFT.

DeliveryTime in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 20 characters, rep. 0…1
  • This element is deprecated. Use the element Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo.Sw:DeliveryTime instead.

    For a file that was received in SnF delivery mode, the time when the file was retrieved from the SnF queue by the receiver.

SwiftTime in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 20 characters, rep. 1
  • A timestamp that indicates the SWIFT UTC time of the inbound request primitive. It corresponds to the value of the Sw:SwiftTime field of its Sw:HandleFileRequest folder. This value is generated by the SIPN and has the format:
    yyyy-mm-ddThh:mm:ssZ
    where:
    yyyy
    Year.
    mm
    Month.
    dd
    Day.
    hh
    Hour.
    mm
    Minute.
    ss
    Second.
    For example:
    2016-02-19T08:58:37Z
HeaderInfo in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • XML subtree, 0...51200 characters, rep. 0…1
  • This is structured information, in XML form, about the file to be processed. It corresponds to the SWIFT Sw:HeaderInfo structure excluding the Sw:HeaderInfo tag. Sub folders, elements, and their values are defined by the service provider. For more information, see SWIFTNet FileAct: Using the Enhanced Header.
SenderInfo in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, 1...256 characters, rep. 0…1
  • Structured information about the file on a bilateral basis. The value of this option is specified according to the Backus-Naur form:
    • A list of entries of the form key=value separated by semicolons.
    • Keys are arbitrary.
    For example, this field may contain a keyword SyntaxInfo providing information about the syntax restrictions that allows the receiver to use the same restrictions as a base for further processing.

    For more information on Backus-Naur form, see Backus-Naur Form (BNF).

CopyState in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • string, enumerated, rep. 0…1
  • Information about the transfer provided by the third party:
    Active
    T-Copy or Y-Copy was performed and was successful.
    Bypass
    T-Copy or Y-Copy was not performed; the transfer did not involve a third party.
    TCopyFallback
    T-Copy was used instead of Y-Copy.
ThirdPartyInfo in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • XML subtree, 0...2048 characters, rep. 0…1
  • An optional element that contains information from the third party for the receiver. Because a FileReceived notification is issued only for an authorized transfer, the contents of the ThirdPartyInfo element in a FileReceived notification always contains the contents of an Sw:ThirdPartyToReceiverInformation field and never an Sw:ThirdPartyRefusalReason field. If ThirdPartyInfo is specified, CopyState must also be specified.
InformCopyList in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • Rep. 0…1
  • An optional folder that contains 0…n InformCopy folders. Only available when an inform copy was done.
InformCopy in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails.InformCopyList
  • Rep. 0…*
  • A folder with elements providing information about the inform copy:
    • InformCopyName (field)
    • InformCopyState (field)
    • ThirdPartyInfo (folder)
InformCopyName in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. InformCopyList.InformCopy
  • string, 1...30 characters, rep. 1
  • An identifier defined at SWIFT for the inform copy service.
InformCopyState in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. InformCopyList.InformCopy
  • string, 1...13 characters, rep. 1
  • The state of the inform copy service. Possible values are:
    Active
    T-Copy or Y-Copy was performed and was successful.
    Bypass
    T-Copy or Y-Copy was not performed; the transfer did not involve a third party.
    TCopyFallback
    T-Copy was used instead of Y-Copy.
ThirdPartyInfo in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. InformCopyList.InformCopy
  • XML subtree, 0...2048 characters, rep. 0…1
  • An optional element that contains information from the third party for the receiver.
DistributionInfo in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • Rep. 0…1
  • This folder contains the elements that provide information about the file distribution:
    • OrigSnfRef (field)
    • RecipientList (folder)
OrigSnfRef in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. DistributionInfo
  • string, 1...50 characters, rep. 1
  • A message reference, set by the SIPN, that uniquely identifies the original FileAct request primitive. The format is that of SwGbl:SwiftRef, which is described in SWIFTNet Link: Interface Specification.
RecipientList in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. DistributionInfo
  • Rep. 0…1
  • This folder contains a list of the DNs of all recipients:
    • RecipientDN (field)
    This folder is available only if the recipient list is public.
RecipientDN in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. DistributionInfo.RecipientList
  • string, 1...100 characters, rep. 1...1000
  • Distinguished name to which the FileAct request primitive was distributed.
SnFInfo in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails
  • Rep. 0…1
  • This folder contains SnF information copied from the received FileAct SNL primitive. It is available only if in the FileReceived options the configuration attribute PassSnFOutputInfo is set to True.
    Contents:
    • Sw:SnFOutputInfo (folder)
Sw:SnFOutputInfo in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails.SnFInfo
  • Rep. 0…1
  • This is the copy of the Sw:SnFOutputInfo folder of the received FileAct SNL primitive. For more information, see SWIFTNet Link: Interface Specification.
    Contents:
    • Sw:SnFSessionId (field)
    • Sw:SnFOutputSeq (field)
    • Sw:SnFPDMHistory (folder)
    • Sw:DeliveryTime (field)
    • Sw:SnFInputTime (field)
Sw:SnFSessionId in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • string, 1...40 characters, rep. 0...1
  • This field specifies the ID of the SnF session in which the file was received. It is the copy of the Sw:SnFSessionId field of the received FileAct primitive. For more information, see SWIFTNet Link: Interface Specification.
Sw:SnFOutputSeq in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • int, 1...999999999, rep. 0...1
  • This field specifies the SnF output sequence number used for the output channel transfer. An application can use this number to find out the sequence in which files were received from SWIFT. It is the copy of the Sw:SnFOutputSeq field of the received FileAct primitive. For more information, see SWIFTNet Link: Interface Specification.
Sw:SnFPDMHistory in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • Rep. 0…1
  • This folder contains SnF PDM history information. An application can use this information to get SnF output sequence numbers of previous delivery attempts. It is the copy of the Sw:SnFPDMHistory folder of the received FileAct primitive. For more information, see SWIFTNet Link: Interface Specification.
Sw:DeliveryTime in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • string, 20 characters, rep. 0…1
  • This field specifies the time when the file was retrieved from the SnF queue by the receiver. It is the copy of the Sw:DeliveryTime field of the received FileAct primitive. The delivery time has the following format:
    yyyy-mm-ddThh:mm:ssZ
    where:
    yyyy
    Year.
    mm
    Month.
    dd
    Day.
    hh
    Hour.
    mm
    Minute.
    ss
    Second.
    For example:
    2020-12-19T08:58:37Z
    For more information, see SWIFTNet Link: Interface Specification.
Sw:SnFInputTime in Function.DNF_O_FT.FileReceived.Notification.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • string, 24 characters, rep. 0…1
  • This field specifies the time that the request was stored by SWIFT for subsequent processing. It is the copy of the Sw:SnFInputTime field of the received FileAct primitive. The SnF input time has the following format:
    ddrr:yyyy-mm-ddThh:mm:ss
    where:
    dd
    Two digits that identify the SWIFT database.
    rr
    A two-digit number from 01 to 99 that identifies the run. This number is incremented after each system recovery. After it reaches 99, it rolls over to 01.
    yyyy
    Year.
    mm
    Month.
    dd
    Day.
    hh
    Hour.
    mm
    Minute.
    ss
    Second.
    For example:
    0102:2020-12-31T15:54:13
    For more information, see SWIFTNet Link: Interface Specification.
RetrievalDetails in Function.DNF_O_FT.FileReceived.Notification
  • Rep. 0…1
  • This folder indicates that this message is a SWIFTNet retrieval file. It contains the elements that provide information about the original SWIFTNet FileAct request primitive:
    • Sequence (field)
    • Final (field)
    • ReceiveDetails (folder)
    • SendDetails (folder)
    For retrieval files, the MSIF transfer service sets the fields of the Completion.ReasonList.Reason folder of the notification to the following values:
    Code
    PartialOk
    Value
    DNFO2616I
    For more information on the SWIFTNet retrieval service, see SWIFTNet Store-and-forward Retrieval.
Sequence in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails
  • int, 0...10000, rep. 1
  • A SWIFTNet retrieval request can initiate the retrieval of up to 10000 files. This field indicates the sequence number of this SWIFTNet FileAct request primitive within the batch of retrieval files. Note that IBM MQ and FTM SWIFT do not guarantee to preserve the order of sequence.
Final in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails
  • string, enumerated, rep. 1
  • Indicates if this is the last retrieval file of a SWIFTNet retrieval batch. Note that IBM MQ and FTM SWIFT do not guarantee to preserve the order of sequence. Possible values are:
    True
    This is the last retrieval file in the batch.
    False
    This is not the last retrieval file in the batch.
ReceiveDetails in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails
  • Rep. 0…1
  • This folder indicates, that the SWIFTNet retrieval file originally was a receive file request. It contains the elements that provide information about the original SWIFTNet FileAct request primitive:
    • PDIndication (field)
    • HeaderInfo (folder)
    • RetrievalSnFRef (field)
    • E2EMsgId (field)
    • RetrievalUserRef (field)
    • RequestSignatureList (folder)
    • SwiftTime (field)
    • CopyState (field)
    • ThirdPartyInfo (field)
    • InformCopyList (folder)
    • DistributionInfo (folder)
    • SnFInfo (folder)
PDIndication in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • string, enumerated, rep. 1
  • Indicates if the original SWIFTNet FileAct request primitive was a possible duplicate. Possible values are:
    True
    The original SWIFTNet FileAct request was flagged as a possible duplicate. Use the TransferRef or E2EMsgId fields to check for duplicate files.
    False
    The original SWIFTNet FileAct request was not flagged as a possible duplicate.
HeaderInfo in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • XML subtree, 0...51200 characters, rep. 0…1
  • This is structured information, in XML form, about the original SWIFTNet FileAct request primitive. It corresponds to the SWIFT Sw:HeaderInfo structure excluding the Sw:HeaderInfo tag. Subfolders, elements, and their values are defined by the service provider.
RetrievalSnFRef in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • string, 1...50 characters, rep. 0…1
  • A message reference, set by the SIPN, that uniquely identifies the original SWIFTNet FileAct request primitive. If present, then this retrieved file was generated as a result of an xsys.015 retrieval request, and this is the Sw:SnFRef of this request. The format is that of SwGbl:SwiftRef, which is described in SWIFTNet Link: Interface Specification.
E2EMsgId in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • string, 0...42 characters, rep. 0…1
  • A reference, set by the MSIF transfer service, that uniquely identifies the original SWIFTNet FileAct request primitive. It is set to the value of the Sw:MsgId field of the Sw:RequestE2EControl block of the FileAct primitive.
RetrievalUserRef in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • string, 1...50 characters, rep. 0…1
  • If present, this original SWIFTNet FileAct request primitive was generated by the SWIFT Online Operations Management Web Application and this was the user reference provided there.
RequestSignatureList in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • XML subtree, rep. 0…1
  • This element contains the signature list of the original SWIFTNet FileAct request primitive. The signatures in this list are Sw:SignatureList XML structures in the after-sign form. For more information, see SWIFTNet Link: Interface Specification.
SwiftTime in Function.DNF_O_FT.FileReceived.Notification.Retrieval Details.ReceiveDetails
  • string, 20 characters, rep. 1
  • A timestamp that indicates the SWIFT UTC time of the original SWIFTNet FileAct request primitive. It corresponds to the value of the Sw:SwiftTime field of its Sw:HandleFileRequest folder. This value is generated by the SIPN and has the format:
    yyyy-mm-ddThh:mm:ssZ
    where:
    yyyy
    Year.
    mm
    Month.
    dd
    Day.
    hh
    Hour.
    mm
    Minute.
    ss
    Second.
    For example:
    2016-02-19T08:58:37Z
CopyState in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • string, enumerated, rep. 0…1
  • Information about the original SWIFTNet transfer provided by the third party:
    Active
    T-Copy or Y-Copy was performed and was successful.
    Bypass
    T-Copy or Y-Copy was not performed; the transfer did not involve a third party.
    TCopyFallback
    T-Copy was used instead of Y-Copy.
ThirdPartyInfo in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • XML subtree, 0...2048 characters, rep. 0…1
  • An optional element in the original SWIFTNet FileAct request primitive that contains information from the third party for the receiver. Because a FileReceived notification is issued only for an authorized transfer, the contents of the ThirdPartyInfo element in a FileReceived notification always contain the contents of an Sw:ThirdPartyToReceiverInformation field and never an Sw:ThirdPartyRefusalReason field. If ThirdPartyInfo is specified, CopyState must also be specified.
InformCopyList in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • XML subtree, rep. 0…1
  • An optional folder that contains 0…n InformCopy folders. Only available when an inform copy was done for the original SWIFTNet FileAct request primitive.
InformCopy in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails.InformCopyList
  • XML subtree, rep. 0…*
  • A folder with elements providing information about the inform copy:
    • InformCopyName (field)
    • InformCopyState (field)
    • ThirdPartyInfo (folder)
InformCopyState in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. InformCopyList.InformCopy
  • string, 1...13 characters, rep. 1
  • The state of the inform copy service. Possible values are:
    Active
    T-Copy or Y-Copy was performed and was successful.
    Bypass
    T-Copy or Y-Copy was not performed; the transfer did not involve a third party.
    TCopyFallback
    T-Copy was used instead of Y-Copy.
InformCopyName in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. InformCopyList.InformCopy
  • string, 1...30 characters, rep. 1
  • An identifier defined at SWIFT for the inform copy service.
DistributionInfo in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • Rep. 0…1
  • This folder contains the elements that provide information about the message distribution of the original SWIFTNet FileAct request primitive:
    • OrigSnfRef (field)
    • RecipientList (folder)
OrigSnfRef in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. DistributionInfo
  • string, 1...50 characters, rep. 1
  • A message reference, set by the SIPN, that uniquely identified the original SWIFTNet FileAct request primitive. The format is that of SwGbl:SwiftRef, which is described in SWIFTNet Link: Interface Specification.
RecipientList in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. DistributionInfo
  • Rep. 0…1
  • This folder contains a list of the DNs of all recipients:
    • RecipientDN (field)
RecipientDN in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. DistributionInfo.RecipientList
  • string, 1...100 characters, rep. 1...1000
  • This field contains the distinguished name to which the original SWIFTNet FileAct request primitive was distributed.
SnFInfo in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails
  • Rep. 0…1
  • This folder contains SnF information copied from the original SWIFTNet FileAct request primitive. It is available only if in the FileReceived options the configuration attribute PassSnFOutputInfo was set to True.
    Contents:
    • Sw:SnFOutputInfo (folder)
Sw:SnFOutputInfo in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails.SnFInfo
  • XML subtree, rep. 0…1
  • This is the copy of the Sw:SnFOutputInfo folder of the original SWIFTNet FileAct request primitive. For more information, see SWIFTNet Link: Interface Specification.
    Contents:
    • Sw:SnFSessionId (field)
    • Sw:SnFOutputSeq (field)
    • Sw:SnFPDMHistory (folder)
    • Sw:DeliveryTime (field)
    • Sw:OverdueTime (field)
    • Sw:SnFInputTime (field)
Sw:SnFSessionId in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • string, 1...40 characters, rep. 0...1
  • This field specifies the ID of the SnF session in which the file was received. It is the copy of the Sw:SnFSessionId field of the original SWIFTNet FileAct request primitive. For more information, see SWIFTNet Link: Interface Specification.
Sw:SnFOutputSeq in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • int, 1...999999999, rep. 0...1
  • This field specifies the SnF output sequence number used for the output channel transfer. An application can use this number to find out the sequence in which files were received from SWIFT. It is the copy of the Sw:SnFOutputSeq field of the original SWIFTNet FileAct request primitive. For more information, see SWIFTNet Link: Interface Specification.
Sw:SnFPDMHistory in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • XML subtree, rep. 0…1
  • This folder contains SnF PDM history information of the original SWIFTNet FileAct request primitive. An application can use this information to get SnF output sequence numbers of previous delivery attempts. It is the copy of the Sw:SnFPDMHistory folder of the SWIFTNet FileAct request primitive. For more information, see SWIFTNet Link: Interface Specification.
Sw:DeliveryTime in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • string, 20 characters, rep. 0…1
  • This field specifies the time when the original SWIFTNet FileAct request primitive was retrieved from the SnF queue by the receiver. It is the copy of the Sw:DeliveryTime field of the SWIFTNet FileAct request primitive. The delivery time has the following format:
    yyyy-mm-ddThh:mm:ssZ
    where:
    yyyy
    Year.
    mm
    Month.
    dd
    Day.
    hh
    Hour.
    mm
    Minute.
    ss
    Second.
    For example:
    2020-12-19T08:58:37Z
    For more information, see SWIFTNet Link: Interface Specification.
Sw:OverdueTime in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails.SnFInfo.Sw:SnFOutputInfo
  • dateTime, rep. 0...1
  • The date and time at which the original SWIFTNet FileAct request primitive was considered to be overdue. The sender specified this value when sending the file. A notification contains this field only if SWIFT sent a non-delivery warning to the sender. The overdue time has the same format as the delivery time (see above).
Sw:SnFInputTime in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.ReceiveDetails. SnFInfo.Sw:SnFOutputInfo
  • string, 24 characters, rep. 0…1
  • This field specifies the time that the original SWIFTNet FileAct request primitive was stored by SWIFT for subsequent processing. It is the copy of the Sw:SnFInputTime field of the SWIFTNet FileAct request primitive. The SnF input time has the following format:
    ddrr:yyyy-mm-ddThh:mm:ss
    where:
    dd
    Two digits that identify the SWIFT database.
    rr
    A two-digit number from 01 to 99 that identifies the run. This number is incremented after each system recovery. After it reaches 99, it rolls over to 01.
    yyyy
    Year.
    mm
    Month.
    dd
    Day.
    hh
    Hour.
    mm
    Minute.
    ss
    Second.
    For example:
    0102:2021-12-31T15:54:13
    For more information, see SWIFTNet Link: Interface Specification.
SendDetails in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails
  • Rep. 0…1
  • This folder indicates, that the original SWIFTNet FileAct request primitive was a send file request. It contains the elements that provide information about the original SWIFTNet FileAct request primitive:
    • PDIndication (field)
    • HeaderInfo (folder)
    • RetrievalUserRef (field)
    • MSIFReference (field)
    • E2EMsgId (field)
    • AuthNotif (field)
    • Copy (field)
    • DeliveryMode (field)
    • DeliveryNotif (field)
    • OverdueWarningDelay (field)
    • OverdueTime (field)
    • ThirdPartyOptions (folder)
PDIndication in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • string, enumerated, rep. 1
  • Indicates if the original SWIFTNet FileAct request primitive was a possible duplicate. Possible values are:
    True
    The original SWIFTNet FileAct request was flagged as a possible duplicate. Use the MSIF reference or E2EMsgId fields to check for duplicate messages.
    False
    The original SWIFTNet FileAct request was not flagged as a possible duplicate.
HeaderInfo in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • XML subtree, 0...51200 characters, rep. 0…1
  • This is structured information, in XML form, about the original SWIFTNet FileAct request primitive. It corresponds to the SWIFT Sw:HeaderInfo structure excluding the Sw:HeaderInfo tag. Subfolders, elements, and their values were defined by the service provider.
RetrievalUserRef in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • string, 1...50 characters, rep. 0…1
  • If present, this original SWIFTNet FileAct request was generated by the SWIFT Online Operations Management Web Application and this was the user reference provided there.
MSIFReference in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • bin.hex, 48 chars (hex double byte rep. of MQBYTE24), rep. 0…1
  • The MSIF reference of the original SWIFTNet FileAct request primitive, which is an ID generated by the MSIF transfer service that uniquely identifies a scenario. It is identical to the MQMD.MsgId of the corresponding SendFile request. Use this reference to identify the original scenario, for example, when issuing a list or cancel command, or when querying the message warehouse.
E2EMsgId in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • string, 0...42 characters, rep. 0…1
  • A reference, set by the MSIF transfer service, that uniquely identified the original SWIFTNet FileAct request primitive. It is set to the value of the Sw:MsgId field of the Sw:RequestE2EControl block of the FileAct primitive.
AuthNotif in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • string, enumerated, rep. 0…1
  • An indicator if the original SWIFTNet FileAct request primitive requested authorisation notifications. This field can have two values:
    True
    The SIPN was instructed to send an authorisation notification to the sender.
    False
    The SIPN was not instructed to send authorisation notifications to the sender.
Copy in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • string, enumerated, rep. 0…1
  • An indicator if the original SWIFTNet FileAct request primitive was sent in Y-Copy or T-Copy mode:
    True
    The copy mode was used.
    False
    The copy mode was not used.
DeliveryMode in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • string, enumerated, rep. 0…1
  • Contains the delivery mode of the original SWIFTNet FileAct request primitive, which currently can only be SNF.
DeliveryNotif in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • string, enumerated, rep. 0…1
  • Indicates whether the original SWIFTNet FileAct request primitive requested the SIPN to send a delivery notification after the counterpart receives and acknowledges a message that was sent in SnF mode:
    True
    A delivery notification was requested
    False
    A delivery notification was not requested
OverdueWarningDelay in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • int, 5…1440, rep. 0…1
  • Contains the OverdueWarningDelay set by the original SWIFTNet FileAct request primitive. This is the number of minutes after which, if the file was not delivered to or acknowleged by the counterpart, the SIPN had to consider the file to be overdue and send a non-delivery warning to the sender.
OverdueTime in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • dateTime, rep. 0…1
  • Contains the OverdueTime set by the original SWIFTNet FileAct request primitive. This is the date and time at which, if the file was not delivered to or acknowleged by the counterpart, the SIPN had to consider the file to be overdue and send a non-delivery warning to the sender.
ThirdPartyOptions in Function.DNF_O_FT.FileReceived.Notification.RetrievalDetails.SendDetails
  • Rep. 0…1
  • A folder of the original SWIFTNet FileAct request primitive specifying the distinguished names of third parties to which a copy of the f had to be routed when a SWIFTNet Copy service (T-copy or Y-copy) was used. It contains fields with names of the form ThirdPartyDNx, where the variable x represents a number from 1 to 10.

    For more information, see Third-party options: ThirdPartyOptions.

FileOptions in Function.DNF_O_FT.FileReceived.Notification
  • Rep. 0…1
  • This folder specifies options for the file transfer. It can contain the following elements:
    • AppCodepage (field)
    • NetworkCodepage (field)
    • Compression (field)
    The values in this folder are taken from the FileOptionSet that is referred to in either the TransferOptionSet or the FileReceiveOptionSet.

    For more information on these elements, see File options: FileOptions.

TargetOptions in Function.DNF_O_FT.FileReceived.Notification
  • Rep. 0…1
  • This folder specifies more information about the target file. If not present, the file content is returned as payload in this notification. This folder can contain the FileName element.

    For more information on these elements, see Target options: TargetOptions.

Completion in Function.DNF_O_FT.FileReceived.Notification
  • Rep. 1
  • This folder specifies the result of the file reception. For more information, see Completion.
    Note: The MPU attribute of a Completion element is restricted for internal use and cannot be interpreted or otherwise used by an application.
    Contents:
    • Code (field)
    • ReasonList (folder)
    • Explanation (field)