Iso20022

ATMDeviceReportV01

caam.001.001.01

The ATMDeviceReport message is sent to an acquirer by an ATM, or forwarded by an agent, to report:

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
%% ATMDeviceReportV01 recursion level 0 with max 0
ATMDeviceReportV01 *-- "1..1" Header20 : Header
ATMDeviceReportV01 *-- "0..1" ContentInformationType10 : ProtectedATMDeviceReport
ATMDeviceReportV01 *-- "0..1" ATMDeviceReport1 : ATMDeviceReport
ATMDeviceReportV01 *-- "0..1" ContentInformationType13 : SecurityTrailer

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

Header building block

Information related to the protocol management on a segment of the path from the ATM to the acquirer. Information related to the protocol management on a segment of the path from the ATM to the acquirer. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header20 recursion level 0 with max 1
class Header20{
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
    InitiatingParty IsoMax35Text
    RecipientParty IsoMax35Text
    ProcessState IsoMax35Text
}
Header20 *-- "1..1" ATMMessageFunction1 : MessageFunction
Header20 *-- "0..0" Traceability4 : Traceability
%% ATMMessageFunction1 recursion level 1 with max 1
class ATMMessageFunction1{
    Function MessageFunction7Code
    ATMServiceCode IsoMax35Text
    HostServiceCode IsoMax35Text
}
%% Traceability4 recursion level 1 with max 1
class Traceability4{
    SequenceNumber IsoMax35Text
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability4 *-- "1..1" GenericIdentification77 : RelayIdentification

Header20 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. ATMMessageFunction1 - Required 1..1
ProtocolVersion Version of the ATM protocol specifications. IsoMax6Text - Required 1..1
ExchangeIdentification Unique identification of an exchange occurrence. IsoMax3NumericText - Required 1..1
CreationDateTime Date and time at which the message was created. IsoISODateTime - Required 1..1
InitiatingParty Unique identification of the partner that has initiated the exchange. IsoMax35Text - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the message exchange. IsoMax35Text - Optional 0..1
ProcessState State of the sender of the message inside the process flow. IsoMax35Text - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability4 - Unknown 0..0

ProtectedATMDeviceReport building block

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

classDiagram
   direction tb
%% ContentInformationType10 recursion level 0 with max 1
class ContentInformationType10{
    ContentType ContentType2Code
}
ContentInformationType10 *-- "1..1" EnvelopedData4 : EnvelopedData
%% EnvelopedData4 recursion level 1 with max 1
class EnvelopedData4{
    Version IsoNumber
}
EnvelopedData4 *-- "1..0" IRecipient4Choice : Recipient
EnvelopedData4 *-- "0..1" EncryptedContent3 : EncryptedContent

ContentInformationType10 members

Member name Description Data Type / Multiplicity
ContentType Type of data protection. ContentType2Code - Required 1..1
EnvelopedData Data protection by encryption or by a digital envelope, with an encryption key. EnvelopedData4 - Required 1..1

ATMDeviceReport building block

Information related to the status report from an ATM device. Information related to the report from an ATM device. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ATMDeviceReport1 recursion level 0 with max 1
ATMDeviceReport1 *-- "1..1" ATMEnvironment6 : Environment
ATMDeviceReport1 *-- "1..1" ATMStatus1 : ATMGlobalStatus
ATMDeviceReport1 *-- "0..0" ATMCommand2 : CommandResult
ATMDeviceReport1 *-- "0..1" ATMCommand3 : CommandContext
ATMDeviceReport1 *-- "0..1" ATMSecurityContext1 : ATMSecurityContext
%% ATMEnvironment6 recursion level 1 with max 1
class ATMEnvironment6{
    ATMManagerIdentification IsoMax35Text
}
ATMEnvironment6 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment6 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment6 *-- "1..1" AutomatedTellerMachine5 : ATM
%% ATMStatus1 recursion level 1 with max 1
class ATMStatus1{
    CurrentStatus ATMStatus1Code
    DemandedStatus ATMStatus1Code
}
%% ATMCommand2 recursion level 1 with max 1
class ATMCommand2{
    Type ATMCommand2Code
    RequiredDateTime IsoISODateTime
    ProcessedDateTime IsoISODateTime
    Result TerminalManagementActionResult2Code
    AdditionalErrorInformation IsoMax140Text
}
ATMCommand2 *-- "0..1" ATMCommandIdentification1 : CommandIdentification
%% ATMCommand3 recursion level 1 with max 1
class ATMCommand3{
    Type ATMCommand2Code
}
ATMCommand3 *-- "0..1" ATMCommandIdentification1 : CommandIdentification
%% ATMSecurityContext1 recursion level 1 with max 1
class ATMSecurityContext1{
    CurrentSecurityScheme ATMSecurityScheme1Code
    SecuritySchemeCapabilities ATMSecurityScheme2Code
    HostChallenge IsoMax140Binary
}
ATMSecurityContext1 *-- "1..1" ATMSecurityDevice1 : SecurityDevice
ATMSecurityContext1 *-- "0..0" CryptographicKey7 : Key

ATMDeviceReport1 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. ATMEnvironment6 - Required 1..1
ATMGlobalStatus Global status of the ATM. ATMStatus1 - Required 1..1
CommandResult Result of a maintenance command performed by the ATM. ATMCommand2 - Unknown 0..0
CommandContext Maintenance command which has requested the device report. ATMCommand3 - Optional 0..1
ATMSecurityContext Information related to security commands. ATMSecurityContext1 - Optional 0..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
%% ContentInformationType13 recursion level 0 with max 1
class ContentInformationType13{
    ContentType ContentType2Code
}
ContentInformationType13 *-- "0..1" AuthenticatedData4 : AuthenticatedData
ContentInformationType13 *-- "0..1" SignedData4 : SignedData
%% 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

ContentInformationType13 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). AuthenticatedData4 - Optional 0..1
SignedData Data protected by a digital signatures. SignedData4 - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ATMDeviceReportV01 --|> IOuterRecord : Implements
    ATMDeviceReportV01Document --|> IOuterDocument~ATMDeviceReportV01~ : Implements
    class IOuterDocument~ATMDeviceReportV01~ {
        ATMDeviceReportV01 Message
     }

