supl.010.001.03
The DTCCCAPSSD1 message extends ISO corporate action event processing status advice 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 %% DTCCCAPSSD1V03 recursion level 0 with max 0 DTCCCAPSSD1V03 *-- "0..1" CorporateActionGeneralInformationSD17 : CorporateActionGeneralInformation DTCCCAPSSD1V03 *-- "0..1" CorporateActionSD9 : CorporateActionDetails
Now, we will zero-in one-by-one on each of these building blocks.
CorporateActionGeneralInformation building block
Extension block for the information to be extended as corporate action general information. Provides additional information regarding corporate action general information. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionGeneralInformationSD17 recursion level 0 with max 1 class CorporateActionGeneralInformationSD17{ PlaceAndName IsoMax350Text SafekeepingAccount IsoRestrictedFINXMax35Text } CorporateActionGeneralInformationSD17 *-- "1..1" SecurityIdentification15 : SecurityIdentification CorporateActionGeneralInformationSD17 *-- "0..0" CorporateActionUnallocatedDetailsSD3 : UnallocatedDetails %% SecurityIdentification15 recursion level 1 with max 1 class SecurityIdentification15{ ISIN IsoISINIdentifier Description IsoRestrictedFINXMax140Text } SecurityIdentification15 *-- "0..0" OtherIdentification2 : OtherIdentification %% CorporateActionUnallocatedDetailsSD3 recursion level 1 with max 1 CorporateActionUnallocatedDetailsSD3 *-- "0..1" ICorporateActionUnallocatedBalanceSD2Choice : UnallocatedDistributionBalance CorporateActionUnallocatedDetailsSD3 *-- "0..1" CorporateActionUnallocatedBalanceSD1 : UnallocatedRedemptionBalance CorporateActionUnallocatedDetailsSD3 *-- "0..0" CorporateActionUnallocatedSecuritiesTransactionDetailsSD4 : UnallocatedSecuritiesTransactionDetails CorporateActionUnallocatedDetailsSD3 *-- "0..0" CorporateActionUnallocatedCashTransactionDetailsSD3 : UnallocatedCashTransactionDetails
CorporateActionGeneralInformationSD17 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | xPath to the element that is being extended. | IsoMax350Text - Required 1..1 |
SecurityIdentification | Identifies the financial instrument. | SecurityIdentification15 - Required 1..1 |
SafekeepingAccount | Account where financial instruments are maintained. | IsoRestrictedFINXMax35Text - Required 1..1 |
UnallocatedDetails | Additional information about the corporate action event. | CorporateActionUnallocatedDetailsSD3 - Unknown 0..0 |
CorporateActionDetails building block
Information to be extended as supplementary data to corporate action details. Provides additional information regarding corporate action details. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionSD9 recursion level 0 with max 1 class CorporateActionSD9{ PlaceAndName IsoMax350Text RecordDate IsoISODate LotteryDate IsoISODate LotteryType LotteryType1Code } CorporateActionSD9 *-- "0..1" IDateFormat28Choice : PaymentDate %% IDateFormat28Choice recursion level 1 with max 1
CorporateActionSD9 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PlaceAndName | xPath to the element that is being extended. | IsoMax350Text - Required 1..1 |
RecordDate | Date at which positions are stuck at the end of the day to note which parties will receive the relevant amount of entitlement, due to be distributed on payment date. DTC (The Depository Trust Corporation) and its Participants may use this as a reference. | IsoISODate - Optional 0..1 |
PaymentDate | Date/time at which the movement was due to take place (cash and/or securities). | IDateFormat28Choice - Optional 0..1 |
LotteryDate | Date/time on which the lottery is run and applied to the holder’s positions. This is also applicable to partial calls. | IsoISODate - Optional 0..1 |
LotteryType | Specifies the type of lottery announced. | LotteryType1Code - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the DTCCCAPSSD1V03 implementation follows a specific implementaiton pattern. First of all, DTCCCAPSSD1V03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, DTCCCAPSSD1V03Document implements IOuterDocument. Because DTCCCAPSSD1V03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type DTCCCAPSSD1V03.
classDiagram class IOuterRecord DTCCCAPSSD1V03 --|> IOuterRecord : Implements DTCCCAPSSD1V03Document --|> IOuterDocument~DTCCCAPSSD1V03~ : Implements class IOuterDocument~DTCCCAPSSD1V03~ { DTCCCAPSSD1V03 Message }
Document wrapper for serialization
The only real purpose DTCCCAPSSD1V03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:supl.010.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using DTCCCAPSSD1V03.ToDocument() method. The returned DTCCCAPSSD1V03Document value will serialize correctly according to ISO 20022 standards.
classDiagram DTCCCAPSSD1V03Document *-- DTCCCAPSSD1V03 : 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.010.001.03">
<DTCCCAPSSD1>
<CorpActnGnlInf>
<!-- CorporateActionGeneralInformation inner content -->
</CorpActnGnlInf>
<CorpActnDtls>
<!-- CorporateActionDetails inner content -->
</CorpActnDtls>
</DTCCCAPSSD1>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_2E1aY6FJEeSK_vfd3NHBGg"
nextVersions="_X0scRZ2EEeW-bsa36JFb9A"
previousVersion="_eaasX12lEeOb__BffbPEig"
name="DTCCCAPSSD1V03"
definition="The DTCCCAPSSD1 message extends ISO corporate action event processing status advice message with DTCC corporate action elements not covered in the standard message."
registrationStatus="Provisionally Registered"
xmlTag="DTCCCAPSSD1"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_2E1aZaFJEeSK_vfd3NHBGg"
nextVersions="_X0scR52EEeW-bsa36JFb9A"
previousVersion="_eaasYV2lEeOb__BffbPEig"
name="CorporateActionGeneralInformation"
definition="Extension block for the information to be extended as corporate action general information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CorpActnGnlInf"
complexType="_d7b0IaIREeS6IulNYwkZBg">
<semanticMarkup
xmi:id="_2E1aZ6FJEeSK_vfd3NHBGg"
type="Synonym">
<elements
xmi:id="_2E1aaaFJEeSK_vfd3NHBGg"
name="context"
value="DTCC" />
<elements
xmi:id="_2E1aa6FJEeSK_vfd3NHBGg"
name="value"
value="Event (Details)" />
</semanticMarkup>
</messageBuildingBlock>
<messageBuildingBlock
xmi:id="_2E1abaFJEeSK_vfd3NHBGg"
nextVersions="_X0scT52EEeW-bsa36JFb9A"
previousVersion="_MH2w4GJWEeOfOt7Y7nAPUA"
name="CorporateActionDetails"
definition="Information to be extended as supplementary data to corporate action details."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="CorpActnDtls"
complexType="_VIg5E2JWEeOfOt7Y7nAPUA" />
<messageDefinitionIdentifier
businessArea="supl"
messageFunctionality="010"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.