SystemEventAcknowledgementV01

admi.011.001.01

The SystemEventAcknowledgement message is sent by a participant of a central system to the central system to acknowledge the notification of an occurrence of an event in a central system.

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
%% SystemEventAcknowledgementV01 recursion level 0 with max 0
class SystemEventAcknowledgementV01{
    MessageIdentification IsoMax35Text
    OriginatorReference IsoMax35Text
    SettlementSessionIdentifier IsoExact4AlphaNumericText
}
SystemEventAcknowledgementV01 *-- "0..1" Event1 : AcknowledgementDetails
SystemEventAcknowledgementV01 *-- "0..1" SupplementaryData1 : SupplementaryData
  

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

MessageIdentification building block

Unique and unambiguous identifier for the message, as assigned by the sender. Specifies a character string with a maximum length of 35 characters. For comparison, see the ISO20022 official specification This message is declared as Max35Text in the ISO specification. In our implementation, it is represented in source code as IsoMax35Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

OriginatorReference building block

Represents the original reference of the system event notification for which the acknowledgement is given, as assigned by the central system. Specifies a character string with a maximum length of 35 characters. For comparison, see the ISO20022 official specification This message is declared as Max35Text in the ISO specification. In our implementation, it is represented in source code as IsoMax35Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

SettlementSessionIdentifier building block

To indicate the requested CLS Settlement Session that the related trade is part of. Specifies an alphanumeric string with a length of 4 characters. For comparison, see the ISO20022 official specification This message is declared as Exact4AlphaNumericText in the ISO specification. In our implementation, it is represented in source code as IsoExact4AlphaNumericText. Due to global using directives, it is treated as a System.String by the compiler and runtime.

AcknowledgementDetails building block

Details of the system event being acknowledged. Provides information on an event that happened in a system. For comparison, see the ISO20022 official specification

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

Event1 members

SupplementaryData building block

Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
  

SupplementaryData1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SystemEventAcknowledgementV01 --|> IOuterRecord : Implements
    SystemEventAcknowledgementV01Document --|> IOuterDocument~SystemEventAcknowledgementV01~ : Implements
    class IOuterDocument~SystemEventAcknowledgementV01~ {
        SystemEventAcknowledgementV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SystemEventAcknowledgementV01Document *-- SystemEventAcknowledgementV01 : 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.011.001.01">
    <SysEvtAck>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <OrgtrRef>
            <!-- OriginatorReference inner content -->
        </OrgtrRef>
        <SttlmSsnIdr>
            <!-- SettlementSessionIdentifier inner content -->
        </SttlmSsnIdr>
        <AckDtls>
            <!-- AcknowledgementDetails inner content -->
        </AckDtls>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </SysEvtAck>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_-4fJISzhEeKZfox_pyYpTA"
  name="SystemEventAcknowledgementV01"
  definition="The SystemEventAcknowledgement message is sent by a participant of a central system to the central system to acknowledge the notification of an occurrence of an event in a central system.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_nB3wITJaEeOX98kTVpuqCw _wiatARJsEeSstbhSoCHcWw"
  xmlTag="SysEvtAck"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_38ITWTp8EeKXK8qRvydwAw"
    name="MessageIdentification"
    definition="Unique and unambiguous identifier for the message, as assigned by the sender."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_-PT44DqNEeKXK8qRvydwAw"
    name="OriginatorReference"
    definition="Represents the original reference of the system event notification for which the acknowledgement is given, as assigned by the central system."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="OrgtrRef"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_Pq-14zqfEeKqTf3MbquCbA"
    name="SettlementSessionIdentifier"
    definition="To indicate the requested CLS Settlement Session that the related trade is part of."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SttlmSsnIdr"
    simpleType="_YYLJ6Np-Ed-ak6NoX_4Aeg_-1265890753" />
  <messageBuildingBlock
    xmi:id="_-4fJJSzhEeKZfox_pyYpTA"
    name="AcknowledgementDetails"
    definition="Details of the system event being acknowledged."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="AckDtls"
    complexType="_Uslo-dp-Ed-ak6NoX_4Aeg_376982248" />
  <messageBuildingBlock
    xmi:id="_E4uhVy53EeKwTrPDLMbLxA"
    name="SupplementaryData"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="admi"
    messageFunctionality="011"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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