SecuritiesAuditTrailReportV01

reda.034.001.01

The SecuritiesAuditTrailReport message is sent by the executing party to an instructing party to provide detailed information on the requested securities audit trail recorded in the system.

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
%% SecuritiesAuditTrailReportV01 recursion level 0 with max 0
SecuritiesAuditTrailReportV01 *-- "0..1" MessageHeader12 : MessageHeader
SecuritiesAuditTrailReportV01 *-- "1..1" ISecuritiesAuditTrailOrOperationalError4Choice : ReportOrError
SecuritiesAuditTrailReportV01 *-- "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
%% MessageHeader12 recursion level 0 with max 1
class MessageHeader12{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
MessageHeader12 *-- "0..1" OriginalBusinessInstruction1 : OriginalBusinessInstruction
%% OriginalBusinessInstruction1 recursion level 1 with max 1
class OriginalBusinessInstruction1{
    MessageIdentification IsoMax35Text
    MessageNameIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageHeader12 members

ReportOrError building block

Provides information on report or error resulting from the originating query message. Used to report between the securities reference data or an operational error. For comparison, see the ISO20022 official specification

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

SecuritiesAuditTrailOrOperationalError4Choice members

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

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the SecuritiesAuditTrailReportV01 implementation follows a specific implementaiton pattern. First of all, SecuritiesAuditTrailReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SecuritiesAuditTrailReportV01Document implements IOuterDocument. Because SecuritiesAuditTrailReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SecuritiesAuditTrailReportV01.

classDiagram
    class IOuterRecord
    SecuritiesAuditTrailReportV01 --|> IOuterRecord : Implements
    SecuritiesAuditTrailReportV01Document --|> IOuterDocument~SecuritiesAuditTrailReportV01~ : Implements
    class IOuterDocument~SecuritiesAuditTrailReportV01~ {
        SecuritiesAuditTrailReportV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SecuritiesAuditTrailReportV01Document *-- SecuritiesAuditTrailReportV01 : 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.034.001.01">
    <SctiesAudtTrlRpt>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <RptOrErr>
            <!-- ReportOrError inner content -->
        </RptOrErr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </SctiesAudtTrlRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_jTtYkR62Eeu31YsWNiv_cw"
  name="SecuritiesAuditTrailReportV01"
  definition="The SecuritiesAuditTrailReport message is sent by the executing party to an instructing party to provide detailed information on the requested securities audit trail recorded in the system."
  registrationStatus="Registered"
  messageSet="_XwWqJB62Eeu31YsWNiv_cw"
  xmlTag="SctiesAudtTrlRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_AdKKAZIxEeuAlLVx8pyt3w"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="MsgHdr"
    complexType="_Hm0DQYtSEeih5rmIxWMzEw" />
  <messageBuildingBlock
    xmi:id="_jTtYpx62Eeu31YsWNiv_cw"
    name="ReportOrError"
    definition="Provides information on report or error resulting from the originating query message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptOrErr"
    complexType="_PrBR8ZJKEeuAlLVx8pyt3w" />
  <messageBuildingBlock
    xmi:id="_jTtYqR62Eeu31YsWNiv_cw"
    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="034"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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