SpecialNotificationV01

tsmt.048.001.01

Scope The SpecialNotification message is sent by the matching application to parties to the transaction, following the receipt of a SpecialRequest message. The SpecialRequest message is sent by a party to the transaction to the matching application if special circumstances are such that it cannot take part any longer to a specific transaction or that it cannot fulfill its role in the transaction. Usage The SpecialNotification message is sent to the parties to the transaction so that they can take appropriate action.

Message Construction

Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification

classDiagram
     direction LR
%% SpecialNotificationV01 recursion level 0 with max 0
SpecialNotificationV01 *-- "1..1" MessageIdentification1 : NotificationIdentification
SpecialNotificationV01 *-- "1..1" SimpleIdentificationInformation : TransactionIdentification
SpecialNotificationV01 *-- "1..1" DocumentIdentification3 : EstablishedBaselineIdentification
SpecialNotificationV01 *-- "1..1" TransactionStatus4 : TransactionStatus
SpecialNotificationV01 *-- "0..2" DocumentIdentification5 : UserTransactionReference
SpecialNotificationV01 *-- "1..1" BICIdentification1 : Initiator
SpecialNotificationV01 *-- "1..1" Notification1 : Notification
SpecialNotificationV01 *-- "0..1" PendingActivity2 : RequestForAction
  

Now, we will zero-in one-by-one on each of these building blocks.

NotificationIdentification building block

Identifies the notification message. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageIdentification1 members

TransactionIdentification building block

Unique identification assigned by the matching application to the transaction. This identification is to be used in any communication between the parties. . Information related to an identification, eg, party identification or account identification. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SimpleIdentificationInformation recursion level 0 with max 1
class SimpleIdentificationInformation{
    Identification IsoMax35Text
}
  

SimpleIdentificationInformation members

EstablishedBaselineIdentification building block

Unique identification assigned by the matching application to the baseline when it is established. Identifies a document by a unique identification and a version. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification3 recursion level 0 with max 1
class DocumentIdentification3{
    Identification IsoMax35Text
    Version IsoNumber
}
  

DocumentIdentification3 members

TransactionStatus building block

Identifies the status of the transaction by means of a code. Identifies the status of the transaction by means of a code. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TransactionStatus4 recursion level 0 with max 1
class TransactionStatus4{
    Status BaselineStatus3Code
}
  

TransactionStatus4 members

UserTransactionReference building block

Reference to the transaction for the financial institution that is the sender of the acknowledged message. Identifies a document by a unique identification and its issuer. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification5 recursion level 0 with max 1
class DocumentIdentification5{
    Identification IsoMax35Text
}
DocumentIdentification5 *-- "1..1" BICIdentification1 : IdentificationIssuer
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

DocumentIdentification5 members

Initiator building block

Party that has sent the special request. Unique and unambiguous identifier of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BICIdentification1 recursion level 0 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

BICIdentification1 members

Notification building block

Notification received by the matching application and forwarded to another party. Structured information to be communicated to other parties in the transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Notification1 recursion level 0 with max 1
class Notification1{
    Type NotificationType1Code
    AdditionalInformation IsoMax140Text
}
  

Notification1 members

RequestForAction building block

Information on the next processing step required. Specifies the event that require an action from one of the parties to the trade transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PendingActivity2 recursion level 0 with max 1
class PendingActivity2{
    Type Action2Code
    Description IsoMax140Text
}
  

PendingActivity2 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the SpecialNotificationV01 implementation follows a specific implementaiton pattern. First of all, SpecialNotificationV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SpecialNotificationV01Document implements IOuterDocument. Because SpecialNotificationV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SpecialNotificationV01.

classDiagram
    class IOuterRecord
    SpecialNotificationV01 --|> IOuterRecord : Implements
    SpecialNotificationV01Document --|> IOuterDocument~SpecialNotificationV01~ : Implements
    class IOuterDocument~SpecialNotificationV01~ {
        SpecialNotificationV01 Message
     }
  

Document wrapper for serialization

