SecurityReportV01

reda.012.001.01

SCOPE An executing/servicing party sends a SecurityReport message to an instructing party to advise the last known image of securities data’s.

The report may be sent upon request (for example a query) of the instructing party or push by the executing/servicing party.

The instructing party - executing/servicing party relationship may be:

Initiator: executing/servicing party.

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
%% SecurityReportV01 recursion level 0 with max 0
SecurityReportV01 *-- "0..1" MessageHeader12 : MessageHeader
SecurityReportV01 *-- "1..1" Pagination1 : Pagination
SecurityReportV01 *-- "1..1" ISecurityOrOperationalError4Choice : SecurityReportOrError
SecurityReportV01 *-- "0..1" SupplementaryData1 : SupplementaryData
  

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

MessageHeader building block

Point to point reference elements, as assigned by the instructing party, to unambiguously identify the report 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

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
OriginalBusinessInstruction Unique identification of the original instruction. OriginalBusinessInstruction1 - Optional 0..1

Pagination building block

Provides details on the page number of the message. Number used to sequence pages when it is not possible for data to be conveyed in a single message and the data has to be split across several pages (messages). For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Pagination1 recursion level 0 with max 1
class Pagination1{
    PageNumber IsoMax5NumericText
    LastPageIndicator IsoYesNoIndicator
}
  

Pagination1 members

Member name Description Data Type / Multiplicity
PageNumber Page number. IsoMax5NumericText - Required 1..1
LastPageIndicator Indicates the last page. IsoYesNoIndicator - Required 1..1

SecurityReportOrError building block

Provides the financial instruments details or error raised during the generation of the report. Provides the financial instruments details or the operational error details. For comparison, see the ISO20022 official specification

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

SecurityOrOperationalError4Choice 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 SecurityReportV01 implementation follows a specific implementaiton pattern. First of all, SecurityReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SecurityReportV01Document implements IOuterDocument. Because SecurityReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SecurityReportV01.

classDiagram
    class IOuterRecord
    SecurityReportV01 --|> IOuterRecord : Implements
    SecurityReportV01Document --|> IOuterDocument~SecurityReportV01~ : Implements
    class IOuterDocument~SecurityReportV01~ {
        SecurityReportV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SecurityReportV01Document *-- SecurityReportV01 : 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.012.001.01">
    <SctyRpt>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <Pgntn>
            <!-- Pagination inner content -->
        </Pgntn>
        <SctyRptOrErr>
            <!-- SecurityReportOrError inner content -->
        </SctyRptOrErr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </SctyRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_jTv05R62Eeu31YsWNiv_cw"
  name="SecurityReportV01"
  definition="SCOPE&#xD;&#xA;An executing/servicing party sends a SecurityReport message to an instructing party to advise the last known image of securities data's.&#xD;&#xA;&#xD;&#xA;The report may be sent upon request (for example a query) of the instructing party or push by the executing/servicing party.&#xD;&#xA;&#xD;&#xA;The instructing party - executing/servicing party relationship may be:&#xD;&#xA;- Central Securities Depositories (CSD) who would like to publish security static data, or &#xD;&#xA;- a Corporate, or&#xD;&#xA;- a Bank, or&#xD;&#xA;- a Market Infrastructure, or &#xD;&#xA;- a Market Data Provider.&#xD;&#xA;&#xD;&#xA;Initiator: executing/servicing party."
  registrationStatus="Registered"
  messageSet="_XwWqJB62Eeu31YsWNiv_cw"
  xmlTag="SctyRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_jTv07R62Eeu31YsWNiv_cw"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_Y1e_wZIxEeuAlLVx8pyt3w"
    name="MessageHeader"
    definition="Point to point reference elements, as assigned by the instructing party, to unambiguously identify the report message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="MsgHdr"
    complexType="_Hm0DQYtSEeih5rmIxWMzEw" />
  <messageBuildingBlock
    xmi:id="_jTv0-R62Eeu31YsWNiv_cw"
    name="Pagination"
    definition="Provides details on the page number of the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Pgntn"
    complexType="_xhMHQa6XEees_ufOy2ci-g" />
  <messageBuildingBlock
    xmi:id="_jTv0-x62Eeu31YsWNiv_cw"
    name="SecurityReportOrError"
    definition="Provides the financial instruments details or error raised during the generation of the report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyRptOrErr"
    complexType="_P3wGYZJKEeuAlLVx8pyt3w" />
  <messageBuildingBlock
    xmi:id="_jTv1AR62Eeu31YsWNiv_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="012"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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