catm.002.001.09
The ManagementPlanReplacement message is sent by a terminal manager to a POI to set maintenance actions to be performed.
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
%% ManagementPlanReplacementV09 recursion level 0 with max 0
ManagementPlanReplacementV09 *-- "1..1" TMSHeader1 : Header
ManagementPlanReplacementV09 *-- "1..1" ManagementPlan9 : ManagementPlan
ManagementPlanReplacementV09 *-- "0..1" ContentInformationType25 : 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
%% 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 |
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
%% ManagementPlan9 recursion level 0 with max 1
ManagementPlan9 *-- "0..1" GenericIdentification176 : POIIdentification
ManagementPlan9 *-- "1..1" GenericIdentification176 : TerminalManagerIdentification
ManagementPlan9 *-- "1..1" TerminalManagementDataSet30 : DataSet
%% 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
}
%% TerminalManagementDataSet30 recursion level 1 with max 1
class TerminalManagementDataSet30{
SequenceCounter IsoMax9NumericText
LastSequence IsoTrueFalseIndicator
}
TerminalManagementDataSet30 *-- "1..1" DataSetIdentification8 : Identification
TerminalManagementDataSet30 *-- "0..1" ManagementPlanContent9 : Content
ManagementPlan9 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| POIIdentification | Identification of the point of interaction (POI) for terminal management. | GenericIdentification176 - Optional 0..1 |
| TerminalManagerIdentification | Identification of the terminal management system (TMS) sending the management plan. | GenericIdentification176 - Required 1..1 |
| DataSet | Data set related to the sequence of actions to be performed by a point of interaction (POI). | TerminalManagementDataSet30 - Required 1..1 |
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
%% ContentInformationType25 recursion level 0 with max 1
class ContentInformationType25{
ContentType ContentType2Code
}
ContentInformationType25 *-- "0..1" AuthenticatedData7 : AuthenticatedData
ContentInformationType25 *-- "0..1" SignedData6 : SignedData
%% AuthenticatedData7 recursion level 1 with max 1
class AuthenticatedData7{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData7 *-- "1..0" IRecipient10Choice : Recipient
AuthenticatedData7 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData7 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData6 recursion level 1 with max 1
class SignedData6{
Version IsoNumber
Certificate IsoMax5000Binary
}
SignedData6 *-- "0..0" AlgorithmIdentification21 : DigestAlgorithm
SignedData6 *-- "0..1" EncapsulatedContent3 : EncapsulatedContent
SignedData6 *-- "0..0" Signer5 : Signer
ContentInformationType25 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). | AuthenticatedData7 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData6 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the ManagementPlanReplacementV09 implementation follows a specific implementaiton pattern. First of all, ManagementPlanReplacementV09 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ManagementPlanReplacementV09Document implements IOuterDocument. Because ManagementPlanReplacementV09 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ManagementPlanReplacementV09.
classDiagram
class IOuterRecord
ManagementPlanReplacementV09 --|> IOuterRecord : Implements
ManagementPlanReplacementV09Document --|> IOuterDocument~ManagementPlanReplacementV09~ : Implements
class IOuterDocument~ManagementPlanReplacementV09~ {
ManagementPlanReplacementV09 Message
}
Document wrapper for serialization
The only real purpose ManagementPlanReplacementV09Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:catm.002.001.09’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ManagementPlanReplacementV09.ToDocument() method. The returned ManagementPlanReplacementV09Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ManagementPlanReplacementV09Document *-- ManagementPlanReplacementV09 : 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.09">
<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="_vWfH8Si8Eeurkfo6MpvKDA"
nextVersions="_YbeR8U6qEeyGi9JAv6wq7Q"
previousVersion="_BegL8Q02EeqUVL7sB4m7NA"
name="ManagementPlanReplacementV09"
definition="The ManagementPlanReplacement message is sent by a terminal manager to a POI to set maintenance actions to be performed."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="MgmtPlanRplcmnt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_vWfH8yi8Eeurkfo6MpvKDA"
type="purpose" />
<messageBuildingBlock
xmi:id="_vWfH9Si8Eeurkfo6MpvKDA"
nextVersions="_YbeR9U6qEeyGi9JAv6wq7Q"
previousVersion="_BegL9Q02EeqUVL7sB4m7NA"
name="Header"
definition="Set of characteristics related to the transfer of the management plan."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_ROuPdwuhEeqw5uEXxQ9H4g" />
<messageBuildingBlock
xmi:id="_vWfH9yi8Eeurkfo6MpvKDA"
nextVersions="_YbeR906qEeyGi9JAv6wq7Q"
previousVersion="_BegL9w02EeqUVL7sB4m7NA"
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="_VscLoSi8Eeurkfo6MpvKDA" />
<messageBuildingBlock
xmi:id="_vWfH-Si8Eeurkfo6MpvKDA"
nextVersions="_YbeR-U6qEeyGi9JAv6wq7Q"
previousVersion="_BegL-Q02EeqUVL7sB4m7NA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_kWoPYS8jEeu125Ip9zFcsQ" />
<messageDefinitionIdentifier
businessArea="catm"
messageFunctionality="002"
flavour="001"
version="09" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.