UndertakingTerminationNotificationV01

tsrv.012.001.01

The UndertakingTerminationNotification message is sent to the applicant by the party that issued the undertaking to give notification of the termination or cancelation of the referenced undertaking.

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
%% UndertakingTerminationNotificationV01 recursion level 0 with max 0
UndertakingTerminationNotificationV01 *-- "1..1" UndertakingTerminationNotice1 : UndertakingTerminationNotificationDetails
UndertakingTerminationNotificationV01 *-- "0..1" PartyAndSignature2 : DigitalSignature
  

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

UndertakingTerminationNotificationDetails building block

Details of the termination notification. Information about the notification of the termination of an undertaking. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% UndertakingTerminationNotice1 recursion level 0 with max 1
class UndertakingTerminationNotice1{
    AdditionalInformation IsoMax2000Text
}
UndertakingTerminationNotice1 *-- "1..1" Undertaking9 : UndertakingIdentification
UndertakingTerminationNotice1 *-- "1..1" UndertakingTermination3 : TerminationDetails
UndertakingTerminationNotice1 *-- "0..0" Document9 : EnclosedFile
%% Undertaking9 recursion level 1 with max 1
class Undertaking9{
    Identification IsoMax35Text
    ApplicantReferenceNumber IsoMax35Text
}
Undertaking9 *-- "1..1" PartyIdentification43 : Issuer
%% UndertakingTermination3 recursion level 1 with max 1
class UndertakingTermination3{
    EffectiveDate IsoISODate
    AdditionalInformation IsoMax2000Text
}
UndertakingTermination3 *-- "0..1" ITerminationReason1Choice : Reason
%% Document9 recursion level 1 with max 1
class Document9{
    Identification IsoMax35Text
    Enclosure IsoMax2MBBinary
}
Document9 *-- "1..1" IUndertakingDocumentType1Choice : Type
Document9 *-- "0..1" IDocumentFormat1Choice : Format
Document9 *-- "0..1" PartyAndSignature2 : DigitalSignature
  

UndertakingTerminationNotice1 members

Member name Description Data Type / Multiplicity
UndertakingIdentification Details related to the identification of the undertaking. Undertaking9 - Required 1..1
TerminationDetails Details related to the termination of the undertaking. UndertakingTermination3 - Required 1..1
EnclosedFile Document or template enclosed in the termination notification. Document9 - Unknown 0..0
AdditionalInformation Additional information related to the notification. IsoMax2000Text - Collection 0..5

DigitalSignature building block

Digital signature of the notification. Entity involved in an activity. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PartyAndSignature2 recursion level 0 with max 1
PartyAndSignature2 *-- "1..1" PartyIdentification43 : Party
PartyAndSignature2 *-- "1..1" ProprietaryData3 : Signature
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% ProprietaryData3 recursion level 1 with max 1
ProprietaryData3 *-- "1..1" SkipProcessing : Any
  

PartyAndSignature2 members

Member name Description Data Type / Multiplicity
Party Entity involved in an activity. PartyIdentification43 - Required 1..1
Signature Signature of a party. ProprietaryData3 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    UndertakingTerminationNotificationV01 --|> IOuterRecord : Implements
    UndertakingTerminationNotificationV01Document --|> IOuterDocument~UndertakingTerminationNotificationV01~ : Implements
    class IOuterDocument~UndertakingTerminationNotificationV01~ {
        UndertakingTerminationNotificationV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    UndertakingTerminationNotificationV01Document *-- UndertakingTerminationNotificationV01 : 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:tsrv.012.001.01">
    <UdrtkgTermntnNtfctn>
        <UdrtkgTermntnNtfctnDtls>
            <!-- UndertakingTerminationNotificationDetails inner content -->
        </UdrtkgTermntnNtfctnDtls>
        <DgtlSgntr>
            <!-- DigitalSignature inner content -->
        </DgtlSgntr>
    </UdrtkgTermntnNtfctn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_9gdfZXltEeG7BsjMvd1mEw_-1901363318"
  name="UndertakingTerminationNotificationV01"
  definition="The UndertakingTerminationNotification message is sent to the applicant by the party that issued the undertaking to give notification of the termination or cancelation of the referenced undertaking."
  registrationStatus="Registered"
  messageSet="_SiMuI9n1EeGEPsbnW6ebrw"
  xmlTag="UdrtkgTermntnNtfctn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_9gdfZnltEeG7BsjMvd1mEw_-908071833"
    name="UndertakingTerminationNotificationDetails"
    definition="Details of the termination notification."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="UdrtkgTermntnNtfctnDtls"
    complexType="_97ufHHltEeG7BsjMvd1mEw_-864278160" />
  <messageBuildingBlock
    xmi:id="_9gdfZ3ltEeG7BsjMvd1mEw_-1175318209"
    name="DigitalSignature"
    definition="Digital signature of the notification."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="DgtlSgntr"
    complexType="_k4nFNZKuEeGnRMFvqYmPBQ" />
  <messageDefinitionIdentifier
    businessArea="tsrv"
    messageFunctionality="012"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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