supl.032.001.01
The DTCCCAICSD1 message extends ISO corporate action Instruction Cancellation Request (CAIC) message with DTCC corporate action elements not covered in the standard message.
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 %% DTCCCAICSD1V01 recursion level 0 with max 0 DTCCCAICSD1V01 *-- "0..12" ReorganisationInstructionDetailsSD3 : ReorganisationInstructionCancellationDetails
Now, we will zero-in one-by-one on each of these building blocks.
ReorganisationInstructionCancellationDetails building block
Supplementary data extending corporate action instruction cancellation request message with corporate action reorganisation elements not covered in the standard message. Provides additional information regarding corporate action reorganisation instruction details. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ReorganisationInstructionDetailsSD3 recursion level 0 with max 1 class ReorganisationInstructionDetailsSD3{ PlaceAndName IsoMax350Text WithdrawalTransactionType ReorganisationWithdrawalTransactionType1Code TransactionIdentification IsoMax15Text TransactionSequenceNumber IsoMax3NumericText ProtectIdentification IsoMax15Text ProtectSafekeepingAccount IsoRestrictedFINMax35Text CustomerReferenceIdentification IsoMax30Text UserReferenceNumber IsoMax6Text } ReorganisationInstructionDetailsSD3 *-- "0..1" SecuritiesQuantityDetailsSD3 : SecuritiesQuantityDetails ReorganisationInstructionDetailsSD3 *-- "0..1" ContactIdentification5 : ContactPerson %% SecuritiesQuantityDetailsSD3 recursion level 1 with max 1 SecuritiesQuantityDetailsSD3 *-- "0..1" FinancialInstrumentQuantity4 : OversubscriptionQuantity SecuritiesQuantityDetailsSD3 *-- "0..1" FinancialInstrumentQuantity4 : TotalOversubscriptionQuantity SecuritiesQuantityDetailsSD3 *-- "0..1" IFinancialInstrumentQuantity31Choice : InstructionQuantity %% ContactIdentification5 recursion level 1 with max 1 class ContactIdentification5{ Name IsoMax35Text PhoneNumber IsoPhoneNumber }
ReorganisationInstructionDetailsSD3 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | Xpath to the element that is being extended. | IsoMax350Text - Optional 0..1 |
WithdrawalTransactionType | Identifies the reorganisation withdrawal transaction type. | ReorganisationWithdrawalTransactionType1Code - Optional 0..1 |
TransactionIdentification | Unique number assigned by the depository. Transaction identification will be either the DTC instruction reference number for reorganisation instructions (VOI) or the DAM reference number for custody / reorganisation deposits. | IsoMax15Text - Optional 0..1 |
TransactionSequenceNumber | Number which further identifies DTC instruction reference number. Not applicable to reorganisation / custody deposits. | IsoMax3NumericText - Optional 0..1 |
ProtectIdentification | Identifies the protect itself or of that is being covered. It is required for the function types cover protect (COVR), cover protect directly to agent (COVA) and cover on behalf of another participant (COVP). | IsoMax15Text - Optional 0..1 |
ProtectSafekeepingAccount | For cover protect instructions whereby one safekeeping account is covering on behalf of another safekeeping account. The protect safekeeping account will be the account which submitted the original protect instruction. | IsoRestrictedFINMax35Text - Optional 0..1 |
SecuritiesQuantityDetails | Provides information about securities quantity linked to a corporate action option. | SecuritiesQuantityDetailsSD3 - Optional 0..1 |
ContactPerson | Party contact information for the given instruction; required for voluntary offer instruction transaction (VOIT), protect transaction (PROT) and protect on behalf of another participant transaction (PROP); not required for cover protect instructions like cover protect transaction (COVR), cover protect directly to agent transaction (COVA) and cover protect on behalf of another participant transaction (COVP). | ContactIdentification5 - Optional 0..1 |
CustomerReferenceIdentification | Customer identification entered by client upon instruction submission. | IsoMax30Text - Optional 0..1 |
UserReferenceNumber | Unique identification of the transaction used by the transmitting party. | IsoMax6Text - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the DTCCCAICSD1V01 implementation follows a specific implementaiton pattern. First of all, DTCCCAICSD1V01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, DTCCCAICSD1V01Document implements IOuterDocument. Because DTCCCAICSD1V01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type DTCCCAICSD1V01.
classDiagram class IOuterRecord DTCCCAICSD1V01 --|> IOuterRecord : Implements DTCCCAICSD1V01Document --|> IOuterDocument~DTCCCAICSD1V01~ : Implements class IOuterDocument~DTCCCAICSD1V01~ { DTCCCAICSD1V01 Message }
Document wrapper for serialization
The only real purpose DTCCCAICSD1V01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:supl.032.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using DTCCCAICSD1V01.ToDocument() method. The returned DTCCCAICSD1V01Document value will serialize correctly according to ISO 20022 standards.
classDiagram DTCCCAICSD1V01Document *-- DTCCCAICSD1V01 : 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:supl.032.001.01">
<DTCCCAICSD1>
<ReorgInstrCxlDtls>
<!-- ReorganisationInstructionCancellationDetails inner content -->
</ReorgInstrCxlDtls>
</DTCCCAICSD1>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_b8UwkL5OEeexmbB7KsjCwA"
nextVersions="_b_h_beaHEei5aPS232E3Mw"
name="DTCCCAICSD1V01"
definition="The DTCCCAICSD1 message extends ISO corporate action Instruction Cancellation Request (CAIC) message with DTCC corporate action elements not covered in the standard message."
registrationStatus="Registered"
messageSet="_f180QGxSEeKtkPXDQKdgxQ"
xmlTag="DTCCCAICSD1"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_fcQ_wMYxEeesocHIuVGr7g"
nextVersions="_b_h_b-aHEei5aPS232E3Mw"
name="ReorganisationInstructionCancellationDetails"
definition="Supplementary data extending corporate action instruction cancellation request message with corporate action reorganisation elements not covered in the standard message."
registrationStatus="Provisionally Registered"
maxOccurs="12"
minOccurs="0"
xmlTag="ReorgInstrCxlDtls"
complexType="_FD_2EMYyEeesocHIuVGr7g" />
<messageDefinitionIdentifier
businessArea="supl"
messageFunctionality="032"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.