SwitchOrderCancellationInstructionV02

setr.014.001.02

Scope The SwitchOrderCancellationInstruction message is sent by an instructing party, eg, an investment manager or its authorised representative, to an executing party, eg, a transfer agent. There may be one or more intermediary parties between the instructing party and the executing party. The intermediary party is, for example, an intermediary or a concentrator. This message is sent to cancel a previously sent SwitchOrderInstruction message. Usage The SwitchOrderCancellationInstruction message is used to cancel the entire previously sent SwitchOrder message and all the individual legs that it contains. There is no amendment, but a cancellation and re-instruct policy. This message must contain the reference of the message to be cancelled. This message may also contain all the details of the message to be cancelled, but this is not recommended. The deadline and acceptance of a cancellation instruction is subject to a service level agreement (SLA). This cancellation message is a cancellation instruction. There is no automatic acceptance of the cancellation instruction. The rejection or acceptance of a cancellation message instruction is made using an OrderCancellationStatusReport 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
%% SwitchOrderCancellationInstructionV02 recursion level 0 with max 0
SwitchOrderCancellationInstructionV02 *-- "0..1" AdditionalReference3 : MasterReference
SwitchOrderCancellationInstructionV02 *-- "0..1" AdditionalReference3 : PoolReference
SwitchOrderCancellationInstructionV02 *-- "1..1" AdditionalReference3 : PreviousReference
SwitchOrderCancellationInstructionV02 *-- "0..1" SwitchOrderInstruction1 : OrderToBeCancelled
  

Now, we will zero-in one-by-one on each of these building blocks.

MasterReference building block

Reference assigned to a set of orders or trades in order to link them together. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

PoolReference building block

Collective reference identifying a set of messages. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

PreviousReference building block

Reference to a linked message that was previously sent. References a related message or provides another reference, such as a pool reference, linking a set of messages. The party which issued the related reference may be the Sender of the referenced message or a party other than the Sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AdditionalReference3 recursion level 0 with max 1
class AdditionalReference3{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference3 *-- "0..1" IPartyIdentification2Choice : ReferenceIssuer
%% IPartyIdentification2Choice recursion level 1 with max 1
  

AdditionalReference3 members

OrderToBeCancelled building block

Common information related to all the orders to be cancelled. Information about a switch order. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SwitchOrderInstruction1 recursion level 0 with max 1
SwitchOrderInstruction1 *-- "1..1" SwitchOrder2 : SwitchOrderDetails
SwitchOrderInstruction1 *-- "0..10" Intermediary4 : IntermediaryDetails
SwitchOrderInstruction1 *-- "0..1" CopyInformation1 : CopyDetails
SwitchOrderInstruction1 *-- "0..0" Extension1 : Extension
%% SwitchOrder2 recursion level 1 with max 1
class SwitchOrder2{
    OrderDateTime IsoISODateTime
    OrderReference IsoMax35Text
    TotalRedemptionAmount IsoActiveOrHistoricCurrencyAndAmount
    TotalSubscriptionAmount IsoActiveOrHistoricCurrencyAndAmount
    ExpiryDateTime IsoISODateTime
    AdditionalCashIn IsoActiveOrHistoricCurrencyAndAmount
    ResultingCashOut IsoActiveOrHistoricCurrencyAndAmount
}
SwitchOrder2 *-- "1..1" InvestmentAccount13 : InvestmentAccountDetails
SwitchOrder2 *-- "0..1" CancellationRight1 : CancellationRight
SwitchOrder2 *-- "1..0" SwitchRedemptionLegOrder2 : RedemptionLegDetails
SwitchOrder2 *-- "1..0" SwitchSubscriptionLegOrder2 : SubscriptionLegDetails
SwitchOrder2 *-- "0..1" PaymentTransaction20 : CashSettlementDetails
SwitchOrder2 *-- "0..1" ForeignExchangeTerms5 : ForeignExchangeDetails
%% Intermediary4 recursion level 1 with max 1
class Intermediary4{
    Role IsoMax35Text
}
Intermediary4 *-- "1..1" IPartyIdentification2Choice : Identification
Intermediary4 *-- "0..1" Account2 : Account
%% CopyInformation1 recursion level 1 with max 1
class CopyInformation1{
    CopyIndicator IsoYesNoIndicator
}
CopyInformation1 *-- "1..1" BICIdentification1 : OriginalReceiver
%% Extension1 recursion level 1 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}
  

