seev.040.002.08
Scope The CorporateActionInstructionCancellationRequest message is sent by an account owner to an account servicer to request cancellation of a previously sent corporate action election instruction. Usage The message may also be used to:
- re-send a message previously sent (the sub-function of the message is Duplicate),
- provide a third party with a copy of a message for information (the sub-function of the message is Copy),
- re-send to a third party a copy of a message for information (the sub-function of the message is Copy Duplicate), using the relevant elements in the business application header (BAH).
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 %% CorporateActionInstructionCancellationRequest002V08 recursion level 0 with max 0 class CorporateActionInstructionCancellationRequest002V08{ ChangeInstructionIndicator IsoYesNoIndicator } CorporateActionInstructionCancellationRequest002V08 *-- "1..1" DocumentIdentification37 : InstructionIdentification CorporateActionInstructionCancellationRequest002V08 *-- "1..1" CorporateActionGeneralInformation121 : CorporateActionGeneralInformation CorporateActionInstructionCancellationRequest002V08 *-- "1..1" AccountIdentification49 : AccountDetails CorporateActionInstructionCancellationRequest002V08 *-- "1..1" CorporateActionOption128 : CorporateActionInstruction CorporateActionInstructionCancellationRequest002V08 *-- "0..1" ProtectInstruction7 : ProtectInstruction CorporateActionInstructionCancellationRequest002V08 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
ChangeInstructionIndicator building block
When used in a corporate action instruction, indicates that the current instruction is replacing a previous one that was cancelled earlier. When used in a corporate action instruction cancellation request, indicates that cancelled instruction will be replaced by a new corporate action instruction to be sent later. Indicates a “Yes” or “No” type of answer for an element. For comparison, see the ISO20022 official specification This message is declared as YesNoIndicator in the ISO specification. In our implementation, it is represented in source code as IsoYesNoIndicator. Due to global using directives, it is treated as a System.String by the compiler and runtime.
InstructionIdentification building block
Identification of a previously sent instruction document. Identification of a document and type of link. For comparison, see the ISO20022 official specification
classDiagram direction tb %% DocumentIdentification37 recursion level 0 with max 1 class DocumentIdentification37{ Identification IsoRestrictedFINXMax16Text } DocumentIdentification37 *-- "0..1" IProcessingPosition10Choice : LinkageType %% IProcessingPosition10Choice recursion level 1 with max 1
DocumentIdentification37 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Identification | Identifies the document. | IsoRestrictedFINXMax16Text - Required 1..1 |
LinkageType | Specifies when this document is to be processed relative to another referred document. | IProcessingPosition10Choice - Optional 0..1 |
CorporateActionGeneralInformation building block
General information about the corporate action event. General information about the corporate action event. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionGeneralInformation121 recursion level 0 with max 1 class CorporateActionGeneralInformation121{ CorporateActionEventIdentification IsoRestrictedFINXMax16Text OfficialCorporateActionEventIdentification IsoRestrictedFINXMax16Text } CorporateActionGeneralInformation121 *-- "1..1" ICorporateActionEventType58Choice : EventType CorporateActionGeneralInformation121 *-- "0..1" SecurityIdentification21 : FinancialInstrumentIdentification %% ICorporateActionEventType58Choice recursion level 1 with max 1 %% SecurityIdentification21 recursion level 1 with max 1 class SecurityIdentification21{ ISIN IsoISINOct2015Identifier Description IsoRestrictedFINXMax140Text } SecurityIdentification21 *-- "0..0" OtherIdentification2 : OtherIdentification
CorporateActionGeneralInformation121 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
CorporateActionEventIdentification | Reference assigned by the account servicer to unambiguously identify a corporate action event. | IsoRestrictedFINXMax16Text - Required 1..1 |
OfficialCorporateActionEventIdentification | Official and unique reference assigned by the official central body/entity within each market at the beginning of a corporate action event. | IsoRestrictedFINXMax16Text - Optional 0..1 |
EventType | Type of corporate action event. | ICorporateActionEventType58Choice - Required 1..1 |
FinancialInstrumentIdentification | Identification of the security concerned by the corporate action. | SecurityIdentification21 - Optional 0..1 |
AccountDetails building block
General information about the safekeeping account and the account owner. Provides account identification information. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AccountIdentification49 recursion level 0 with max 1 class AccountIdentification49{ SafekeepingAccount IsoRestrictedFINXMax35Text } AccountIdentification49 *-- "0..1" IPartyIdentification136Choice : AccountOwner AccountIdentification49 *-- "0..1" ISafekeepingPlaceFormat34Choice : SafekeepingPlace %% IPartyIdentification136Choice recursion level 1 with max 1 %% ISafekeepingPlaceFormat34Choice recursion level 1 with max 1
AccountIdentification49 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
SafekeepingAccount | Account where financial instruments are maintained. | IsoRestrictedFINXMax35Text - Required 1..1 |
AccountOwner | Party that legally owns the account. | IPartyIdentification136Choice - Optional 0..1 |
SafekeepingPlace | Location where the financial instruments are/will be safekept. | ISafekeepingPlaceFormat34Choice - Optional 0..1 |
CorporateActionInstruction building block
Information about the corporate action option. Provides information about the corporate action option. For comparison, see the ISO20022 official specification
classDiagram direction tb %% CorporateActionOption128 recursion level 0 with max 1 CorporateActionOption128 *-- "1..1" IOptionNumber1Choice : OptionNumber CorporateActionOption128 *-- "1..1" ICorporateActionOption29Choice : OptionType CorporateActionOption128 *-- "1..1" IQuantity40Choice : InstructedQuantity %% IOptionNumber1Choice recursion level 1 with max 1 %% ICorporateActionOption29Choice recursion level 1 with max 1 %% IQuantity40Choice recursion level 1 with max 1
CorporateActionOption128 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
OptionNumber | Number identifying the available corporate action options. | IOptionNumber1Choice - Required 1..1 |
OptionType | Specifies the corporate action options available to the account owner. | ICorporateActionOption29Choice - Required 1..1 |
InstructedQuantity | Quantity of securities to which this instruction applies. | IQuantity40Choice - Required 1..1 |
ProtectInstruction building block
Provides detailed information on protect and cover protect instructions. Provides detailed information on protect and cover protect instructions. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ProtectInstruction7 recursion level 0 with max 1 class ProtectInstruction7{ TransactionType ProtectTransactionType3Code TransactionIdentification IsoRestrictedFINMax15Text ProtectDate IsoISODate }
ProtectInstruction7 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
TransactionType | Indicates whether the instruction is a protect or a cover protect instruction. | ProtectTransactionType3Code - Required 1..1 |
TransactionIdentification | Unique reference of the protect transaction assigned by the depository and used for cover protect validation. | IsoRestrictedFINMax15Text - Optional 0..1 |
ProtectDate | Date at which the protect instruction was created and used for cover protect validation. | IsoISODate - Optional 0..1 |
SupplementaryData building block
Additional information that can not be captured in the structured fields 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 CorporateActionInstructionCancellationRequest002V08 implementation follows a specific implementaiton pattern. First of all, CorporateActionInstructionCancellationRequest002V08 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CorporateActionInstructionCancellationRequest002V08Document implements IOuterDocument. Because CorporateActionInstructionCancellationRequest002V08 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CorporateActionInstructionCancellationRequest002V08.
classDiagram class IOuterRecord CorporateActionInstructionCancellationRequest002V08 --|> IOuterRecord : Implements CorporateActionInstructionCancellationRequest002V08Document --|> IOuterDocument~CorporateActionInstructionCancellationRequest002V08~ : Implements class IOuterDocument~CorporateActionInstructionCancellationRequest002V08~ { CorporateActionInstructionCancellationRequest002V08 Message }
Document wrapper for serialization
The only real purpose CorporateActionInstructionCancellationRequest002V08Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:seev.040.002.08’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CorporateActionInstructionCancellationRequest002V08.ToDocument() method. The returned CorporateActionInstructionCancellationRequest002V08Document value will serialize correctly according to ISO 20022 standards.
classDiagram CorporateActionInstructionCancellationRequest002V08Document *-- CorporateActionInstructionCancellationRequest002V08 : 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:seev.040.002.08">
<CorpActnInstrCxlReq>
<ChngInstrInd>
<!-- ChangeInstructionIndicator inner content -->
</ChngInstrInd>
<InstrId>
<!-- InstructionIdentification inner content -->
</InstrId>
<CorpActnGnlInf>
<!-- CorporateActionGeneralInformation inner content -->
</CorpActnGnlInf>
<AcctDtls>
<!-- AccountDetails inner content -->
</AcctDtls>
<CorpActnInstr>
<!-- CorporateActionInstruction inner content -->
</CorpActnInstr>
<PrtctInstr>
<!-- ProtectInstruction inner content -->
</PrtctInstr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CorpActnInstrCxlReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_9C1Lo_fEEeiNZp_PtLohLw"
nextVersions="_yqZWUwVREeqjd8n6wD9JVw"
previousVersion="_wjTylZwtEeazcsnODTksnQ"
name="CorporateActionInstructionCancellationRequest002V08"
definition="Scope
The CorporateActionInstructionCancellationRequest message is sent by an account owner to an account servicer to request cancellation of a previously sent corporate action election instruction.
Usage
The message may also be used to:
- re-send a message previously sent (the sub-function of the message is Duplicate),
- provide a third party with a copy of a message for information (the sub-function of the message is Copy),
- re-send to a third party a copy of a message for information (the sub-function of the message is Copy Duplicate), using the relevant elements in the business application header (BAH)."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="CorpActnInstrCxlReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_9C1LpffEEeiNZp_PtLohLw"
name="ChangeInstructionIndicatorGuideline"
definition="ChangeInstructionIndicator may only be used if CorporateActionOptionDetails/WithdrawalAllowedIndicator was set to 'false' or '0' (No) in the CorporateActionNotification message previously received and if CorporateActionOptionDetails/ChangeAllowedIndicator was set to 'true' or '1' (Yes) in the CorporateActionNotification message previously received."
registrationStatus="Provisionally Registered" />
<constraint
xmi:id="_9C1Lp_fEEeiNZp_PtLohLw"
name="CorporateActionEventIdentificationRule"
definition="If the CorporateActionInstruction message was unsolicited (that is, this instruction has not been preceded by a CorporateActionNotification), then, CorporateActionGeneralInformation/CorporateActionEventIdentification must be NONREF."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_9C1LqffEEeiNZp_PtLohLw"
name="ChangeInstructionIndicator"
definition="When used in a corporate action instruction, indicates that the current instruction is replacing a previous one that was cancelled earlier. When used in a corporate action instruction cancellation request, indicates that cancelled instruction will be replaced by a new corporate action instruction to be sent later."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="ChngInstrInd"
simpleType="_YXbjA9p-Ed-ak6NoX_4Aeg_-2040117978" />
<messageBuildingBlock
xmi:id="_9C1Lq_fEEeiNZp_PtLohLw"
name="InstructionIdentification"
definition="Identification of a previously sent instruction document."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="InstrId"
complexType="_chT0l5KQEeWHWpTQn1FFVg" />
<messageBuildingBlock
xmi:id="_9C1LrffEEeiNZp_PtLohLw"
name="CorporateActionGeneralInformation"
definition="General information about the corporate action event."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CorpActnGnlInf"
complexType="_wjTy45wtEeazcsnODTksnQ" />
<messageBuildingBlock
xmi:id="_9C1Lr_fEEeiNZp_PtLohLw"
name="AccountDetails"
definition="General information about the safekeeping account and the account owner."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="AcctDtls"
complexType="_9C2Zw_fEEeiNZp_PtLohLw" />
<messageBuildingBlock
xmi:id="_9C1LsffEEeiNZp_PtLohLw"
name="CorporateActionInstruction"
definition="Information about the corporate action option."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CorpActnInstr"
complexType="_VyigHZqLEeWcAIE4lEkF_Q" />
<messageBuildingBlock
xmi:id="_9C1Ls_fEEeiNZp_PtLohLw"
name="ProtectInstruction"
definition="Provides detailed information on protect and cover protect instructions."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PrtctInstr"
complexType="_FLSgEf0hEeiKOe8GCUL1Lg" />
<messageBuildingBlock
xmi:id="_9C1LtffEEeiNZp_PtLohLw"
name="SupplementaryData"
definition="Additional information that can not be captured in the structured fields and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="seev"
messageFunctionality="040"
flavour="002"
version="08" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.