SystemEventNotificationV02

admi.004.001.02

Scope The SystemEventNotification message is sent by a central system to notify the occurrence of an event in a central system. Usage The message can be used by a central settlement system to inform its participants of an event that is going to occur in the system, for instance that the system will be down at a certain time, etc.

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
%% SystemEventNotificationV02 recursion level 0 with max 0
SystemEventNotificationV02 *-- "1..1" Event2 : EventInformation
  

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

EventInformation building block

Detailed information about a system event. Provides information on an event that happened in a system. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Event2 recursion level 0 with max 1
class Event2{
    EventCode IsoMax4AlphaNumericText
    EventParameter IsoMax35Text
    EventDescription IsoMax1000Text
    EventTime IsoISODateTime
}
  

Event2 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SystemEventNotificationV02 --|> IOuterRecord : Implements
    SystemEventNotificationV02Document --|> IOuterDocument~SystemEventNotificationV02~ : Implements
    class IOuterDocument~SystemEventNotificationV02~ {
        SystemEventNotificationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SystemEventNotificationV02Document *-- SystemEventNotificationV02 : 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:admi.004.001.02">
    <SysEvtNtfctn>
        <EvtInf>
            <!-- EventInformation inner content -->
        </EvtInf>
    </SysEvtNtfctn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_pgC-EU7TEeSGH6dwL1uJcg"
  name="SystemEventNotificationV02"
  definition="Scope&#xD;&#xA;The SystemEventNotification message is sent by a central system to notify the occurrence of an event in a central system.&#xD;&#xA;Usage&#xD;&#xA;The message can be used by a central settlement system to inform its participants of an event that is going to occur in the system, for instance that the system will be down at a certain time, etc."
  registrationStatus="Registered"
  messageSet="_wiatARJsEeSstbhSoCHcWw _8XKG0KbdEeu5KoySNFB8Ig"
  xmlTag="SysEvtNtfctn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_pgC-E07TEeSGH6dwL1uJcg"
    name="EventInformation"
    definition="Detailed information about a system event."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="EvtInf"
    complexType="_whUBYU7TEeSGH6dwL1uJcg" />
  <messageDefinitionIdentifier
    businessArea="admi"
    messageFunctionality="004"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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