Iso20022

OrderCancellationStatusReportV04

setr.017.001.04

Scope The OrderCancellationStatusReport 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 report the status of an order cancellation request that was previously received. Usage The OrderCancellationStatusReport message is used to provide the status of:

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
%% OrderCancellationStatusReportV04 recursion level 0 with max 0
OrderCancellationStatusReportV04 *-- "1..1" MessageIdentification1 : MessageIdentification
OrderCancellationStatusReportV04 *-- "0..1" IReferences61Choice : Reference
OrderCancellationStatusReportV04 *-- "1..1" IStatus26Choice : StatusReport
OrderCancellationStatusReportV04 *-- "0..1" Extension1 : Extension

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

Member name Description Data Type / Multiplicity
Identification Identification of the message. IsoMax35Text - Required 1..1
CreationDateTime Date of creation of the message. IsoISODateTime - Required 1..1

Reference building block

Reference to the message or communication that was previously received. Choice of references used to reference a previous transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IReferences61Choice recursion level 0 with max 1

References61Choice members

Member name Description Data Type / Multiplicity

StatusReport building block

Status of the order cancellation. Choice of status. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IStatus26Choice recursion level 0 with max 1

Status26Choice members

Member name Description Data Type / Multiplicity

Extension building block

Additional information that cannot be captured in the structured elements 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
%% Extension1 recursion level 0 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}

Extension1 members

Member name Description Data Type / Multiplicity
PlaceAndName Name qualifying the information provided in the Text field, and place where this information should be inserted. IsoMax350Text - Required 1..1
Text Text of the extension. IsoMax350Text - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    OrderCancellationStatusReportV04 --|> IOuterRecord : Implements
    OrderCancellationStatusReportV04Document --|> IOuterDocument~OrderCancellationStatusReportV04~ : Implements
    class IOuterDocument~OrderCancellationStatusReportV04~ {
        OrderCancellationStatusReportV04 Message
     }

Document wrapper for serialization

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

classDiagram
    OrderCancellationStatusReportV04Document *-- OrderCancellationStatusReportV04 : 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.04">
    <OrdrCxlStsRpt>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <Ref>
            <!-- Reference inner content -->
        </Ref>
        <StsRpt>
            <!-- StatusReport inner content -->
        </StsRpt>
        <Xtnsn>
            <!-- Extension inner content -->
        </Xtnsn>
    </OrdrCxlStsRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Aab7PTbLEead9bDRE_1DAQ"
  previousVersion="_g9jmudE7Ed-BzquC8wXy7w_-1949489273"
  name="OrderCancellationStatusReportV04"
  definition="Scope&#xD;&#xA;The OrderCancellationStatusReport 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 report the status of an order cancellation request that was previously received.&#xD;&#xA;Usage&#xD;&#xA;The OrderCancellationStatusReport message is used to provide the status of:&#xD;&#xA;- one or more individual order cancellation requests by using IndividualCancellationStatusReport, or,&#xD;&#xA;- an order cancellation request message by using CancellationStatusReport.&#xD;&#xA;If the OrderCancellationStatusReport message is used to report the status of an individual order cancellation request, then the repetitive IndividualCancellationStatusReport sequence is used and the order reference of the individual order is quoted in OrderReference. The message identification of the message in which the individual order was conveyed may also be quoted in RelatedReference but this is not recommended.&#xD;&#xA;If the OrderCancellationStatusReport message is used to report the status of an entire order cancellation request message, for example, the SubscriptionBulkOrderCancellationRequest, or a SubscriptionOrderCancellationRequest containing several orders, then the CancellationStatusReport sequence is used. The message identification of the order cancellation request message may also be quoted in RelatedReference but this is not recommended. All the order cancellation requests within the message must have the same status.&#xD;&#xA;One of the following statuses can be reported: &#xD;&#xA;- the order cancellation is pending, or,&#xD;&#xA;- the order cancellation request is rejected, or,&#xD;&#xA;- the order is cancelled.&#xD;&#xA;When the cancellation is rejected, the reason for the rejection must be specified."
  registrationStatus="Registered"
  messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
  xmlTag="OrdrCxlStsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_72YxYaHFEeaQVOfmA3AVng"
    name="MessageNameAndReferenceGuideline"
    definition="If Reference/RelatedReference/MessageName or Reference/OtherReference/MessageName is present, it must it must contain 502 or must start with setr.002, setr.005, setr.008, setr.011, setr.014 or setr.018 and Reference/RelatedReference/Reference must contain the message reference of a message in this list."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_4CLqgaHGEeaQVOfmA3AVng"
    name="OtherReferenceGuideline"
    definition="OtherReference should be used to reference an order cancellation 'message' sent in a proprietary way or used for a system reference. If OtherReference is present, OtherReference/MessageName must contain 'fax' or 'phone' or 'email', etc."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_Aab7RzbLEead9bDRE_1DAQ"
    previousVersion="_g9jmutE7Ed-BzquC8wXy7w_-1666125057"
    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="_0TCgMUgqEeaD2L_hzZaE0w"
    name="Reference"
    definition="Reference to the message or communication that was previously received."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Ref"
    complexType="_kTej8UHOEeazV4RAqPV71g" />
  <messageBuildingBlock
    xmi:id="_HOh50EgrEeaD2L_hzZaE0w"
    name="StatusReport"
    definition="Status of the order cancellation."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="StsRpt"
    complexType="_ZdGjEEgrEeaD2L_hzZaE0w" />
  <messageBuildingBlock
    xmi:id="_Aab7UTbLEead9bDRE_1DAQ"
    previousVersion="_g9tXsdE7Ed-BzquC8wXy7w_819197774"
    name="Extension"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="Xtnsn"
    complexType="_Q6vvCNp-Ed-ak6NoX_4Aeg_1503007069" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="017"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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