reda.021.001.01
The SecuritiesAccountReport message sent by the executing party to an instructing party to provide the details of the securities account details as requested in the query.
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 %% SecuritiesAccountReportV01 recursion level 0 with max 0 SecuritiesAccountReportV01 *-- "0..1" MessageHeader3 : MessageHeader SecuritiesAccountReportV01 *-- "1..1" Pagination1 : Pagination SecuritiesAccountReportV01 *-- "1..1" ISecuritiesAccountOrOperationalError3Choice : ReportOrError SecuritiesAccountReportV01 *-- "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. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification
classDiagram direction tb %% MessageHeader3 recursion level 0 with max 1 class MessageHeader3{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime QueryName IsoMax35Text } MessageHeader3 *-- "0..1" IRequestType2Choice : RequestType MessageHeader3 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery %% IRequestType2Choice recursion level 1 with max 1 %% OriginalBusinessQuery1 recursion level 1 with max 1 class OriginalBusinessQuery1{ MessageIdentification IsoMax35Text MessageNameIdentification IsoMax35Text CreationDateTime IsoISODateTime }
MessageHeader3 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 |
RequestType | Specific actions to be executed through the request. | IRequestType2Choice - Optional 0..1 |
OriginalBusinessQuery | Unique identification of the original query message. | OriginalBusinessQuery1 - Optional 0..1 |
QueryName | Recalls the criteria (search and return criteria) defined in a preceding query. | IsoMax35Text - 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 |
ReportOrError building block
Provides information on report or error resulting from the originating query message. Set of elements used to report between the securities account reference data or an operational error. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ISecuritiesAccountOrOperationalError3Choice recursion level 0 with max 1
SecuritiesAccountOrOperationalError3Choice 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 SecuritiesAccountReportV01 implementation follows a specific implementaiton pattern. First of all, SecuritiesAccountReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SecuritiesAccountReportV01Document implements IOuterDocument. Because SecuritiesAccountReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SecuritiesAccountReportV01.
classDiagram class IOuterRecord SecuritiesAccountReportV01 --|> IOuterRecord : Implements SecuritiesAccountReportV01Document --|> IOuterDocument~SecuritiesAccountReportV01~ : Implements class IOuterDocument~SecuritiesAccountReportV01~ { SecuritiesAccountReportV01 Message }
Document wrapper for serialization
The only real purpose SecuritiesAccountReportV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.021.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SecuritiesAccountReportV01.ToDocument() method. The returned SecuritiesAccountReportV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram SecuritiesAccountReportV01Document *-- SecuritiesAccountReportV01 : 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.021.001.01">
<SctiesAcctRpt>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<Pgntn>
<!-- Pagination inner content -->
</Pgntn>
<RptOrErr>
<!-- ReportOrError inner content -->
</RptOrErr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</SctiesAcctRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_KAu-1Z2fEem_Be8NuxvF7Q"
name="SecuritiesAccountReportV01"
definition="The SecuritiesAccountReport message sent by the executing party to an instructing party to provide the details of the securities account details as requested in the query."
registrationStatus="Registered"
messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
xmlTag="SctiesAcctRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_KAu-3Z2fEem_Be8NuxvF7Q"
type="purpose" />
<messageBuildingBlock
xmi:id="_KAu-352fEem_Be8NuxvF7Q"
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="_759LcKMgEeCJ6YNENx4h-w_896464386" />
<messageBuildingBlock
xmi:id="_KAu-4Z2fEem_Be8NuxvF7Q"
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="_KAu-552fEem_Be8NuxvF7Q"
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="_xuZ_ETp1Eemk2e6qGBk8IQ" />
<messageBuildingBlock
xmi:id="_KAu-6Z2fEem_Be8NuxvF7Q"
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="021"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.