NetworkManagementInitiationV03

canm.001.001.03

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
%% NetworkManagementInitiationV03 recursion level 0 with max 0
NetworkManagementInitiationV03 *-- "1..1" Header63 : Header
NetworkManagementInitiationV03 *-- "1..1" NetworkManagementInitiation2 : Body
NetworkManagementInitiationV03 *-- "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
%% Header63 recursion level 0 with max 1
class Header63{
    MessageFunction MessageFunction23Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header63 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header63 *-- "1..1" GenericIdentification183 : InitiatingParty
Header63 *-- "0..1" GenericIdentification183 : RecipientParty
Header63 *-- "0..0" AdditionalData1 : TraceData
Header63 *-- "0..0" Traceability9 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
    CollectionIdentification IsoMax35Text
    BatchIdentification IsoMax35Text
    MessageSequenceNumber IsoMax15NumericText
    MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country ISOMax3ACountryCode
    ShortName IsoMax35Text
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country ISOMax3ACountryCode
    ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
    Type IsoMax35Text
    Value IsoMax2048Text
}
%% Traceability9 recursion level 1 with max 1
class Traceability9{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability9 *-- "1..1" GenericIdentification183 : RelayIdentification
  

Header63 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
%% NetworkManagementInitiation2 recursion level 0 with max 1
NetworkManagementInitiation2 *-- "0..1" Context17 : Context
NetworkManagementInitiation2 *-- "1..1" Transaction134 : Transaction
NetworkManagementInitiation2 *-- "0..1" ProcessingResult16 : ProcessingResult
NetworkManagementInitiation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction134 recursion level 1 with max 1
class Transaction134{
    NetworkManagementType NetworkManagementType1Code
    OtherNetworkManagementType IsoMax35Text
    MessageReason ISO8583MessageReasonCode
    AlternateMessageReason IsoMax256Text
    NumberOfMessages IsoNumber
    MaximumNumberOfMessages IsoNumber
    TransactionDescription IsoMax1000Text
}
Transaction134 *-- "1..1" TransactionIdentification12 : TransactionIdentification
Transaction134 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction134 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult16 recursion level 1 with max 1
class ProcessingResult16{
    ApprovalCode IsoExact6AlphaNumericText
    ActionRequired IsoYesNoIndicator
}
ProcessingResult16 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult16 *-- "0..1" ResultData7 : ResultData
ProcessingResult16 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult16 *-- "0..0" Action13 : Action
ProcessingResult16 *-- "0..0" AdditionalAction1 : AdditionalAction
ProcessingResult16 *-- "0..0" AdditionalInformation29 : AdditionalInformation
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

NetworkManagementInitiation2 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 NetworkManagementInitiationV03 implementation follows a specific implementaiton pattern. First of all, NetworkManagementInitiationV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, NetworkManagementInitiationV03Document implements IOuterDocument. Because NetworkManagementInitiationV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type NetworkManagementInitiationV03.

classDiagram
    class IOuterRecord
    NetworkManagementInitiationV03 --|> IOuterRecord : Implements
    NetworkManagementInitiationV03Document --|> IOuterDocument~NetworkManagementInitiationV03~ : Implements
    class IOuterDocument~NetworkManagementInitiationV03~ {
        NetworkManagementInitiationV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    NetworkManagementInitiationV03Document *-- NetworkManagementInitiationV03 : 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.03">
    <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="_OANFUYv8EeumSPwlS1PkxQ"
  previousVersion="_8PlKRVULEeetiruPyDPo0Q"
  name="NetworkManagementInitiationV03"
  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="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="NtwkMgmtInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_OANFU4v8EeumSPwlS1PkxQ"
    previousVersion="_8PlKSFULEeetiruPyDPo0Q"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_pKuBkRvVEey2RdTw-AkXzg" />
  <messageBuildingBlock
    xmi:id="_OANFVYv8EeumSPwlS1PkxQ"
    previousVersion="_8PlKSVULEeetiruPyDPo0Q"
    name="Body"
    definition="Information related to the reversal of an authorisation or financial transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_9m_bMYv7EeumSPwlS1PkxQ" />
  <messageBuildingBlock
    xmi:id="_OANFV4v8EeumSPwlS1PkxQ"
    previousVersion="_8PlKR1ULEeetiruPyDPo0Q"
    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="03" />
</messageDefinition>

ISO Building Blocks

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