Document wrapper for serialization

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

classDiagram
    ATMDeviceReportV01Document *-- ATMDeviceReportV01 : 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:caam.001.001.01">
    <ATMDvcRpt>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <PrtctdATMDvcRpt>
            <!-- ProtectedATMDeviceReport inner content -->
        </PrtctdATMDvcRpt>
        <ATMDvcRpt>
            <!-- ATMDeviceReport inner content -->
        </ATMDvcRpt>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </ATMDvcRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_it_dUIrdEeSvuOJS0mmL0g"
  nextVersions="_TCtnca45EeWRfYPBaeOY8w"
  name="ATMDeviceReportV01"
  definition="The ATMDeviceReport message is sent to an acquirer by an ATM, or forwarded by an agent, to report:&#xD;&#xA;- The result of maintenance commands performed by the ATM,&#xD;&#xA;- The components of the ATM,&#xD;&#xA;- The status of the ATM components."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="ATMDvcRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_uqzNkIrdEeSvuOJS0mmL0g"
    name="Header"
    definition="Information related to the protocol management on a segment of the path from the ATM to the acquirer."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_47_isYnvEeS9F4Qrq_eaVA" />
  <messageBuildingBlock
    xmi:id="_CdjmYIreEeSvuOJS0mmL0g"
    name="ProtectedATMDeviceReport"
    definition="Encrypted body of the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrtctdATMDvcRpt"
    complexType="_UfeMUWizEeS87LmvcA55sg" />
  <messageBuildingBlock
    xmi:id="_LedmMIreEeSvuOJS0mmL0g"
    name="ATMDeviceReport"
    definition="Information related to the status report from an ATM device."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ATMDvcRpt"
    complexType="_FGk3EIreEeSvuOJS0mmL0g" />
  <messageBuildingBlock
    xmi:id="_fopAgIreEeSvuOJS0mmL0g"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_R_tFoYreEeSvuOJS0mmL0g" />
  <messageDefinitionIdentifier
    businessArea="caam"
    messageFunctionality="001"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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