caad.010.001.01
The Custom Report message can be initiated by any party and received by any party (acquirer, agent, issuer or other party) connected to a network.
This message provides the capability to convey customized reports that are defined by bi-lateral agreement.
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
%% CustomReportV01 recursion level 0 with max 0
CustomReportV01 *-- "1..1" Header65 : Header
CustomReportV01 *-- "1..1" CustomReport1 : Body
CustomReportV01 *-- "0..1" ContentInformationType20 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Information related to protocol management. Set of characteristics related to the protocol. Header for an amendment message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header65 recursion level 0 with max 1
class Header65{
MessageFunction MessageFunction27Code
ProtocolVersion IsoMax2048Text
ExchangeIdentification IsoMax35Text
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header65 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header65 *-- "1..1" GenericIdentification183 : InitiatingParty
Header65 *-- "0..1" GenericIdentification183 : RecipientParty
Header65 *-- "0..0" AdditionalData1 : TraceData
Header65 *-- "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
Header65 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction27Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer to issuer protocol specifications. | IsoMax2048Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange of messages between two parties. | IsoMax35Text - Optional 0..1 |
| ReTransmissionCounter | Number of retransmission of the message. Incremented by one for each retransmission. | IsoMax3NumericText - Optional 0..1 |
| CreationDateTime | Date and time at which the message was sent. | IsoISODateTime - Required 1..1 |
| BatchManagementInformation | Information related to the batch and the collection to which the message belongs if any. | BatchManagementInformation1 - Optional 0..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification183 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification183 - Optional 0..1 |
| TraceData | Information sent in the request message to be returned in the response one, for instance to help in the retrieval of the context of the exchange. | AdditionalData1 - Unknown 0..0 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability9 - Unknown 0..0 |
Body building block
Information related to the customer report. The Custom Report message can be initiated by any party and received by any party (acquirer, agent, issuer or other party) connected to a network.
This message provides the capability to convey customized reports that are defined by bi-lateral agreement. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CustomReport1 recursion level 0 with max 1
CustomReport1 *-- "1..1" Environment33 : Environment
CustomReport1 *-- "0..1" Context17 : Context
CustomReport1 *-- "1..1" ReportData6 : Report
CustomReport1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment33 recursion level 1 with max 1
Environment33 *-- "0..1" PartyIdentification263 : Originator
Environment33 *-- "0..1" PartyIdentification263 : Sender
Environment33 *-- "0..1" PartyIdentification263 : Receiver
Environment33 *-- "0..1" PartyIdentification263 : Destination
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% ReportData6 recursion level 1 with max 1
class ReportData6{
Name IsoMax140Text
Identification IsoMax140Text
Qualifier IsoMax70Text
Date IsoISODate
Time IsoISOTime
Sequence IsoMax5NumericText
TotalOccurrences IsoMax5NumericText
Frequency Frequency17Code
ContinuationIndicator IsoTrueFalseIndicator
Format OutputFormat5Code
OtherFormat IsoMax35Text
}
ReportData6 *-- "0..1" CorrectionIdentification1 : Correction
ReportData6 *-- "0..0" AdditionalData1 : AdditionalData
ReportData6 *-- "0..0" ReportContent1 : Content
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
CustomReport1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | Environment33 - Required 1..1 |
| Context | Contains or describes conditions and characteristics of the transaction. | Context17 - Optional 0..1 |
| Report | Specifies the attributes of a report and its content. | ReportData6 - Required 1..1 |
| SupplementaryData | Additional information that can not be captured in the structured fields and/or other specific block. | SupplementaryData1 - Unknown 0..0 |
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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MACData | Type of data protection. ISO 8583:87 bit 53 or 110 ISO 8583:93 bit 53 or 111 ISO 8583:2003 bit 53 or 50 | MACData1 - Required 1..1 |
| MAC | Message Authentication Code data. Binary, length of 8 ISO 8583 bit 64 or bit 128 | IsoMax8HexBinaryText - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the CustomReportV01 implementation follows a specific implementaiton pattern. First of all, CustomReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CustomReportV01Document implements IOuterDocument. Because CustomReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CustomReportV01.
classDiagram
class IOuterRecord
CustomReportV01 --|> IOuterRecord : Implements
CustomReportV01Document --|> IOuterDocument~CustomReportV01~ : Implements
class IOuterDocument~CustomReportV01~ {
CustomReportV01 Message
}
Document wrapper for serialization
The only real purpose CustomReportV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caad.010.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CustomReportV01.ToDocument() method. The returned CustomReportV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CustomReportV01Document *-- CustomReportV01 : 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:caad.010.001.01">
<CstmRpt>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</CstmRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_4z6yUMlHEeuJ35KoBRZFOg"
name="CustomReportV01"
definition="The Custom Report message can be initiated by any party and received by any party (acquirer, agent, issuer or other party) connected to a network.

This message provides the capability to convey customized reports that are defined by bi-lateral agreement."
registrationStatus="Registered"
messageSet="_kT2-dARsEeWTJNHF-ohSqw"
xmlTag="CstmRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_gLegIMlLEeuJ35KoBRZFOg"
name="Header"
definition="Information related to protocol management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_PgRJoRymEeyVgKPonV4SjQ" />
<messageBuildingBlock
xmi:id="_rJnosMlLEeuJ35KoBRZFOg"
name="Body"
definition="Information related to the customer report."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Body"
complexType="_6o4MAMlLEeuJ35KoBRZFOg" />
<messageBuildingBlock
xmi:id="_t0su4clLEeuJ35KoBRZFOg"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
<messageDefinitionIdentifier
businessArea="caad"
messageFunctionality="010"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.