colr.002.001.01
The CollateralValueReport message is sent by the system transaction administrator to a system member (such as a directly connected party) to provide further information the current available value of securities for auto collateralisation for one specific or several cash accounts.
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
%% CollateralValueReportV01 recursion level 0 with max 0
CollateralValueReportV01 *-- "1..1" MessageHeader3 : MessageHeader
CollateralValueReportV01 *-- "1..1" ICollateralValueReportOrError5Choice : ReportOrError
CollateralValueReportV01 *-- "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 collateral value report 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
%% MessageHeader3 recursion level 0 with max 1
class MessageHeader3{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
QueryName IsoMax35Text
}
MessageHeader3 *-- "0..1" IRequestType2Choice : RequestType
MessageHeader3 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
%% IRequestType2Choice recursion level 1 with max 1
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader3 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. | IRequestType2Choice - 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 |
ReportOrError building block
Report on collateral value information or operational error. Reports on collateral values or error report in case of business processing of the related request. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ICollateralValueReportOrError5Choice recursion level 0 with max 1
CollateralValueReportOrError5Choice 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 CollateralValueReportV01 implementation follows a specific implementaiton pattern. First of all, CollateralValueReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CollateralValueReportV01Document implements IOuterDocument. Because CollateralValueReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CollateralValueReportV01.
classDiagram
class IOuterRecord
CollateralValueReportV01 --|> IOuterRecord : Implements
CollateralValueReportV01Document --|> IOuterDocument~CollateralValueReportV01~ : Implements
class IOuterDocument~CollateralValueReportV01~ {
CollateralValueReportV01 Message
}
Document wrapper for serialization
The only real purpose CollateralValueReportV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:colr.002.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CollateralValueReportV01.ToDocument() method. The returned CollateralValueReportV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CollateralValueReportV01Document *-- CollateralValueReportV01 : 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:colr.002.001.01">
<CollValRpt>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RptOrErr>
<!-- ReportOrError inner content -->
</RptOrErr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CollValRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_5SjM_zooEemaN9GkhmGkfg"
name="CollateralValueReportV01"
definition="The CollateralValueReport message is sent by the system transaction administrator to a system member (such as a directly connected party) to provide further information the current available value of securities for auto collateralisation for one specific or several cash accounts."
registrationStatus="Registered"
messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
xmlTag="CollValRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_5Sj0ATooEemaN9GkhmGkfg"
name="MessageHeader"
definition="Set of elements to identify the collateral value report message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_759LcKMgEeCJ6YNENx4h-w_896464386" />
<messageBuildingBlock
xmi:id="_5Sj0AzooEemaN9GkhmGkfg"
name="ReportOrError"
definition="Report on collateral value information or operational error."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptOrErr"
complexType="_95GpHzpvEemk2e6qGBk8IQ" />
<messageBuildingBlock
xmi:id="_5Sj0BTooEemaN9GkhmGkfg"
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="colr"
messageFunctionality="002"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.