catm.005.001.02
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
%% MaintenanceDelegationRequestV02 recursion level 0 with max 0
MaintenanceDelegationRequestV02 *-- "0..1" Header29 : Header
MaintenanceDelegationRequestV02 *-- "1..1" MaintenanceDelegationRequest2 : MaintenanceDelegationRequest
MaintenanceDelegationRequestV02 *-- "1..1" ContentInformationType12 : 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
%% MaintenanceDelegationRequest2 recursion level 0 with max 1
MaintenanceDelegationRequest2 *-- "1..1" GenericIdentification72 : TMIdentification
MaintenanceDelegationRequest2 *-- "0..1" GenericIdentification72 : MasterTMIdentification
MaintenanceDelegationRequest2 *-- "1..0" MaintenanceDelegation3 : 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
}
%% MaintenanceDelegation3 recursion level 1 with max 1
class MaintenanceDelegation3{
DelegationType TerminalManagementAction3Code
MaintenanceService DataSetCategory11Code
PartialDelegation IsoTrueFalseIndicator
POISubset IsoMax35Text
DelegationScopeIdentification IsoMax35Text
DelegationScopeDefinition IsoMax3000Binary
Certificate IsoMax10KBinary
}
MaintenanceDelegation3 *-- "0..1" MaintenanceDelegateAction2 : DelegatedAction
MaintenanceDelegation3 *-- "0..0" MaintenanceIdentificationAssociation1 : POIIdentificationAssociation
MaintenanceDelegation3 *-- "0..0" KEKIdentifier5 : SymmetricKey
MaintenanceDelegation3 *-- "0..1" TerminalManagementDataSet19 : ParameterDataSet
MaintenanceDelegationRequest2 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. | MaintenanceDelegation3 - Unknown 1..0 |
SecurityTrailer building block
Trailer of the message containing a MAC or a digital signature. General cryptographic message syntax (CMS) containing protected data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType12 recursion level 0 with max 1
class ContentInformationType12{
ContentType ContentType2Code
}
ContentInformationType12 *-- "0..1" EnvelopedData4 : EnvelopedData
ContentInformationType12 *-- "0..1" AuthenticatedData4 : AuthenticatedData
ContentInformationType12 *-- "0..1" SignedData4 : SignedData
ContentInformationType12 *-- "0..1" DigestedData4 : DigestedData
%% EnvelopedData4 recursion level 1 with max 1
class EnvelopedData4{
Version IsoNumber
}
EnvelopedData4 *-- "1..0" IRecipient4Choice : Recipient
EnvelopedData4 *-- "0..1" EncryptedContent3 : EncryptedContent
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData4 recursion level 1 with max 1
class SignedData4{
Version IsoNumber
Certificate IsoMax5000Binary
}
SignedData4 *-- "1..0" AlgorithmIdentification16 : DigestAlgorithm
SignedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
SignedData4 *-- "1..0" Signer3 : Signer
%% DigestedData4 recursion level 1 with max 1
class DigestedData4{
Version IsoNumber
Digest IsoMax140Binary
}
DigestedData4 *-- "1..1" AlgorithmIdentification16 : DigestAlgorithm
DigestedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType12 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| EnvelopedData | Data protection by encryption, with a session key. | EnvelopedData4 - Optional 0..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData4 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData4 - Optional 0..1 |
| DigestedData | Data protected by a digest. | DigestedData4 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the MaintenanceDelegationRequestV02 implementation follows a specific implementaiton pattern. First of all, MaintenanceDelegationRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, MaintenanceDelegationRequestV02Document implements IOuterDocument. Because MaintenanceDelegationRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type MaintenanceDelegationRequestV02.
classDiagram
class IOuterRecord
MaintenanceDelegationRequestV02 --|> IOuterRecord : Implements
MaintenanceDelegationRequestV02Document --|> IOuterDocument~MaintenanceDelegationRequestV02~ : Implements
class IOuterDocument~MaintenanceDelegationRequestV02~ {
MaintenanceDelegationRequestV02 Message
}
Document wrapper for serialization
The only real purpose MaintenanceDelegationRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catm.005.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using MaintenanceDelegationRequestV02.ToDocument() method. The returned MaintenanceDelegationRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
MaintenanceDelegationRequestV02Document *-- MaintenanceDelegationRequestV02 : 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.02">
<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="_u2Rq4Y4BEeWrZqsymMFdfg"
nextVersions="_SGd8IbAHEeah1_v59tW6Rg"
previousVersion="_RRRwEGp2EeSojYXQbRlLzA"
name="MaintenanceDelegationRequestV02"
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="_u2Rq444BEeWrZqsymMFdfg"
nextVersions="_SGejMbAHEeah1_v59tW6Rg"
previousVersion="_825hIGp2EeSojYXQbRlLzA"
name="Header"
definition="Information related to the protocol management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="Hdr"
complexType="_RtBnUY4CEeWrZqsymMFdfg" />
<messageBuildingBlock
xmi:id="_u2Rq5Y4BEeWrZqsymMFdfg"
nextVersions="_SGejM7AHEeah1_v59tW6Rg"
previousVersion="_jVQoAGp4EeSojYXQbRlLzA"
name="MaintenanceDelegationRequest"
definition="Information related to the request of maintenance delegations."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MntncDlgtnReq"
complexType="_svUwAY4CEeWrZqsymMFdfg" />
<messageBuildingBlock
xmi:id="_u2Rq544BEeWrZqsymMFdfg"
nextVersions="_SGejNbAHEeah1_v59tW6Rg"
previousVersion="_xgIyUGp4EeSojYXQbRlLzA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_PwIbYWmPEeS7iYydEtv3Ug" />
<messageDefinitionIdentifier
businessArea="catm"
messageFunctionality="005"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.