admi.006.001.01
A system member or any parties authorised by them send a ResendRequest message to the Central System (such as the T2S platform). The purpose of this request is, that the requesting party wants to receive the “original” message once again. This might be caused through technical problems on the receiving side (message could not be received or processed or is missing in the message sequencing) or for archiving purposes.
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 %% ResendRequestV01 recursion level 0 with max 0 ResendRequestV01 *-- "1..1" MessageHeader7 : MessageHeader ResendRequestV01 *-- "1..1" ResendSearchCriteria2 : ResendSearchCriteria ResendRequestV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
MessageHeader building block
Set of elements to identify the resend 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 %% MessageHeader7 recursion level 0 with max 1 class MessageHeader7{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime QueryName IsoMax35Text } MessageHeader7 *-- "0..1" IRequestType4Choice : RequestType MessageHeader7 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery %% IRequestType4Choice recursion level 1 with max 1 %% OriginalBusinessQuery1 recursion level 1 with max 1 class OriginalBusinessQuery1{ MessageIdentification IsoMax35Text MessageNameIdentification IsoMax35Text CreationDateTime IsoISODateTime }
MessageHeader7 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. | IRequestType4Choice - 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 |
ResendSearchCriteria building block
Defines the criteria to unambiguously identify the information to be resent. Defines the criteria to extract the message(s) which should be resent. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ResendSearchCriteria2 recursion level 0 with max 1 class ResendSearchCriteria2{ BusinessDate IsoISODate SequenceNumber IsoMax35Text OriginalMessageNameIdentification IsoMax35Text FileReference IsoMax35Text } ResendSearchCriteria2 *-- "0..1" ISequenceRange1Choice : SequenceRange ResendSearchCriteria2 *-- "1..1" PartyIdentification136 : Recipient %% ISequenceRange1Choice recursion level 1 with max 1 %% PartyIdentification136 recursion level 1 with max 1 class PartyIdentification136{ LEI IsoLEIIdentifier } PartyIdentification136 *-- "1..1" IPartyIdentification120Choice : Identification
ResendSearchCriteria2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
BusinessDate | Date of the business day of the requested messages the resend function is used for. | IsoISODate - Optional 0..1 |
SequenceNumber | Independent counter for message sequence, which is available once per party technical address. | Specifies the identification sequence number for a specific couple sender/receiver. |
SequenceRange | Independent counter for a range of message sequences, which are available once per party technical address. Specifies the range of identification sequence numbers for a specific couple sender/receiver. | ISequenceRange1Choice - Optional 0..1 |
OriginalMessageNameIdentification | Unambiguously identifies the original bsiness message, which was delivered by the business sender. | IsoMax35Text - Optional 0..1 |
FileReference | String of characters that uniquely identifies the file, which was delivered by the sender. | IsoMax35Text - Optional 0..1 |
Recipient | Unique identification to unambiguously identify the recipient of the report message. | PartyIdentification136 - Required 1..1 |
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 ResendRequestV01 implementation follows a specific implementaiton pattern. First of all, ResendRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ResendRequestV01Document implements IOuterDocument. Because ResendRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ResendRequestV01.
classDiagram class IOuterRecord ResendRequestV01 --|> IOuterRecord : Implements ResendRequestV01Document --|> IOuterDocument~ResendRequestV01~ : Implements class IOuterDocument~ResendRequestV01~ { ResendRequestV01 Message }
Document wrapper for serialization
The only real purpose ResendRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:admi.006.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ResendRequestV01.ToDocument() method. The returned ResendRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram ResendRequestV01Document *-- ResendRequestV01 : 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:admi.006.001.01">
<RsndReq>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RsndSchCrit>
<!-- ResendSearchCriteria inner content -->
</RsndSchCrit>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</RsndReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_5xUioZb3Eee4htziCyV8eA"
name="ResendRequestV01"
definition="A system member or any parties authorised by them send a ResendRequest message to the Central System (such as the T2S platform). The purpose of this request is, that the requesting party wants to receive the “original” message once again. This might be caused through technical problems on the receiving side (message could not be received or processed or is missing in the message sequencing) or for archiving purposes."
registrationStatus="Registered"
messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
xmlTag="RsndReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_5xUio5b3Eee4htziCyV8eA"
name="MessageHeader"
definition="Set of elements to identify the resend message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_imfkUZIhEeect698_YsnIA" />
<messageBuildingBlock
xmi:id="_5xUipZb3Eee4htziCyV8eA"
name="ResendSearchCriteria"
definition="Defines the criteria to unambiguously identify the information to be resent."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="RsndSchCrit"
complexType="_Q6TwEZb7Eee4htziCyV8eA" />
<messageBuildingBlock
xmi:id="_5xUip5b3Eee4htziCyV8eA"
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="admi"
messageFunctionality="006"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.