catm.002.001.05
Terminal maintenance actions to be performed by a point of interaction (POI).
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
%% ManagementPlanReplacementV05 recursion level 0 with max 0
ManagementPlanReplacementV05 *-- "1..1" Header27 : Header
ManagementPlanReplacementV05 *-- "1..1" ManagementPlan5 : ManagementPlan
ManagementPlanReplacementV05 *-- "0..1" ContentInformationType12 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Set of characteristics related to the transfer of the management plan. Set of characteristics related to the transfer of transactions. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header27 recursion level 0 with max 1
class Header27{
DownloadTransfer IsoTrueFalseIndicator
FormatVersion IsoMax6Text
ExchangeIdentification IsoNumber
CreationDateTime IsoISODateTime
}
Header27 *-- "1..1" GenericIdentification71 : InitiatingParty
Header27 *-- "0..1" GenericIdentification92 : RecipientParty
%% GenericIdentification71 recursion level 1 with max 1
class GenericIdentification71{
Identification IsoMax35Text
Type PartyType5Code
Issuer PartyType6Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification92 recursion level 1 with max 1
class GenericIdentification92{
Identification IsoMax35Text
Type PartyType5Code
Issuer PartyType6Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
GenericIdentification92 *-- "0..1" NetworkParameters5 : RemoteAccess
Header27 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. | GenericIdentification71 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the exchange. | GenericIdentification92 - Optional 0..1 |
ManagementPlan building block
Sequence of terminal maintenance actions to be performed by a point of interaction (POI). Sequence of terminal management actions to be performed by a point of interaction (POI). For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ManagementPlan5 recursion level 0 with max 1
ManagementPlan5 *-- "0..1" GenericIdentification71 : POIIdentification
ManagementPlan5 *-- "1..1" GenericIdentification71 : TerminalManagerIdentification
ManagementPlan5 *-- "1..1" TerminalManagementDataSet18 : DataSet
%% GenericIdentification71 recursion level 1 with max 1
class GenericIdentification71{
Identification IsoMax35Text
Type PartyType5Code
Issuer PartyType6Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification71 recursion level 1 with max 1
class GenericIdentification71{
Identification IsoMax35Text
Type PartyType5Code
Issuer PartyType6Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% TerminalManagementDataSet18 recursion level 1 with max 1
class TerminalManagementDataSet18{
SequenceCounter IsoMax9NumericText
}
TerminalManagementDataSet18 *-- "1..1" DataSetIdentification6 : Identification
TerminalManagementDataSet18 *-- "0..1" ManagementPlanContent5 : Content
ManagementPlan5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| POIIdentification | Identification of the point of interaction (POI) for terminal management. | GenericIdentification71 - Optional 0..1 |
| TerminalManagerIdentification | Identification of the terminal management system (TMS) sending the management plan. | GenericIdentification71 - Required 1..1 |
| DataSet | Data set related to the sequence of actions to be performed by a point of interaction (POI). | TerminalManagementDataSet18 - Required 1..1 |
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 ManagementPlanReplacementV05 implementation follows a specific implementaiton pattern. First of all, ManagementPlanReplacementV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ManagementPlanReplacementV05Document implements IOuterDocument. Because ManagementPlanReplacementV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ManagementPlanReplacementV05.
classDiagram
class IOuterRecord
ManagementPlanReplacementV05 --|> IOuterRecord : Implements
ManagementPlanReplacementV05Document --|> IOuterDocument~ManagementPlanReplacementV05~ : Implements
class IOuterDocument~ManagementPlanReplacementV05~ {
ManagementPlanReplacementV05 Message
}
Document wrapper for serialization
The only real purpose ManagementPlanReplacementV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catm.002.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ManagementPlanReplacementV05.ToDocument() method. The returned ManagementPlanReplacementV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ManagementPlanReplacementV05Document *-- ManagementPlanReplacementV05 : 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.002.001.05">
<MgmtPlanRplcmnt>
<Hdr>
<!-- Header inner content -->
</Hdr>
<MgmtPlan>
<!-- ManagementPlan inner content -->
</MgmtPlan>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</MgmtPlanRplcmnt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_OQCLwY3xEeWYyJ6P6VfQMg"
nextVersions="_CzZYcbC8EeamYaqfhG1ZuA"
previousVersion="_nKPkEWpNEeSR-ZWLvO-1dg"
name="ManagementPlanReplacementV05"
definition="Terminal maintenance actions to be performed by a point of interaction (POI)."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="MgmtPlanRplcmnt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_OQCLw43xEeWYyJ6P6VfQMg"
type="purpose" />
<messageBuildingBlock
xmi:id="_OQCLxY3xEeWYyJ6P6VfQMg"
nextVersions="_CzZYdbC8EeamYaqfhG1ZuA"
previousVersion="_nKPkFWpNEeSR-ZWLvO-1dg"
name="Header"
definition="Set of characteristics related to the transfer of the management plan."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_4lU_YY3bEeW32YMP0mBeyw" />
<messageBuildingBlock
xmi:id="_OQCLx43xEeWYyJ6P6VfQMg"
nextVersions="_CzZYd7C8EeamYaqfhG1ZuA"
previousVersion="_nKPkF2pNEeSR-ZWLvO-1dg"
name="ManagementPlan"
definition="Sequence of terminal maintenance actions to be performed by a point of interaction (POI)."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MgmtPlan"
complexType="_N1xKQY30EeWYyJ6P6VfQMg" />
<messageBuildingBlock
xmi:id="_OQCLyY3xEeWYyJ6P6VfQMg"
nextVersions="_CzZYebC8EeamYaqfhG1ZuA"
previousVersion="_nKPkGWpNEeSR-ZWLvO-1dg"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_PwIbYWmPEeS7iYydEtv3Ug" />
<messageDefinitionIdentifier
businessArea="catm"
messageFunctionality="002"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.