FinancialBenchmarkReportV01

auth.077.001.01

This FinancialBenchmarkReport message is sent by the competent institution to report benchmarks used for the purpose of the local regulation.

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
%% FinancialBenchmarkReportV01 recursion level 0 with max 0
FinancialBenchmarkReportV01 *-- "1..1" IBenchmarkReport1Choice : BenchmarkData
FinancialBenchmarkReportV01 *-- "0..1" SupplementaryData1 : SupplementaryData
  

Now, we will zero-in one-by-one on each of these building blocks.

BenchmarkData building block

Provides appropriate instructions to update or cancel information about a benchmark in the scope of the local regulation. Benchmark report by the relevant national institution. The report can be either an update or a cancellation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IBenchmarkReport1Choice recursion level 0 with max 1
  

BenchmarkReport1Choice members

Member name Description Data Type / Multiplicity

SupplementaryData building block

Additional information that can not be captured in the structured fields 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 FinancialBenchmarkReportV01 implementation follows a specific implementaiton pattern. First of all, FinancialBenchmarkReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FinancialBenchmarkReportV01Document implements IOuterDocument. Because FinancialBenchmarkReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FinancialBenchmarkReportV01.

classDiagram
    class IOuterRecord
    FinancialBenchmarkReportV01 --|> IOuterRecord : Implements
    FinancialBenchmarkReportV01Document --|> IOuterDocument~FinancialBenchmarkReportV01~ : Implements
    class IOuterDocument~FinancialBenchmarkReportV01~ {
        FinancialBenchmarkReportV01 Message
     }
  

Document wrapper for serialization

The only real purpose FinancialBenchmarkReportV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.077.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using FinancialBenchmarkReportV01.ToDocument() method. The returned FinancialBenchmarkReportV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    FinancialBenchmarkReportV01Document *-- FinancialBenchmarkReportV01 : 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:auth.077.001.01">
    <FinBchmkRpt>
        <BchmkData>
            <!-- BenchmarkData inner content -->
        </BchmkData>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </FinBchmkRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_EqCsoPKJEeaz_YGUGLjP6A"
  name="FinancialBenchmarkReportV01"
  definition="This FinancialBenchmarkReport message is sent by the competent institution to report benchmarks used for the purpose of the local regulation."
  registrationStatus="Registered"
  messageSet="_v6phIPHzEeaz_YGUGLjP6A"
  xmlTag="FinBchmkRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_OaxVsIgMEeeMp7TnNqgLag"
    name="SupplementaryDataRule"
    definition="The SupplementaryData building block at message level must not be used to provide any information about a benchmark. The SupplementaryData element at benchmark level should be used for that purpose."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_mm5ioTrVEeedCZZ8dIPp6g"
    name="BenchmarkData"
    definition="Provides appropriate instructions to update or cancel information about a benchmark in the scope of the local regulation."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="BchmkData"
    complexType="_P2VfczrWEeedCZZ8dIPp6g" />
  <messageBuildingBlock
    xmi:id="_rFkoUTbuEeeYhaZ6bvG1Xg"
    name="SupplementaryData"
    definition="Additional information that can not be captured in the structured fields and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="auth"
    messageFunctionality="077"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.