RedemptionOrderConfirmationCancellationInstructionV02

setr.051.001.02

Scope The RedemptionOrderConfirmationCancellationInstruction message is sent by an executing party, for example, a transfer agent, to the instructing party, for example, an investment manager or its authorised representative, to cancel a previously sent RedemptionOrderConfirmation. Usage To request the cancellation of one or more individual order executions, the order reference and deal reference of each individual order execution in the original RedemptionOrderConfirmation are specified in the order reference and deal reference elements respectively. The message identification of the RedemptionOrderConfirmation message in which the individual order execution was conveyed may also be quoted in PreviousReference but this is not recommended. The AmendmentIndicator is used to specify whether the redemption order confirmation cancellation is to be followed by an amendment An amendment of a redemption order confirmation is carried out by sending a RedemptionOrderConfirmation message in which the AmendmentIndicator contains the value ‘true’.

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
%% RedemptionOrderConfirmationCancellationInstructionV02 recursion level 0 with max 0
class RedemptionOrderConfirmationCancellationInstructionV02{
    AmendmentIndicator IsoYesNoIndicator
    MasterReference IsoMax35Text
}
RedemptionOrderConfirmationCancellationInstructionV02 *-- "1..1" MessageIdentification1 : MessageIdentification
RedemptionOrderConfirmationCancellationInstructionV02 *-- "0..1" AdditionalReference9 : PoolReference
RedemptionOrderConfirmationCancellationInstructionV02 *-- "0..1" AdditionalReference8 : PreviousReference
RedemptionOrderConfirmationCancellationInstructionV02 *-- "0..1" AdditionalReference8 : RelatedReference
RedemptionOrderConfirmationCancellationInstructionV02 *-- "1..1" InvestmentFundOrder11 : OrderReferences
RedemptionOrderConfirmationCancellationInstructionV02 *-- "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

RelatedReference building block

Reference to a linked message that was previously received. 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

AmendmentIndicator building block

Indicates whether a confirmation amendment message will follow the confirmation cancellation instruction or not. 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.

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 confirmation to be cancelled. References of an order confirmation and an order confirmation cancellation. For comparison, see the ISO20022 official specification

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

InvestmentFundOrder11 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 RedemptionOrderConfirmationCancellationInstructionV02 implementation follows a specific implementaiton pattern. First of all, RedemptionOrderConfirmationCancellationInstructionV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RedemptionOrderConfirmationCancellationInstructionV02Document implements IOuterDocument. Because RedemptionOrderConfirmationCancellationInstructionV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RedemptionOrderConfirmationCancellationInstructionV02.

classDiagram
    class IOuterRecord
    RedemptionOrderConfirmationCancellationInstructionV02 --|> IOuterRecord : Implements
    RedemptionOrderConfirmationCancellationInstructionV02Document --|> IOuterDocument~RedemptionOrderConfirmationCancellationInstructionV02~ : Implements
    class IOuterDocument~RedemptionOrderConfirmationCancellationInstructionV02~ {
        RedemptionOrderConfirmationCancellationInstructionV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    RedemptionOrderConfirmationCancellationInstructionV02Document *-- RedemptionOrderConfirmationCancellationInstructionV02 : 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.051.001.02">
    <RedOrdrConfCxlInstr>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <AmdmntInd>
            <!-- AmendmentIndicator inner content -->
        </AmdmntInd>
        <MstrRef>
            <!-- MasterReference inner content -->
        </MstrRef>
        <OrdrRefs>
            <!-- OrderReferences inner content -->
        </OrdrRefs>
        <CpyDtls>
            <!-- CopyDetails inner content -->
        </CpyDtls>
    </RedOrdrConfCxlInstr>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Aab7szbLEead9bDRE_1DAQ"
  previousVersion="_t5eDiNE7Ed-BzquC8wXy7w_-947588011"
  name="RedemptionOrderConfirmationCancellationInstructionV02"
  definition="Scope&#xD;&#xA;The RedemptionOrderConfirmationCancellationInstruction message is sent by an executing party, for example, a transfer agent, to the instructing party, for example, an investment manager or its authorised representative, to cancel a previously sent RedemptionOrderConfirmation.&#xD;&#xA;Usage&#xD;&#xA;To request the cancellation of one or more individual order executions, the order reference and deal reference of each individual order execution in the original RedemptionOrderConfirmation are specified in the order reference and deal reference elements respectively. The message identification of the RedemptionOrderConfirmation message in which the individual order execution was conveyed may also be quoted in PreviousReference but this is not recommended. The AmendmentIndicator is used to specify whether the redemption order confirmation cancellation is to be followed by an amendment An amendment of a redemption order confirmation is carried out by sending a RedemptionOrderConfirmation message in which the AmendmentIndicator contains the value ‘true’."
  registrationStatus="Registered"
  messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
  xmlTag="RedOrdrConfCxlInstr"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_Aab7uTbLEead9bDRE_1DAQ"
    previousVersion="_t5eDidE7Ed-BzquC8wXy7w_-2099190872"
    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="_Aab7uzbLEead9bDRE_1DAQ"
    previousVersion="_t5eDitE7Ed-BzquC8wXy7w_-2101963887"
    name="PoolReference"
    definition="Collective reference identifying a set of messages."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PoolRef"
    complexType="_N4g3EXETEea2e4bzJ8TyEw" />
  <messageBuildingBlock
    xmi:id="_Aab7vTbLEead9bDRE_1DAQ"
    previousVersion="_t5eDi9E7Ed-BzquC8wXy7w_-2101960811"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="PrvsRef"
    complexType="_udnPoTbsEead9bDRE_1DAQ" />
  <messageBuildingBlock
    xmi:id="_Aab7vzbLEead9bDRE_1DAQ"
    previousVersion="_t5eDjNE7Ed-BzquC8wXy7w_-2101038795"
    name="RelatedReference"
    definition="Reference to a linked message that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="RltdRef"
    complexType="_udnPoTbsEead9bDRE_1DAQ" />
  <messageBuildingBlock
    xmi:id="_lKwZk1AZEea5nPE5ezGuuw"
    name="AmendmentIndicator"
    definition="Indicates whether a confirmation amendment message will follow the confirmation cancellation instruction or not."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="AmdmntInd"
    simpleType="_YXbjA9p-Ed-ak6NoX_4Aeg_-2040117978" />
  <messageBuildingBlock
    xmi:id="_lKwZlFAZEea5nPE5ezGuuw"
    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="_lKwZlVAZEea5nPE5ezGuuw"
    name="OrderReferences"
    definition="Identification of the individual order confirmation to be cancelled."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="OrdrRefs"
    complexType="_13WvMFAYEea5nPE5ezGuuw" />
  <messageBuildingBlock
    xmi:id="_Aab7xTbLEead9bDRE_1DAQ"
    previousVersion="_t5n0gtE7Ed-BzquC8wXy7w_-2100115835"
    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="051"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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