OrderCancellationStatusReportV02

setr.017.001.02

Scope The OrderCancellationStatusReport is sent by an executing party, eg, a transfer agent, to the instructing party, eg, an investment manager or its authorised representative. There may be one or more intermediary parties between the executing party and the instructing party. The intermediary party is, for example, an intermediary or a concentrator. The message gives the status of an order cancellation instruction message that was previously sent by the instructing party. Usage The OrderCancellationStatusReport message is used to report the status of an order cancellation instruction message that was previously sent by the instructing party. The message can be used to report one of the following:

• the cancellation is accepted for further processing, or
• the cancellation is rejected, or
• the order has been cancelled. When the cancellation is rejected, the reason for the rejection must be specified.

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
%% OrderCancellationStatusReportV02 recursion level 0 with max 0
OrderCancellationStatusReportV02 *-- "1..2" AdditionalReference3 : RelatedReference
OrderCancellationStatusReportV02 *-- "1..2" AdditionalReference3 : OtherReference
OrderCancellationStatusReportV02 *-- "1..1" OrderStatusAndReason4 : CancellationStatusReport
  

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

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
%% 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

OtherReference building block

Reference to a linked message sent in a proprietary way or reference of a system. 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

CancellationStatusReport building block

Status report details of a bulk or multiple or switch order cancellation instruction that was previously received. Status report of a bulk or multiple or switch order cancellation instruction that was previously received. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% OrderStatusAndReason4 recursion level 0 with max 1
class OrderStatusAndReason4{
    Status OrderStatus3Code
}
OrderStatusAndReason4 *-- "1..1" RejectedStatus4 : Rejected
OrderStatusAndReason4 *-- "0..1" IPartyIdentification2Choice : StatusInitiator
%% RejectedStatus4 recursion level 1 with max 1
RejectedStatus4 *-- "1..1" RejectedStatusReason4 : Reason
RejectedStatus4 *-- "1..1" GenericIdentification1 : DataSourceScheme
%% IPartyIdentification2Choice recursion level 1 with max 1
  

OrderStatusAndReason4 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    OrderCancellationStatusReportV02 --|> IOuterRecord : Implements
    OrderCancellationStatusReportV02Document --|> IOuterDocument~OrderCancellationStatusReportV02~ : Implements
    class IOuterDocument~OrderCancellationStatusReportV02~ {
        OrderCancellationStatusReportV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    OrderCancellationStatusReportV02Document *-- OrderCancellationStatusReportV02 : 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.017.001.02">
    <setr.017.001.02>
        <RltdRef>
            <!-- RelatedReference inner content -->
        </RltdRef>
        <OthrRef>
            <!-- OtherReference inner content -->
        </OthrRef>
        <CxlStsRpt>
            <!-- CancellationStatusReport inner content -->
        </CxlStsRpt>
    </setr.017.001.02>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_gilh-NE7Ed-BzquC8wXy7w_-1859459709"
  nextVersions="_g9jmudE7Ed-BzquC8wXy7w_-1949489273"
  name="OrderCancellationStatusReportV02"
  definition="Scope&#xD;&#xA;The OrderCancellationStatusReport is sent by an executing party, eg, a transfer agent, to the instructing party, eg, an investment manager or its authorised representative. There may be one or more intermediary parties between the executing party and the instructing party. The intermediary party is, for example, an intermediary or a concentrator.&#xD;&#xA;The message gives the status of an order cancellation instruction message that was previously sent by the instructing party.&#xD;&#xA;Usage&#xD;&#xA;The OrderCancellationStatusReport message is used to report the status of an order cancellation instruction message that was previously sent by the instructing party. The message can be used to report one of the following:&#xD;&#xA;- the cancellation is accepted for further processing, or&#xD;&#xA;- the cancellation is rejected, or&#xD;&#xA;- the order has been cancelled.&#xD;&#xA;When the cancellation is rejected, the reason for the rejection must be specified."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="setr.017.001.02"
  xmlTag="setr.017.001.02"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_gilh_NE7Ed-BzquC8wXy7w_1931923832"
    name="MessageNameAndReferenceGuideline"
    definition="If MessageName is present, it must contain 502 or must start with setr.002 or setr.005 or setr.008 or setr.011 or setr.014 or setr.025 and Reference must contain the business reference of a message in this list."
    registrationStatus="Provisionally Registered" />
  <xors
    xmi:id="_givS8tE7Ed-BzquC8wXy7w_-544418429"
    name="RelatedReferenceOrOtherReferenceRule"
    definition="If OtherReference is not present, then RelatedReference is mandatory. If OtherReference is present, then RelatedReference is not allowed."
    registrationStatus="Provisionally Registered"
    impactedMessageBuildingBlocks="_gilh-dE7Ed-BzquC8wXy7w_339506897 _gilh-tE7Ed-BzquC8wXy7w_-1972675840" />
  <messageBuildingBlock
    xmi:id="_gilh-dE7Ed-BzquC8wXy7w_339506897"
    name="RelatedReference"
    definition="Reference to a linked message that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="2"
    minOccurs="1"
    xmlTag="RltdRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_gilh-tE7Ed-BzquC8wXy7w_-1972675840"
    name="OtherReference"
    definition="Reference to a linked message sent in a proprietary way or reference of a system."
    registrationStatus="Provisionally Registered"
    maxOccurs="2"
    minOccurs="1"
    xmlTag="OthrRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_gilh-9E7Ed-BzquC8wXy7w_1147588729"
    name="CancellationStatusReport"
    definition="Status report details of a bulk or multiple or switch order cancellation instruction that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CxlStsRpt"
    complexType="_Uvt1dNp-Ed-ak6NoX_4Aeg_816044413" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="017"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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