auth.016.001.01
The FinancialInstrumentReportingTransactionReport message is sent by the reporting agent to the competent authority to report on the securities transactions or by the competent authority to another competent authority when the transaction needs to be exchanged between the competent authorities.
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 %% FinancialInstrumentReportingTransactionReportV01 recursion level 0 with max 0 FinancialInstrumentReportingTransactionReportV01 *-- "1..1" IReportingTransactionType1Choice : Transaction FinancialInstrumentReportingTransactionReportV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
Transaction building block
Provides the details of the reported securities transactions. Choice between a new or a cancellation transaction. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IReportingTransactionType1Choice recursion level 0 with max 1
ReportingTransactionType1Choice 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 FinancialInstrumentReportingTransactionReportV01 implementation follows a specific implementaiton pattern. First of all, FinancialInstrumentReportingTransactionReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FinancialInstrumentReportingTransactionReportV01Document implements IOuterDocument. Because FinancialInstrumentReportingTransactionReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FinancialInstrumentReportingTransactionReportV01.
classDiagram class IOuterRecord FinancialInstrumentReportingTransactionReportV01 --|> IOuterRecord : Implements FinancialInstrumentReportingTransactionReportV01Document --|> IOuterDocument~FinancialInstrumentReportingTransactionReportV01~ : Implements class IOuterDocument~FinancialInstrumentReportingTransactionReportV01~ { FinancialInstrumentReportingTransactionReportV01 Message }
Document wrapper for serialization
The only real purpose FinancialInstrumentReportingTransactionReportV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.016.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using FinancialInstrumentReportingTransactionReportV01.ToDocument() method. The returned FinancialInstrumentReportingTransactionReportV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram FinancialInstrumentReportingTransactionReportV01Document *-- FinancialInstrumentReportingTransactionReportV01 : 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.016.001.01">
<FinInstrmRptgTxRpt>
<Tx>
<!-- Transaction inner content -->
</Tx>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</FinInstrmRptgTxRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_4LUGT0RNEee7JdgA9zPESA"
name="FinancialInstrumentReportingTransactionReportV01"
definition="The FinancialInstrumentReportingTransactionReport message is sent by the reporting agent to the competent authority to report on the securities transactions or by the competent authority to another competent authority when the transaction needs to be exchanged between the competent authorities."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ _Smpa0G47Eeiuqc7swom0-A"
xmlTag="FinInstrmRptgTxRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_4LUGUURNEee7JdgA9zPESA"
name="Transaction"
definition="Provides the details of the reported securities transactions."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Tx"
complexType="_JzZ68YG-EeaalK9UbuVGFw" />
<messageBuildingBlock
xmi:id="_4LUGU0RNEee7JdgA9zPESA"
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="016"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.