The only real purpose SpecialNotificationV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:tsmt.048.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SpecialNotificationV01.ToDocument() method. The returned SpecialNotificationV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    SpecialNotificationV01Document *-- SpecialNotificationV01 : Document
  

Sample of message format

This is an abbreviated version of what the message should look like.

<Document xmlns="urn:iso:std:iso:20022:tech:xsd:tsmt.048.001.01">
    <SpclNtfctn>
        <NtfctnId>
            <!-- NotificationIdentification inner content -->
        </NtfctnId>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <EstblishdBaselnId>
            <!-- EstablishedBaselineIdentification inner content -->
        </EstblishdBaselnId>
        <TxSts>
            <!-- TransactionStatus inner content -->
        </TxSts>
        <UsrTxRef>
            <!-- UserTransactionReference inner content -->
        </UsrTxRef>
        <Initr>
            <!-- Initiator inner content -->
        </Initr>
        <Ntfctn>
            <!-- Notification inner content -->
        </Ntfctn>
        <ReqForActn>
            <!-- RequestForAction inner content -->
        </ReqForActn>
    </SpclNtfctn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_uldKWNE8Ed-BzquC8wXy7w_-3505275"
  name="SpecialNotificationV01"
  definition="Scope&#xD;&#xA;The SpecialNotification message is sent by the matching application to parties to the transaction, following the receipt of a SpecialRequest message.&#xD;&#xA;The SpecialRequest message is sent by a party to the transaction to the matching application if special circumstances are such that it cannot take part any longer to a specific transaction or that it cannot fulfill its role in the transaction.&#xD;&#xA;Usage&#xD;&#xA;The SpecialNotification message is sent to the parties to the transaction so that they can take appropriate action."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="SpclNtfctn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ulm7UNE8Ed-BzquC8wXy7w_7576915"
    name="NotificationIdentification"
    definition="Identifies the notification message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="NtfctnId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_ulm7UdE8Ed-BzquC8wXy7w_8501968"
    name="TransactionIdentification"
    definition="Unique identification assigned by the matching application to the transaction.&#xA;This identification is to be used in any communication between the parties.&#xA;."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxId"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_ulm7UtE8Ed-BzquC8wXy7w_8499489"
    name="EstablishedBaselineIdentification"
    definition="Unique identification assigned by the matching application to the baseline when it is established."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="EstblishdBaselnId"
    complexType="_RJNBwdp-Ed-ak6NoX_4Aeg_-1127047102" />
  <messageBuildingBlock
    xmi:id="_ulm7U9E8Ed-BzquC8wXy7w_8500107"
    name="TransactionStatus"
    definition="Identifies the status of the transaction by means of a code."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxSts"
    complexType="_RbFb-Np-Ed-ak6NoX_4Aeg_1598523783" />
  <messageBuildingBlock
    xmi:id="_ulm7VNE8Ed-BzquC8wXy7w_8502400"
    name="UserTransactionReference"
    definition="Reference to the transaction for the financial institution that is the sender of the acknowledged message."
    registrationStatus="Provisionally Registered"
    maxOccurs="2"
    minOccurs="0"
    xmlTag="UsrTxRef"
    complexType="_RJWLsdp-Ed-ak6NoX_4Aeg_-86119846" />
  <messageBuildingBlock
    xmi:id="_ulm7VdE8Ed-BzquC8wXy7w_1354069290"
    name="Initiator"
    definition="Party that has sent the special request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Initr"
    complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
  <messageBuildingBlock
    xmi:id="_ulm7VtE8Ed-BzquC8wXy7w_1253406214"
    name="Notification"
    definition="Notification received by the matching application and forwarded to another party."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Ntfctn"
    complexType="_RaowA9p-Ed-ak6NoX_4Aeg_1225299644" />
  <messageBuildingBlock
    xmi:id="_ulm7V9E8Ed-BzquC8wXy7w_8500865"
    name="RequestForAction"
    definition="Information on the next processing step required."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ReqForActn"
    complexType="_RaowBtp-Ed-ak6NoX_4Aeg_-888447978" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="048"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.