Iso20022

StatusReportV05

catm.001.001.05

Informs the master terminal manager (MTM) or the terminal manager (TM) about the status of the acceptor system including the identification of the POI, its components and their installed versions.

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
%% StatusReportV05 recursion level 0 with max 0
StatusReportV05 *-- "1..1" Header27 : Header
StatusReportV05 *-- "1..1" StatusReport5 : StatusReport
StatusReportV05 *-- "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 status report. 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

StatusReport building block

Status of the point of interaction (POI), its components and their installed versions. Status of the acceptor system containing the identification of the POI (Point Of Interaction), its components and their installed versions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% StatusReport5 recursion level 0 with max 1
StatusReport5 *-- "1..1" GenericIdentification71 : POIIdentification
StatusReport5 *-- "1..1" GenericIdentification71 : TerminalManagerIdentification
StatusReport5 *-- "1..1" TerminalManagementDataSet16 : 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
}
%% TerminalManagementDataSet16 recursion level 1 with max 1
class TerminalManagementDataSet16{
    SequenceCounter IsoMax9NumericText
}
TerminalManagementDataSet16 *-- "1..1" DataSetIdentification6 : Identification
TerminalManagementDataSet16 *-- "1..1" StatusReportContent5 : Content

StatusReport5 members

Member name Description Data Type / Multiplicity
POIIdentification Identification of the point of interaction for terminal management. GenericIdentification71 - Required 1..1
TerminalManagerIdentification Identification of the terminal management system (TMS) to contact for the maintenance. GenericIdentification71 - Required 1..1
DataSet Data related to a status report of a point of interaction (POI). TerminalManagementDataSet16 - 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 StatusReportV05 implementation follows a specific implementaiton pattern. First of all, StatusReportV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, StatusReportV05Document implements IOuterDocument. Because StatusReportV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type StatusReportV05.

classDiagram
    class IOuterRecord
    StatusReportV05 --|> IOuterRecord : Implements
    StatusReportV05Document --|> IOuterDocument~StatusReportV05~ : Implements
    class IOuterDocument~StatusReportV05~ {
        StatusReportV05 Message
     }

Document wrapper for serialization

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

classDiagram
    StatusReportV05Document *-- StatusReportV05 : 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.001.001.05">
    <StsRpt>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <StsRpt>
            <!-- StatusReport inner content -->
        </StsRpt>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </StsRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_XnwLEY3bEeW56qaqQ8B0kQ"
  nextVersions="_QXS6wbCaEeapjPTKZHuM2w"
  previousVersion="_aFhi0WpIEeSxBNa3WmxpmQ"
  name="StatusReportV05"
  definition="Informs the master terminal manager (MTM) or the terminal manager (TM) about the status of the acceptor system including the identification of the POI, its components and their installed versions."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="StsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_XnwLE43bEeW56qaqQ8B0kQ"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_XnwLFY3bEeW56qaqQ8B0kQ"
    nextVersions="_QXS6xbCaEeapjPTKZHuM2w"
    previousVersion="_aFhi1WpIEeSxBNa3WmxpmQ"
    name="Header"
    definition="Set of characteristics related to the transfer of the status report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_4lU_YY3bEeW32YMP0mBeyw" />
  <messageBuildingBlock
    xmi:id="_XnwLF43bEeW56qaqQ8B0kQ"
    nextVersions="_QXS6x7CaEeapjPTKZHuM2w"
    previousVersion="_aFhi12pIEeSxBNa3WmxpmQ"
    name="StatusReport"
    definition="Status of the point of interaction (POI), its components and their installed versions."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="StsRpt"
    complexType="_XM0tIY3cEeW32YMP0mBeyw" />
  <messageBuildingBlock
    xmi:id="_XnwLGY3bEeW56qaqQ8B0kQ"
    nextVersions="_QXS6ybCaEeapjPTKZHuM2w"
    previousVersion="_aFhi2WpIEeSxBNa3WmxpmQ"
    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="001"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

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