SwitchOrderInstruction1 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the SwitchOrderCancellationInstructionV02 implementation follows a specific implementaiton pattern. First of all, SwitchOrderCancellationInstructionV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SwitchOrderCancellationInstructionV02Document implements IOuterDocument. Because SwitchOrderCancellationInstructionV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SwitchOrderCancellationInstructionV02.

classDiagram
    class IOuterRecord
    SwitchOrderCancellationInstructionV02 --|> IOuterRecord : Implements
    SwitchOrderCancellationInstructionV02Document --|> IOuterDocument~SwitchOrderCancellationInstructionV02~ : Implements
    class IOuterDocument~SwitchOrderCancellationInstructionV02~ {
        SwitchOrderCancellationInstructionV02 Message
     }
  

Document wrapper for serialization

The only real purpose SwitchOrderCancellationInstructionV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.014.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SwitchOrderCancellationInstructionV02.ToDocument() method. The returned SwitchOrderCancellationInstructionV02Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    SwitchOrderCancellationInstructionV02Document *-- SwitchOrderCancellationInstructionV02 : 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:setr.014.001.02">
    <setr.014.001.02>
        <MstrRef>
            <!-- MasterReference inner content -->
        </MstrRef>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <OrdrToBeCanc>
            <!-- OrderToBeCancelled inner content -->
        </OrdrToBeCanc>
    </setr.014.001.02>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_5nvohtE7Ed-BzquC8wXy7w_943117646"
  nextVersions="_6CayWNE7Ed-BzquC8wXy7w_1787145028"
  name="SwitchOrderCancellationInstructionV02"
  definition="Scope&#xD;&#xA;The SwitchOrderCancellationInstruction message is sent by an instructing party, eg, an investment manager or its authorised representative, to an executing party, eg, a transfer agent. There may be one or more intermediary parties between the instructing party and the executing party. The intermediary party is, for example, an intermediary or a concentrator.&#xD;&#xA;This message is sent to cancel a previously sent SwitchOrderInstruction message.&#xD;&#xA;Usage&#xD;&#xA;The SwitchOrderCancellationInstruction message is used to cancel the entire previously sent SwitchOrder message and all the individual legs that it contains. There is no amendment, but a cancellation and re-instruct policy.&#xD;&#xA;This message must contain the reference of the message to be cancelled. This message may also contain all the details of the message to be cancelled, but this is not recommended.&#xD;&#xA;The deadline and acceptance of a cancellation instruction is subject to a service level agreement (SLA). This cancellation message is a cancellation instruction. There is no automatic acceptance of the cancellation instruction.&#xD;&#xA;The rejection or acceptance of a cancellation message instruction is made using an OrderCancellationStatusReport message."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="setr.014.001.02"
  xmlTag="setr.014.001.02"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_5n4ycdE7Ed-BzquC8wXy7w_1017921410"
    name="SwitchRule"
    definition="The cancellation of a switch order must be a full cancellation. Partial cancellations are not allowed e.g. cancellation of a given leg."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_5n4ydNE7Ed-BzquC8wXy7w_1020690124"
    name="AccountIdentificationRule"
    definition="If this message is linked to an account opening request and the account identification is not yet known then the value of the AccountIdentification element in OrderToBeCancelled/SwitchOrderDetails/InvestmentAccountDetails must be UNKNOWN."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_5nvoh9E7Ed-BzquC8wXy7w_-851724963"
    name="MasterReference"
    definition="Reference assigned to a set of orders or trades in order to link them together."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="MstrRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_5nvoiNE7Ed-BzquC8wXy7w_-849878392"
    name="PoolReference"
    definition="Collective reference identifying a set of messages."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PoolRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_5nvoidE7Ed-BzquC8wXy7w_-846184674"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="PrvsRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_5n4ycNE7Ed-BzquC8wXy7w_-473740114"
    name="OrderToBeCancelled"
    definition="Common information related to all the orders to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="OrdrToBeCanc"
    complexType="_Uzce69p-Ed-ak6NoX_4Aeg_-530074752" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="014"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.