SwitchOrderCancellationRequestV04

setr.014.001.04

Scope The SwitchOrderCancellationRequest message is sent by an instructing party, for example, an investment manager or its authorised representative, to the executing party, for example, a transfer agent, to request the cancellation of a previously sent SwitchOrder instruction. Usage The SwitchOrderCancellationRequest is used to cancel the entire previously sent SwitchOrder instruction/s and all the individual legs that it contains. There is no amendment, but a cancellation and re-instruct policy. To request the cancellation of a switch order, the order reference of the original switch order is quoted in the order reference element. The message identification of the SwitchOrder message may also be quoted in PreviousReference but this is not recommended. The deadline and acceptance of a cancellation request is subject to a service level agreement (SLA). This cancellation message is a cancellation request. There is no automatic acceptance of the cancellation request. The rejection or acceptance of a SwitchOrderCancellationRequest 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
%% SwitchOrderCancellationRequestV04 recursion level 0 with max 0
class SwitchOrderCancellationRequestV04{
    MasterReference IsoMax35Text
}
SwitchOrderCancellationRequestV04 *-- "1..1" MessageIdentification1 : MessageIdentification
SwitchOrderCancellationRequestV04 *-- "0..1" AdditionalReference9 : PoolReference
SwitchOrderCancellationRequestV04 *-- "0..1" AdditionalReference8 : PreviousReference
SwitchOrderCancellationRequestV04 *-- "1..1" InvestmentFundOrder9 : OrderReferences
SwitchOrderCancellationRequestV04 *-- "0..1" CopyInformation4 : CopyDetails
  

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

MessageIdentification building block

