auth.031.001.01
The FinancialInstrumentReportingStatusAdvice message is sent by the national competent authority to the reporting agent to provide a status advice for the correctness, issues or errors that arise from the submitted report.
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
%% FinancialInstrumentReportingStatusAdviceV01 recursion level 0 with max 0
FinancialInstrumentReportingStatusAdviceV01 *-- "1..1" MessageReportHeader4 : StatusAdvice
FinancialInstrumentReportingStatusAdviceV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
StatusAdvice building block
Status advice report. Provides details of many status advice reports where many received reports are reported at once. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MessageReportHeader4 recursion level 0 with max 1
class MessageReportHeader4{
MessageReportIdentifier IsoMax140Text
}
MessageReportHeader4 *-- "0..1" StatusAdviceReport3 : MessageStatus
MessageReportHeader4 *-- "0..0" StatusReportRecord3 : RecordStatus
MessageReportHeader4 *-- "0..0" SupplementaryData1 : SupplementaryData
%% StatusAdviceReport3 recursion level 1 with max 1
class StatusAdviceReport3{
Status ReportingMessageStatus1Code
MessageDate IsoISODate
}
StatusAdviceReport3 *-- "0..0" GenericValidationRuleIdentification1 : ValidationRule
StatusAdviceReport3 *-- "0..1" OriginalReportStatistics3 : Statistics
%% StatusReportRecord3 recursion level 1 with max 1
class StatusReportRecord3{
OriginalRecordIdentification IsoMax140Text
Status ReportingRecordStatus1Code
}
StatusReportRecord3 *-- "0..0" GenericValidationRuleIdentification1 : ValidationRule
StatusReportRecord3 *-- "0..0" SupplementaryData1 : SupplementaryData
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
MessageReportHeader4 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageReportIdentifier | Provide detail on previously received message reports that are being reported as part of this status advice. Usage: When required, this field will be populated with the BAH Business Message Identifier field. Where only a single message report header is used, this field is not used and relies solely on the BAH Business Message Identifier field. | IsoMax140Text - Optional 0..1 |
| MessageStatus | Details the status of the whole message that has been received. | StatusAdviceReport3 - Optional 0..1 |
| RecordStatus | Provides per record status on the report that has been received. | StatusReportRecord3 - Unknown 0..0 |
| SupplementaryData | Additional information that can not be captured in the structured fields and/or any other specific block. | SupplementaryData1 - Unknown 0..0 |
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 FinancialInstrumentReportingStatusAdviceV01 implementation follows a specific implementaiton pattern. First of all, FinancialInstrumentReportingStatusAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, FinancialInstrumentReportingStatusAdviceV01Document implements IOuterDocument. Because FinancialInstrumentReportingStatusAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type FinancialInstrumentReportingStatusAdviceV01.
classDiagram
class IOuterRecord
FinancialInstrumentReportingStatusAdviceV01 --|> IOuterRecord : Implements
FinancialInstrumentReportingStatusAdviceV01Document --|> IOuterDocument~FinancialInstrumentReportingStatusAdviceV01~ : Implements
class IOuterDocument~FinancialInstrumentReportingStatusAdviceV01~ {
FinancialInstrumentReportingStatusAdviceV01 Message
}
Document wrapper for serialization
The only real purpose FinancialInstrumentReportingStatusAdviceV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.031.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using FinancialInstrumentReportingStatusAdviceV01.ToDocument() method. The returned FinancialInstrumentReportingStatusAdviceV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
FinancialInstrumentReportingStatusAdviceV01Document *-- FinancialInstrumentReportingStatusAdviceV01 : 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.031.001.01">
<FinInstrmRptgStsAdvc>
<StsAdvc>
<!-- StatusAdvice inner content -->
</StsAdvc>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</FinInstrmRptgStsAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_4LUGQURNEee7JdgA9zPESA"
name="FinancialInstrumentReportingStatusAdviceV01"
definition="The FinancialInstrumentReportingStatusAdvice message is sent by the national competent authority to the reporting agent to provide a status advice for the correctness, issues or errors that arise from the submitted report."
registrationStatus="Registered"
messageSet="_m18yAApTEeeand7dul6qJQ _t2waJMTEEem1btCrV7DGXw _80T9UAw7Eeqb0PC56-ljDA _gVqhJBWsEeqvRcdYcNYAVw _9iTc0K2XEeuIDus5QP8udw"
xmlTag="FinInstrmRptgStsAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_4LUGQ0RNEee7JdgA9zPESA"
name="StatusAdvice"
definition="Status advice report."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="StsAdvc"
complexType="_CLY7kdGdEeaQk737TH1Fzw" />
<messageBuildingBlock
xmi:id="_4LUGRURNEee7JdgA9zPESA"
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="031"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.