NetworkManagementInitiationV02

canm.001.001.02

The NetworkManagementlInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer) connected to a network. It covers the range of activities that control the operating conditions of the network.

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
%% NetworkManagementInitiationV02 recursion level 0 with max 0
NetworkManagementInitiationV02 *-- "1..1" Header43 : Header
NetworkManagementInitiationV02 *-- "1..1" NetworkManagementInitiation1 : Body
NetworkManagementInitiationV02 *-- "0..1" ContentInformationType20 : SecurityTrailer
  

Now, we will zero-in one-by-one on each of these building blocks.

Header building block

Information related to the management of the protocol. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header43 recursion level 0 with max 1
class Header43{
    MessageFunction MessageFunction23Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header43 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header43 *-- "1..1" GenericIdentification172 : InitiatingParty
Header43 *-- "0..1" GenericIdentification172 : RecipientParty
Header43 *-- "0..0" AdditionalData1 : TraceData
Header43 *-- "0..0" Traceability7 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
    CollectionIdentification IsoMax35Text
    BatchIdentification IsoMax35Text
    MessageSequenceNumber IsoMax15NumericText
    MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
    Type IsoMax35Text
    Value IsoMax2048Text
}
%% Traceability7 recursion level 1 with max 1
class Traceability7{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability7 *-- "1..1" GenericIdentification172 : RelayIdentification
  

Header43 members

Body building block

Information related to the reversal of an authorisation or financial transaction. Information related to network management services. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% NetworkManagementInitiation1 recursion level 0 with max 1
NetworkManagementInitiation1 *-- "0..1" Context8 : Context
NetworkManagementInitiation1 *-- "1..1" Transaction99 : Transaction
NetworkManagementInitiation1 *-- "0..1" ProcessingResult1 : ProcessingResult
NetworkManagementInitiation1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Context8 recursion level 1 with max 1
Context8 *-- "0..1" TransactionContext5 : TransactionContext
%% Transaction99 recursion level 1 with max 1
class Transaction99{
    NetworkManagementType NetworkManagementType1Code
    OtherNetworkManagementType IsoMax35Text
    MessageReason IsoExact4NumericText
    AlternateMessageReason IsoMax35Text
    NumberOfMessages IsoNumber
    MaximumNumberOfMessages IsoNumber
    TransactionDescription IsoMax1000Text
}
Transaction99 *-- "1..1" TransactionIdentification12 : TransactionIdentification
Transaction99 *-- "0..0" AdditionalFee1 : AdditionalFees
Transaction99 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult1 recursion level 1 with max 1
class ProcessingResult1{
    ActionRequired IsoYesNoIndicator
}
ProcessingResult1 *-- "0..1" ApprovalData1 : ApprovalData
ProcessingResult1 *-- "0..1" ResultData1 : ResultData
ProcessingResult1 *-- "0..1" ResultData1 : OriginalResultData
ProcessingResult1 *-- "0..0" Action9 : Action
ProcessingResult1 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult1 *-- "0..0" AdditionalInformation20 : AdditionalInformation
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

NetworkManagementInitiation1 members

SecurityTrailer building block

Trailer of the message containing a MAC General cryptographic message syntax (CMS) containing encrypted data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType20 recursion level 0 with max 1
class ContentInformationType20{
    MAC IsoMax8HexBinaryText
}
ContentInformationType20 *-- "1..1" MACData1 : MACData
%% MACData1 recursion level 1 with max 1
class MACData1{
    Control IsoExact1HexBinaryText
    KeySetIdentifier IsoMax8NumericText
    DerivedInformation IsoMax32HexBinaryText
    Algorithm IsoMax2NumericText
    KeyLength IsoMax4NumericText
    KeyProtection IsoMax2NumericText
    KeyIndex IsoMax5NumericText
    PaddingMethod IsoMax2NumericText
    InitialisationVector IsoMax32HexBinaryText
}
  

ContentInformationType20 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    NetworkManagementInitiationV02 --|> IOuterRecord : Implements
    NetworkManagementInitiationV02Document --|> IOuterDocument~NetworkManagementInitiationV02~ : Implements
    class IOuterDocument~NetworkManagementInitiationV02~ {
        NetworkManagementInitiationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    NetworkManagementInitiationV02Document *-- NetworkManagementInitiationV02 : 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:canm.001.001.02">
    <NtwkMgmtInitn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </NtwkMgmtInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_8PlKRVULEeetiruPyDPo0Q"
  nextVersions="_OANFUYv8EeumSPwlS1PkxQ"
  previousVersion="_C8o9QHvDEeSKFIcWw3l4Yw"
  name="NetworkManagementInitiationV02"
  definition="The NetworkManagementlInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer) connected to a network. It covers the range of activities that control the operating conditions of the network.&#xD;&#xD;&#xA;&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="NtwkMgmtInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_8PlKSFULEeetiruPyDPo0Q"
    nextVersions="_OANFU4v8EeumSPwlS1PkxQ"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_qBMuQVULEeetiruPyDPo0Q" />
  <messageBuildingBlock
    xmi:id="_8PlKSVULEeetiruPyDPo0Q"
    nextVersions="_OANFVYv8EeumSPwlS1PkxQ"
    name="Body"
    definition="Information related to the reversal of an authorisation or financial transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_hhfqsVWSEeeiG_nL4vgKnQ" />
  <messageBuildingBlock
    xmi:id="_8PlKR1ULEeetiruPyDPo0Q"
    nextVersions="_OANFV4v8EeumSPwlS1PkxQ"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="canm"
    messageFunctionality="001"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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