reda.065.001.02
The CalendarReport message is sent by the system administrator to the system member is to return information on the system status for specific calendar days.
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
%% CalendarReportV02 recursion level 0 with max 0
CalendarReportV02 *-- "1..1" MessageHeader11 : MessageHeader
CalendarReportV02 *-- "1..1" ICalendarReportOrError1Choice : ReportOrError
CalendarReportV02 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
MessageHeader building block
Common business identification for the message. Specifies the header data such as the identification and the creation date and time, specific to the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MessageHeader11 recursion level 0 with max 1
class MessageHeader11{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader11 *-- "0..1" IRequestType4Choice : RequestType
MessageHeader11 *-- "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
}
MessageHeader11 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 |
ReportOrError building block
Reports on the calendar data. Choice between details of the audit trail data or an operational error when the requested data cannot be retrieved. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ICalendarReportOrError1Choice recursion level 0 with max 1
CalendarReportOrError1Choice members
| Member name | Description | Data Type / Multiplicity |
|---|
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 CalendarReportV02 implementation follows a specific implementaiton pattern. First of all, CalendarReportV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CalendarReportV02Document implements IOuterDocument. Because CalendarReportV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CalendarReportV02.
classDiagram
class IOuterRecord
CalendarReportV02 --|> IOuterRecord : Implements
CalendarReportV02Document --|> IOuterDocument~CalendarReportV02~ : Implements
class IOuterDocument~CalendarReportV02~ {
CalendarReportV02 Message
}
Document wrapper for serialization
The only real purpose CalendarReportV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.065.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CalendarReportV02.ToDocument() method. The returned CalendarReportV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CalendarReportV02Document *-- CalendarReportV02 : 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:reda.065.001.02">
<CalRpt>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RptOrErr>
<!-- ReportOrError inner content -->
</RptOrErr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CalRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_DRJNLFuDEe29lKnE5APnfA"
name="CalendarReportV02"
definition="The CalendarReport message is sent by the system administrator to the system member is to return information on the system status for specific calendar days."
registrationStatus="Registered"
messageSet="_Ly468LRHEe275vtHwLOtdg"
xmlTag="CalRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_DRJNL1uDEe29lKnE5APnfA"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_riYGEYm6Eeipw6hHPgB4Sw" />
<messageBuildingBlock
xmi:id="_DRJNLVuDEe29lKnE5APnfA"
name="ReportOrError"
definition="Reports on the calendar data."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptOrErr"
complexType="_dVcQ4Ym7Eeipw6hHPgB4Sw" />
<messageBuildingBlock
xmi:id="_DRJNLluDEe29lKnE5APnfA"
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="reda"
messageFunctionality="065"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.