caam.002.001.03
The ATMDeviceControl message is sent by a maintenance host to an ATM in response to an ATMDeviceReport message. The message contains a sequence of maintenance commands the ATM must perform.
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
%% ATMDeviceControlV03 recursion level 0 with max 0
ATMDeviceControlV03 *-- "1..1" Header31 : Header
ATMDeviceControlV03 *-- "0..1" ContentInformationType10 : ProtectedATMDeviceControl
ATMDeviceControlV03 *-- "0..1" ATMDeviceControl2 : ATMDeviceControl
ATMDeviceControlV03 *-- "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
%% Header31 recursion level 0 with max 1
class Header31{
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
CreationDateTime IsoISODateTime
InitiatingParty IsoMax35Text
RecipientParty IsoMax35Text
ProcessState IsoMax35Text
}
Header31 *-- "1..1" ATMMessageFunction2 : MessageFunction
Header31 *-- "0..0" Traceability4 : Traceability
%% ATMMessageFunction2 recursion level 1 with max 1
class ATMMessageFunction2{
Function MessageFunction11Code
ATMServiceCode IsoMax35Text
HostServiceCode IsoMax35Text
}
%% Traceability4 recursion level 1 with max 1
class Traceability4{
SequenceNumber IsoMax35Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability4 *-- "1..1" GenericIdentification77 : RelayIdentification
Header31 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | ATMMessageFunction2 - 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 |
ProtectedATMDeviceControl 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 |
ATMDeviceControl building block
Information related to the control of an ATM device. Information related to the control of an ATM device. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ATMDeviceControl2 recursion level 0 with max 1
ATMDeviceControl2 *-- "1..1" ATMEnvironment7 : Environment
ATMDeviceControl2 *-- "0..0" ATMCommand10 : Command
%% ATMEnvironment7 recursion level 1 with max 1
ATMEnvironment7 *-- "0..1" Acquirer7 : Acquirer
ATMEnvironment7 *-- "0..1" Acquirer8 : ATMManager
ATMEnvironment7 *-- "0..1" TerminalHosting1 : HostingEntity
ATMEnvironment7 *-- "1..1" AutomatedTellerMachine3 : ATM
%% ATMCommand10 recursion level 1 with max 1
class ATMCommand10{
Type ATMCommand6Code
Urgency TMSContactLevel2Code
DateTime IsoISODateTime
Reason ATMCommandReason1Code
TraceReason ATMCommandReason1Code
AdditionalReasonInformation IsoMax70Text
}
ATMCommand10 *-- "0..1" ATMCommandIdentification1 : CommandIdentification
ATMCommand10 *-- "0..1" IATMCommandParameters3Choice : CommandParameters
ATMDeviceControl2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | ATMEnvironment7 - Required 1..1 |
| Command | Maintenance command the ATM must perform. | ATMCommand10 - Unknown 0..0 |
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 ATMDeviceControlV03 implementation follows a specific implementaiton pattern. First of all, ATMDeviceControlV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ATMDeviceControlV03Document implements IOuterDocument. Because ATMDeviceControlV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ATMDeviceControlV03.
classDiagram
class IOuterRecord
ATMDeviceControlV03 --|> IOuterRecord : Implements
ATMDeviceControlV03Document --|> IOuterDocument~ATMDeviceControlV03~ : Implements
class IOuterDocument~ATMDeviceControlV03~ {
ATMDeviceControlV03 Message
}
Document wrapper for serialization
The only real purpose ATMDeviceControlV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caam.002.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ATMDeviceControlV03.ToDocument() method. The returned ATMDeviceControlV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ATMDeviceControlV03Document *-- ATMDeviceControlV03 : 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.002.001.03">
<ATMDvcCtrl>
<Hdr>
<!-- Header inner content -->
</Hdr>
<PrtctdATMDvcCtrl>
<!-- ProtectedATMDeviceControl inner content -->
</PrtctdATMDvcCtrl>
<ATMDvcCtrl>
<!-- ATMDeviceControl inner content -->
</ATMDvcCtrl>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</ATMDvcCtrl>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_NrPX4V_YEeeD0NpJQPACzA"
previousVersion="_caM7Qa45EeWRfYPBaeOY8w"
name="ATMDeviceControlV03"
definition="The ATMDeviceControl message is sent by a maintenance host to an ATM in response to an ATMDeviceReport message. The message contains a sequence of maintenance commands the ATM must perform."
registrationStatus="Provisionally Registered"
messageSet="_wx2hAK1hEeWMg5rOByfExw"
xmlTag="ATMDvcCtrl"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_NrPX41_YEeeD0NpJQPACzA"
previousVersion="_caM7Q645EeWRfYPBaeOY8w"
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="_eMl4Qa1wEeWMg5rOByfExw" />
<messageBuildingBlock
xmi:id="_NrPX5V_YEeeD0NpJQPACzA"
previousVersion="_caM7Ra45EeWRfYPBaeOY8w"
name="ProtectedATMDeviceControl"
definition="Encrypted body of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctdATMDvcCtrl"
complexType="_UfeMUWizEeS87LmvcA55sg" />
<messageBuildingBlock
xmi:id="_NrPX51_YEeeD0NpJQPACzA"
previousVersion="_caM7R645EeWRfYPBaeOY8w"
name="ATMDeviceControl"
definition="Information related to the control of an ATM device."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ATMDvcCtrl"
complexType="_GmxrcV27EeekzJIz1JxYSQ" />
<messageBuildingBlock
xmi:id="_NrPX6V_YEeeD0NpJQPACzA"
previousVersion="_caM7Sa45EeWRfYPBaeOY8w"
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="002"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.