ManagementPlanReplacementV02

catm.002.001.02

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
%% ManagementPlanReplacementV02 recursion level 0 with max 0
ManagementPlanReplacementV02 *-- "1..1" Header4 : Header
ManagementPlanReplacementV02 *-- "1..1" ManagementPlan2 : ManagementPlan
ManagementPlanReplacementV02 *-- "1..1" ContentInformationType4 : 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
%% Header4 recursion level 0 with max 1
class Header4{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header4 *-- "1..1" GenericIdentification35 : InitiatingParty
Header4 *-- "0..1" GenericIdentification35 : RecipientParty
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}
  

Header4 members

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
%% ManagementPlan2 recursion level 0 with max 1
ManagementPlan2 *-- "0..1" GenericIdentification35 : POIIdentification
ManagementPlan2 *-- "1..1" GenericIdentification35 : TerminalManagerIdentification
ManagementPlan2 *-- "1..0" TerminalManagementDataSet5 : DataSet
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}
%% GenericIdentification35 recursion level 1 with max 1
class GenericIdentification35{
    Identification IsoMax35Text
    Type PartyType5Code
    Issuer PartyType6Code
    ShortName IsoMax35Text
}
%% TerminalManagementDataSet5 recursion level 1 with max 1
class TerminalManagementDataSet5{
    SequenceCounter IsoMax9NumericText
}
TerminalManagementDataSet5 *-- "1..1" DataSetIdentification3 : Identification
TerminalManagementDataSet5 *-- "0..1" ManagementPlanContent2 : Content
  

ManagementPlan2 members

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
%% ContentInformationType4 recursion level 0 with max 1
class ContentInformationType4{
    ContentType ContentType1Code
}
ContentInformationType4 *-- "0..1" EnvelopedData2 : EnvelopedData
ContentInformationType4 *-- "0..1" AuthenticatedData2 : AuthenticatedData
ContentInformationType4 *-- "0..1" SignedData2 : SignedData
ContentInformationType4 *-- "0..1" DigestedData2 : DigestedData
ContentInformationType4 *-- "0..1" NamedKeyEncryptedData2 : NamedKeyEncryptedData
%% EnvelopedData2 recursion level 1 with max 1
class EnvelopedData2{
    Version IsoNumber
}
EnvelopedData2 *-- "1..0" IRecipient2Choice : Recipient
EnvelopedData2 *-- "1..1" EncryptedContent2 : EncryptedContent
%% AuthenticatedData2 recursion level 1 with max 1
class AuthenticatedData2{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData2 *-- "1..0" IRecipient2Choice : Recipient
AuthenticatedData2 *-- "1..1" AlgorithmIdentification3 : MACAlgorithm
AuthenticatedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% SignedData2 recursion level 1 with max 1
class SignedData2{
    Version IsoNumber
    Certificate IsoMax3000Binary
}
SignedData2 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
SignedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
SignedData2 *-- "1..0" Signer2 : Signer
%% DigestedData2 recursion level 1 with max 1
class DigestedData2{
    Version IsoNumber
    Digest IsoMax140Text
}
DigestedData2 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
DigestedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% NamedKeyEncryptedData2 recursion level 1 with max 1
class NamedKeyEncryptedData2{
    Version IsoNumber
    KeyName IsoMax140Text
}
NamedKeyEncryptedData2 *-- "1..1" EncryptedContent2 : EncryptedContent
  

ContentInformationType4 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ManagementPlanReplacementV02 --|> IOuterRecord : Implements
    ManagementPlanReplacementV02Document --|> IOuterDocument~ManagementPlanReplacementV02~ : Implements
    class IOuterDocument~ManagementPlanReplacementV02~ {
        ManagementPlanReplacementV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ManagementPlanReplacementV02Document *-- ManagementPlanReplacementV02 : 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.02">
    <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="_R27DMQvfEeK9Xewg3qiFQA"
  nextVersions="_sO3hwTWBEeODSIIQsYYKhw"
  previousVersion="_-jWs8OQWEeCGktPI9k4Dlw_-1818503267"
  name="ManagementPlanReplacementV02"
  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">
  <messageBuildingBlock
    xmi:id="_R27DMwvfEeK9Xewg3qiFQA"
    nextVersions="_sO3hwzWBEeODSIIQsYYKhw"
    name="Header"
    definition="Set of characteristics related to the transfer of the management plan."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_K8wSNn1DEeCF8NjrBemJWQ_469587146" />
  <messageBuildingBlock
    xmi:id="_R27DNwvfEeK9Xewg3qiFQA"
    nextVersions="_sO3hxTWBEeODSIIQsYYKhw"
    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="_4emF8R3aEeKKrOIoqWglDw" />
  <messageBuildingBlock
    xmi:id="_R27DOwvfEeK9Xewg3qiFQA"
    nextVersions="_sO3hxzWBEeODSIIQsYYKhw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_lLfC8QvFEeKzJ69IWwzB9Q" />
  <messageDefinitionIdentifier
    businessArea="catm"
    messageFunctionality="002"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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