Reference that uniquely identifies the message from a business application standpoint. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageIdentification1 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
%% AdditionalReference9 recursion level 0 with max 1
class AdditionalReference9{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference9 *-- "0..1" PartyIdentification113 : ReferenceIssuer
%% PartyIdentification113 recursion level 1 with max 1
class PartyIdentification113{
    LEI IsoLEIIdentifier
}
PartyIdentification113 *-- "1..1" IPartyIdentification90Choice : Party
  

AdditionalReference9 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
%% AdditionalReference8 recursion level 0 with max 1
class AdditionalReference8{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference8 *-- "0..1" PartyIdentification113 : ReferenceIssuer
%% PartyIdentification113 recursion level 1 with max 1
class PartyIdentification113{
    LEI IsoLEIIdentifier
}
PartyIdentification113 *-- "1..1" IPartyIdentification90Choice : Party
  

AdditionalReference8 members

MasterReference building block

Reference assigned to a set of orders or trades in order to link them together. Specifies a character string with a maximum length of 35 characters. For comparison, see the ISO20022 official specification This message is declared as Max35Text in the ISO specification. In our implementation, it is represented in source code as IsoMax35Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

OrderReferences building block

Identification of the individual order to be cancelled. References of an order and order cancellation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% InvestmentFundOrder9 recursion level 0 with max 1
class InvestmentFundOrder9{
    OrderReference IsoMax35Text
    ClientReference IsoMax35Text
    CancellationReference IsoMax35Text
}
InvestmentFundOrder9 *-- "0..1" ICancellationReason32Choice : CancellationReason
%% ICancellationReason32Choice recursion level 1 with max 1
  

InvestmentFundOrder9 members

CopyDetails building block

Information provided when the message is a copy of a previous message. Information provided when the message is a copy of a previous message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CopyInformation4 recursion level 0 with max 1
class CopyInformation4{
    CopyIndicator IsoYesNoIndicator
    OriginalReceiver IsoAnyBICIdentifier
}
  

CopyInformation4 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    SwitchOrderCancellationRequestV04 --|> IOuterRecord : Implements
    SwitchOrderCancellationRequestV04Document --|> IOuterDocument~SwitchOrderCancellationRequestV04~ : Implements
    class IOuterDocument~SwitchOrderCancellationRequestV04~ {
        SwitchOrderCancellationRequestV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    SwitchOrderCancellationRequestV04Document *-- SwitchOrderCancellationRequestV04 : 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.04">
    <SwtchOrdrCxlReq>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <MstrRef>
            <!-- MasterReference inner content -->
        </MstrRef>
        <OrdrRefs>
            <!-- OrderReferences inner content -->
        </OrdrRefs>
        <CpyDtls>
            <!-- CopyDetails inner content -->
        </CpyDtls>
    </SwtchOrdrCxlReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Aab6-TbLEead9bDRE_1DAQ"
  previousVersion="_6CayWNE7Ed-BzquC8wXy7w_1787145028"
  name="SwitchOrderCancellationRequestV04"
  definition="Scope&#xD;&#xA;The SwitchOrderCancellationRequest message is sent by an instructing party, for example, an investment manager or its authorised representative, to the executing party, for example, a transfer agent, to request the cancellation of a previously sent SwitchOrder instruction.&#xD;&#xA;Usage&#xD;&#xA;The SwitchOrderCancellationRequest is used to cancel the entire previously sent SwitchOrder instruction/s and all the individual legs that it contains. There is no amendment, but a cancellation and re-instruct policy.&#xD;&#xA;To request the cancellation of a switch order, the order reference of the original switch order is quoted in the order reference element. The message identification of the SwitchOrder message may also be quoted in PreviousReference but this is not recommended.&#xD;&#xA;The deadline and acceptance of a cancellation request is subject to a service level agreement (SLA). This cancellation message is a cancellation request. There is no automatic acceptance of the cancellation request.&#xD;&#xA;The rejection or acceptance of a SwitchOrderCancellationRequest is made using an OrderCancellationStatusReport message."
  registrationStatus="Registered"
  messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
  xmlTag="SwtchOrdrCxlReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_Aab6-zbLEead9bDRE_1DAQ"
    previousVersion="_6Cj8RNE7Ed-BzquC8wXy7w_1787145268"
    name="SwitchRule"
    definition="The cancellation of a switch order must be a full cancellation. Partial cancellations are not allowed, for example, the cancellation of a given leg."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_Aab7ATbLEead9bDRE_1DAQ"
    previousVersion="_6CayWdE7Ed-BzquC8wXy7w_264063025"
    name="MessageIdentification"
    definition="Reference that uniquely identifies the message from a business application standpoint."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_Aab7AzbLEead9bDRE_1DAQ"
    previousVersion="_6CayWtE7Ed-BzquC8wXy7w_1787145131"
    name="PoolReference"
    definition="Collective reference identifying a set of messages."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PoolRef"
    complexType="_N4g3EXETEea2e4bzJ8TyEw" />
  <messageBuildingBlock
    xmi:id="_Aab7BTbLEead9bDRE_1DAQ"
    previousVersion="_6Cj8QNE7Ed-BzquC8wXy7w_1787145191"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PrvsRef"
    complexType="_udnPoTbsEead9bDRE_1DAQ" />
  <messageBuildingBlock
    xmi:id="_W4-yglAYEea5nPE5ezGuuw"
    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"
    simpleType="_YW1tKdp-Ed-ak6NoX_4Aeg_1913463446" />
  <messageBuildingBlock
    xmi:id="_W4-yg1AYEea5nPE5ezGuuw"
    name="OrderReferences"
    definition="Identification of the individual order to be cancelled."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="OrdrRefs"
    complexType="_bxbpIUTpEeaFv6weEmLwpA" />
  <messageBuildingBlock
    xmi:id="_Aab7CzbLEead9bDRE_1DAQ"
    previousVersion="_6Cj8Q9E7Ed-BzquC8wXy7w_-925024126"
    name="CopyDetails"
    definition="Information provided when the message is a copy of a previous message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CpyDtls"
    complexType="_7VUJ8degEeSA_uUacqhl1Q" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="014"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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