catm.005.001.09
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
%% MaintenanceDelegationRequestV09 recursion level 0 with max 0
MaintenanceDelegationRequestV09 *-- "0..1" TMSHeader1 : Header
MaintenanceDelegationRequestV09 *-- "1..1" MaintenanceDelegationRequest9 : MaintenanceDelegationRequest
MaintenanceDelegationRequestV09 *-- "1..1" ContentInformationType33 : 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
%% MaintenanceDelegationRequest9 recursion level 0 with max 1
class MaintenanceDelegationRequest9{
TMDateTime IsoISODateTime
TMChallengeValue IsoMax140Binary
}
MaintenanceDelegationRequest9 *-- "1..1" GenericIdentification176 : TMIdentification
MaintenanceDelegationRequest9 *-- "0..1" GenericIdentification176 : MasterTMIdentification
MaintenanceDelegationRequest9 *-- "1..0" MaintenanceDelegation15 : 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
}
%% MaintenanceDelegation15 recursion level 1 with max 1
class MaintenanceDelegation15{
DelegationType TerminalManagementAction3Code
MaintenanceService DataSetCategory16Code
PartialDelegation IsoTrueFalseIndicator
POISubset IsoMax35Text
DelegationScopeIdentification IsoMax35Text
DelegationScopeDefinition IsoMax3000Binary
Certificate IsoMax10KBinary
}
MaintenanceDelegation15 *-- "0..1" MaintenanceDelegateAction8 : DelegatedAction
MaintenanceDelegation15 *-- "0..0" MaintenanceIdentificationAssociation1 : POIIdentificationAssociation
MaintenanceDelegation15 *-- "0..0" KEKIdentifier5 : SymmetricKey
MaintenanceDelegation15 *-- "0..1" AcceptorConfigurationDataSet4 : ParameterDataSet
MaintenanceDelegationRequest9 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| TMIdentification | Terminal manager identification. | GenericIdentification176 - Required 1..1 |
| MasterTMIdentification | Master terminal manager identification. | GenericIdentification176 - Optional 0..1 |
| TMDateTime | Date and Time of the TMS. | IsoISODateTime - Required 1..1 |
| TMChallengeValue | Challenge value sends by the POI to be received back in a message response. | IsoMax140Binary - Required 1..1 |
| RequestedDelegation | Information on the delegation of a maintenance action. | MaintenanceDelegation15 - 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
%% ContentInformationType33 recursion level 0 with max 1
class ContentInformationType33{
ContentType ContentType2Code
}
ContentInformationType33 *-- "0..1" AuthenticatedData9 : AuthenticatedData
ContentInformationType33 *-- "0..1" SignedData8 : SignedData
%% AuthenticatedData9 recursion level 1 with max 1
class AuthenticatedData9{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData9 *-- "1..0" IRecipient14Choice : Recipient
AuthenticatedData9 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData9 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData8 recursion level 1 with max 1
class SignedData8{
Version IsoNumber
Certificate IsoMax5000Binary
}
SignedData8 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData8 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData8 *-- "0..0" Signer7 : Signer
ContentInformationType33 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). | AuthenticatedData9 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData8 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the MaintenanceDelegationRequestV09 implementation follows a specific implementaiton pattern. First of all, MaintenanceDelegationRequestV09 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, MaintenanceDelegationRequestV09Document implements IOuterDocument. Because MaintenanceDelegationRequestV09 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type MaintenanceDelegationRequestV09.
classDiagram
class IOuterRecord
MaintenanceDelegationRequestV09 --|> IOuterRecord : Implements
MaintenanceDelegationRequestV09Document --|> IOuterDocument~MaintenanceDelegationRequestV09~ : Implements
class IOuterDocument~MaintenanceDelegationRequestV09~ {
MaintenanceDelegationRequestV09 Message
}
Document wrapper for serialization
The only real purpose MaintenanceDelegationRequestV09Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catm.005.001.09’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using MaintenanceDelegationRequestV09.ToDocument() method. The returned MaintenanceDelegationRequestV09Document value will serialize correctly according to ISO 20022 standards.
classDiagram
MaintenanceDelegationRequestV09Document *-- MaintenanceDelegationRequestV09 : 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.09">
<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="_FWjj0XPUEe2pK6udhxEaHA"
previousVersion="_Y3YAQU6pEeyGi9JAv6wq7Q"
name="MaintenanceDelegationRequestV09"
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="_WYMCwJVPEeO6Q83g-JIX_w"
xmlTag="MntncDlgtnReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_FWjj03PUEe2pK6udhxEaHA"
previousVersion="_Y3YAQ06pEeyGi9JAv6wq7Q"
name="Header"
definition="Information related to the protocol management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="Hdr"
complexType="_ROuPdwuhEeqw5uEXxQ9H4g" />
<messageBuildingBlock
xmi:id="_FWjj1XPUEe2pK6udhxEaHA"
previousVersion="_Y3YARU6pEeyGi9JAv6wq7Q"
name="MaintenanceDelegationRequest"
definition="Information related to the request of maintenance delegations."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MntncDlgtnReq"
complexType="_z6jy4XJmEe299ZbWCkdR_w" />
<messageBuildingBlock
xmi:id="_FWjj13PUEe2pK6udhxEaHA"
previousVersion="_Y3YAR06pEeyGi9JAv6wq7Q"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_sqC0wXDIEe2MCaKO5AtGsA" />
<messageDefinitionIdentifier
businessArea="catm"
messageFunctionality="005"
flavour="001"
version="09" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.