Iso20022

MaintenanceDelegationRequestV05

catm.005.001.05

A terminal manager requests to the master terminal manager the delegation of maintenance functions or maintenance operation on the terminal estate managed by the master terminal manager.

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
%% MaintenanceDelegationRequestV05 recursion level 0 with max 0
MaintenanceDelegationRequestV05 *-- "0..1" Header29 : Header
MaintenanceDelegationRequestV05 *-- "1..1" MaintenanceDelegationRequest5 : MaintenanceDelegationRequest
MaintenanceDelegationRequestV05 *-- "1..1" ContentInformationType18 : SecurityTrailer

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

Header building block

Information related to the protocol management. Set of characteristics related to the reject of a transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header29 recursion level 0 with max 1
class Header29{
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
Header29 *-- "1..1" GenericIdentification72 : InitiatingParty
Header29 *-- "0..1" GenericIdentification93 : RecipientParty
%% GenericIdentification72 recursion level 1 with max 1
class GenericIdentification72{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification93 recursion level 1 with max 1
class GenericIdentification93{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification93 *-- "0..1" NetworkParameters5 : RemoteAccess

Header29 members

Member name Description Data Type / Multiplicity
ProtocolVersion Version of the terminal management protocol specifications. IsoMax6Text - Required 1..1
ExchangeIdentification Unique identification of an exchange occurrence. IsoNumber - Optional 0..1
CreationDateTime Date and time at which the file or message was created. IsoISODateTime - Required 1..1
InitiatingParty Unique identification of the partner that has initiated the exchange. GenericIdentification72 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the exchange. GenericIdentification93 - Optional 0..1

MaintenanceDelegationRequest building block

Information related to the request of maintenance delegations. Information related to the request of maintenance delegations. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MaintenanceDelegationRequest5 recursion level 0 with max 1
MaintenanceDelegationRequest5 *-- "1..1" GenericIdentification72 : TMIdentification
MaintenanceDelegationRequest5 *-- "0..1" GenericIdentification72 : MasterTMIdentification
MaintenanceDelegationRequest5 *-- "1..0" MaintenanceDelegation8 : RequestedDelegation
%% GenericIdentification72 recursion level 1 with max 1
class GenericIdentification72{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification72 recursion level 1 with max 1
class GenericIdentification72{
    Identification IsoMax35Text
    Issuer PartyType6Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% MaintenanceDelegation8 recursion level 1 with max 1
class MaintenanceDelegation8{
    DelegationType TerminalManagementAction3Code
    MaintenanceService DataSetCategory13Code
    PartialDelegation IsoTrueFalseIndicator
    POISubset IsoMax35Text
    DelegationScopeIdentification IsoMax35Text
    DelegationScopeDefinition IsoMax3000Binary
    Certificate IsoMax10KBinary
}
MaintenanceDelegation8 *-- "0..1" MaintenanceDelegateAction4 : DelegatedAction
MaintenanceDelegation8 *-- "0..0" MaintenanceIdentificationAssociation1 : POIIdentificationAssociation
MaintenanceDelegation8 *-- "0..0" KEKIdentifier5 : SymmetricKey
MaintenanceDelegation8 *-- "0..1" TerminalManagementDataSet27 : ParameterDataSet

MaintenanceDelegationRequest5 members

Member name Description Data Type / Multiplicity
TMIdentification Terminal manager identification. GenericIdentification72 - Required 1..1
MasterTMIdentification Master terminal manager identification. GenericIdentification72 - Optional 0..1
RequestedDelegation Information on the delegation of a maintenance action. MaintenanceDelegation8 - Unknown 1..0

SecurityTrailer building block

Trailer of the message containing a MAC or a digital signature. General cryptographic message syntax (CMS) containing data. protected by a MAC or a digital signature. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType18 recursion level 0 with max 1
class ContentInformationType18{
    ContentType ContentType2Code
}
ContentInformationType18 *-- "0..1" AuthenticatedData5 : AuthenticatedData
ContentInformationType18 *-- "0..1" SignedData5 : SignedData
%% AuthenticatedData5 recursion level 1 with max 1
class AuthenticatedData5{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData5 *-- "1..0" IRecipient6Choice : Recipient
AuthenticatedData5 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData5 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData5 recursion level 1 with max 1
class SignedData5{
    Version IsoNumber
    Certificate IsoMax5000Binary
}
SignedData5 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData5 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData5 *-- "0..0" Signer4 : Signer

ContentInformationType18 members

Member name Description Data Type / Multiplicity
ContentType Type of data protection. ContentType2Code - Required 1..1
AuthenticatedData Data protection by a message authentication code (MAC). AuthenticatedData5 - Optional 0..1
SignedData Data protected by a digital signatures. SignedData5 - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    MaintenanceDelegationRequestV05 --|> IOuterRecord : Implements
    MaintenanceDelegationRequestV05Document --|> IOuterDocument~MaintenanceDelegationRequestV05~ : Implements
    class IOuterDocument~MaintenanceDelegationRequestV05~ {
        MaintenanceDelegationRequestV05 Message
     }

Document wrapper for serialization

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

classDiagram
    MaintenanceDelegationRequestV05Document *-- MaintenanceDelegationRequestV05 : 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:catm.005.001.05">
    <MntncDlgtnReq>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <MntncDlgtnReq>
            <!-- MaintenanceDelegationRequest inner content -->
        </MntncDlgtnReq>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </MntncDlgtnReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_BStUMfSKEeiUhZc7kGqupA"
  nextVersions="_u9CRUQ00EeqUVL7sB4m7NA"
  previousVersion="_2XFUodqIEeearpaEPXv9UA"
  name="MaintenanceDelegationRequestV05"
  definition="A terminal manager requests to the master terminal manager the delegation of maintenance functions or maintenance operation on the terminal estate managed by the master terminal manager."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="MntncDlgtnReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_BStUM_SKEeiUhZc7kGqupA"
    nextVersions="_u9CRUw00EeqUVL7sB4m7NA"
    previousVersion="_2XFUo9qIEeearpaEPXv9UA"
    name="Header"
    definition="Information related to the protocol management."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Hdr"
    complexType="_RtBnUY4CEeWrZqsymMFdfg" />
  <messageBuildingBlock
    xmi:id="_BStUNfSKEeiUhZc7kGqupA"
    nextVersions="_u9CRVQ00EeqUVL7sB4m7NA"
    previousVersion="_2XFUpdqIEeearpaEPXv9UA"
    name="MaintenanceDelegationRequest"
    definition="Information related to the request of maintenance delegations."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MntncDlgtnReq"
    complexType="_Zq4Y8fSKEeiUhZc7kGqupA" />
  <messageBuildingBlock
    xmi:id="_BStUN_SKEeiUhZc7kGqupA"
    nextVersions="_u9CRVw00EeqUVL7sB4m7NA"
    previousVersion="_2XFUp9qIEeearpaEPXv9UA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="__DJZ4dtZEee9e6xduATmQg" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="005"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

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