Iso20022

MaintenanceDelegationRequestV08

catm.005.001.08

The MaintenanceDelegationRequest message is sent by a terminal manager to the master terminal manager to request 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
%% MaintenanceDelegationRequestV08 recursion level 0 with max 0
MaintenanceDelegationRequestV08 *-- "0..1" TMSHeader1 : Header
MaintenanceDelegationRequestV08 *-- "1..1" MaintenanceDelegationRequest8 : MaintenanceDelegationRequest
MaintenanceDelegationRequestV08 *-- "1..1" ContentInformationType29 : 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 transfer of transactions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TMSHeader1 recursion level 0 with max 1
class TMSHeader1{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
TMSHeader1 *-- "1..1" GenericIdentification176 : InitiatingParty
TMSHeader1 *-- "0..1" GenericIdentification177 : RecipientParty
TMSHeader1 *-- "0..0" Traceability8 : Traceability
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification177 recursion level 1 with max 1
class GenericIdentification177{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess
GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation
%% Traceability8 recursion level 1 with max 1
class Traceability8{
    ProtocolName IsoMax35Text
    ProtocolVersion IsoMax6Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability8 *-- "1..1" GenericIdentification177 : RelayIdentification

TMSHeader1 members

Member name Description Data Type / Multiplicity
DownloadTransfer Indicates if the file transfer is a download or an upload. IsoTrueFalseIndicator - Required 1..1
FormatVersion Version of file format. IsoMax6Text - Required 1..1
ExchangeIdentification Unique identification of an exchange occurrence. IsoNumber - Required 1..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. GenericIdentification176 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the exchange. GenericIdentification177 - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability8 - Unknown 0..0

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
%% MaintenanceDelegationRequest8 recursion level 0 with max 1
MaintenanceDelegationRequest8 *-- "1..1" GenericIdentification176 : TMIdentification
MaintenanceDelegationRequest8 *-- "0..1" GenericIdentification176 : MasterTMIdentification
MaintenanceDelegationRequest8 *-- "1..0" MaintenanceDelegation13 : RequestedDelegation
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% MaintenanceDelegation13 recursion level 1 with max 1
class MaintenanceDelegation13{
    DelegationType TerminalManagementAction3Code
    MaintenanceService DataSetCategory16Code
    PartialDelegation IsoTrueFalseIndicator
    POISubset IsoMax35Text
    DelegationScopeIdentification IsoMax35Text
    DelegationScopeDefinition IsoMax3000Binary
    Certificate IsoMax10KBinary
}
MaintenanceDelegation13 *-- "0..1" MaintenanceDelegateAction7 : DelegatedAction
MaintenanceDelegation13 *-- "0..0" MaintenanceIdentificationAssociation1 : POIIdentificationAssociation
MaintenanceDelegation13 *-- "0..0" KEKIdentifier5 : SymmetricKey
MaintenanceDelegation13 *-- "0..1" AcceptorConfigurationDataSet3 : ParameterDataSet

MaintenanceDelegationRequest8 members

Member name Description Data Type / Multiplicity
TMIdentification Terminal manager identification. GenericIdentification176 - Required 1..1
MasterTMIdentification Master terminal manager identification. GenericIdentification176 - Optional 0..1
RequestedDelegation Information on the delegation of a maintenance action. MaintenanceDelegation13 - 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
%% ContentInformationType29 recursion level 0 with max 1
class ContentInformationType29{
    ContentType ContentType2Code
}
ContentInformationType29 *-- "0..1" AuthenticatedData8 : AuthenticatedData
ContentInformationType29 *-- "0..1" SignedData7 : SignedData
%% AuthenticatedData8 recursion level 1 with max 1
class AuthenticatedData8{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData8 *-- "1..0" IRecipient11Choice : Recipient
AuthenticatedData8 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData8 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData7 recursion level 1 with max 1
class SignedData7{
    Version IsoNumber
    Certificate IsoMax5000Binary
}
SignedData7 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData7 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData7 *-- "0..0" Signer6 : Signer

ContentInformationType29 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). AuthenticatedData8 - Optional 0..1
SignedData Data protected by a digital signatures. SignedData7 - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    MaintenanceDelegationRequestV08 --|> IOuterRecord : Implements
    MaintenanceDelegationRequestV08Document --|> IOuterDocument~MaintenanceDelegationRequestV08~ : Implements
    class IOuterDocument~MaintenanceDelegationRequestV08~ {
        MaintenanceDelegationRequestV08 Message
     }

Document wrapper for serialization

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

classDiagram
    MaintenanceDelegationRequestV08Document *-- MaintenanceDelegationRequestV08 : 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.08">
    <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="_Y3YAQU6pEeyGi9JAv6wq7Q"
  nextVersions="_FWjj0XPUEe2pK6udhxEaHA"
  previousVersion="_fVEn4Si-Eeurkfo6MpvKDA"
  name="MaintenanceDelegationRequestV08"
  definition="The MaintenanceDelegationRequest message is sent by a terminal manager to the master terminal manager to request delegation of maintenance functions or maintenance operation on the terminal estate managed by the master terminal manager."
  registrationStatus="Registered"
  messageSet="_fMW_Eb1vEeKoB-JG4saAMg_205458547"
  xmlTag="MntncDlgtnReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_Y3YAQ06pEeyGi9JAv6wq7Q"
    nextVersions="_FWjj03PUEe2pK6udhxEaHA"
    previousVersion="_fVEn4yi-Eeurkfo6MpvKDA"
    name="Header"
    definition="Information related to the protocol management."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Hdr"
    complexType="_ROuPdwuhEeqw5uEXxQ9H4g" />
  <messageBuildingBlock
    xmi:id="_Y3YARU6pEeyGi9JAv6wq7Q"
    nextVersions="_FWjj1XPUEe2pK6udhxEaHA"
    previousVersion="_fVEn5Si-Eeurkfo6MpvKDA"
    name="MaintenanceDelegationRequest"
    definition="Information related to the request of maintenance delegations."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MntncDlgtnReq"
    complexType="_OZycgU6oEeyGi9JAv6wq7Q" />
  <messageBuildingBlock
    xmi:id="_Y3YAR06pEeyGi9JAv6wq7Q"
    nextVersions="_FWjj13PUEe2pK6udhxEaHA"
    previousVersion="_fVEn5yi-Eeurkfo6MpvKDA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_uXF14VE1EeyApZmLzm74zA" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="005"
    flavour="001"
    version="08" />
</messageDefinition>

ISO Building Blocks

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