admi.005.001.01
The ReportQueryRequest message is exchanged between system member and system transaction administrator. It aims at querying the latest available report data of a specific report type. A report is stored and available for query until the event occurs again report is replaced.
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
%% ReportQueryRequestV01 recursion level 0 with max 0
ReportQueryRequestV01 *-- "1..1" MessageHeader7 : MessageHeader
ReportQueryRequestV01 *-- "0..1" ReportQueryCriteria2 : ReportQueryCriteria
ReportQueryRequestV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
MessageHeader building block
Set of elements to identify the report query request message. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MessageHeader7 recursion level 0 with max 1
class MessageHeader7{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
QueryName IsoMax35Text
}
MessageHeader7 *-- "0..1" IRequestType4Choice : RequestType
MessageHeader7 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
%% IRequestType4Choice recursion level 1 with max 1
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader7 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the sender, to unambiguously identify the message. | Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period. |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Optional 0..1 |
| RequestType | Specific actions to be executed through the request. | IRequestType4Choice - Optional 0..1 |
| OriginalBusinessQuery | Unique identification of the original query message. | OriginalBusinessQuery1 - Optional 0..1 |
| QueryName | Recalls the criteria (search and return criteria) defined in a preceding query. | IsoMax35Text - Optional 0..1 |
ReportQueryCriteria building block
Definition of the report query criteria. Defines the criteria which are used to search for generated report. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ReportQueryCriteria2 recursion level 0 with max 1
class ReportQueryCriteria2{
NewQueryName IsoMax35Text
}
ReportQueryCriteria2 *-- "1..1" ReportQuerySearchCriteria2 : SearchCriteria
%% ReportQuerySearchCriteria2 recursion level 1 with max 1
class ReportQuerySearchCriteria2{
ReportName IsoMax4AlphaNumericText
MessageNameIdentification IsoMax35Text
}
ReportQuerySearchCriteria2 *-- "0..0" IAccountIdentificationSearchCriteria2Choice : AccountIdentification
ReportQuerySearchCriteria2 *-- "0..0" CashBalance12 : Balance
ReportQuerySearchCriteria2 *-- "1..1" PartyIdentification136 : PartyIdentification
ReportQuerySearchCriteria2 *-- "0..1" PartyIdentification136 : ResponsiblePartyIdentification
ReportQuerySearchCriteria2 *-- "0..1" IDatePeriodSearch1Choice : DateSearch
ReportQuerySearchCriteria2 *-- "0..1" IDateTimePeriod1Choice : ScheduledTime
ReportQuerySearchCriteria2 *-- "0..1" IEventType1Choice : Event
ReportQueryCriteria2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| NewQueryName | Name of the query defined by the search criteria and return criteria. | IsoMax35Text - Optional 0..1 |
| SearchCriteria | Defines the criteria to be used to extract the account information. | ReportQuerySearchCriteria2 - Required 1..1 |
SupplementaryData building block
Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
SupplementaryData1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
| Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the ReportQueryRequestV01 implementation follows a specific implementaiton pattern. First of all, ReportQueryRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ReportQueryRequestV01Document implements IOuterDocument. Because ReportQueryRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ReportQueryRequestV01.
classDiagram
class IOuterRecord
ReportQueryRequestV01 --|> IOuterRecord : Implements
ReportQueryRequestV01Document --|> IOuterDocument~ReportQueryRequestV01~ : Implements
class IOuterDocument~ReportQueryRequestV01~ {
ReportQueryRequestV01 Message
}
Document wrapper for serialization
The only real purpose ReportQueryRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:admi.005.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ReportQueryRequestV01.ToDocument() method. The returned ReportQueryRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ReportQueryRequestV01Document *-- ReportQueryRequestV01 : 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:admi.005.001.01">
<RptQryReq>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RptQryCrit>
<!-- ReportQueryCriteria inner content -->
</RptQryCrit>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</RptQryReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_5Ql0IZb3Eee4htziCyV8eA"
name="ReportQueryRequestV01"
definition="The ReportQueryRequest message is exchanged between system member and system transaction administrator.
It aims at querying the latest available report data of a specific report type. A report is stored and available for query until the event occurs again report is replaced."
registrationStatus="Registered"
messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
xmlTag="RptQryReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_5Ql0I5b3Eee4htziCyV8eA"
name="MessageHeader"
definition="Set of elements to identify the report query request message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_imfkUZIhEeect698_YsnIA" />
<messageBuildingBlock
xmi:id="_5Ql0JZb3Eee4htziCyV8eA"
name="ReportQueryCriteria"
definition="Definition of the report query criteria."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="RptQryCrit"
complexType="_3NLDgZb6Eee4htziCyV8eA" />
<messageBuildingBlock
xmi:id="_5Ql0J5b3Eee4htziCyV8eA"
name="SupplementaryData"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="admi"
messageFunctionality="005"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.