setr.057.001.02
Scope The OrderConfirmationStatusReport 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 report the status of an order confirmation or an order confirmation amendment. Usage The OrderConfirmationStatusReport message is used to report on the status of one or more individual:
- subscription confirmations,
- subscription confirmation amendments,
- redemption confirmations,
- redemption confirmation amendments,
- switch order confirmations,
- switch order confirmation amendments. One of the following statuses can be reported:
- confirmation rejected, or,
- amendment rejected, or,
- sent to next party, or,
- communication problem with next party, or,
- confirmation accepted, or,
- confirmation received. It is likely that the OrderConfirmationStatusReport is only sent by the order instructing party to the order executing party to reject an order confirmation or to reject an order confirmation amendment, although if an intermediary party is used, the statuses sent to next party and communication problem with next party are also likely be used. The statuses confirmation accepted and confirmation received would only be used in the event the order executing party sends a RequestForOrderConfirmationStatusReport message and one of the other statuses does not apply. If the status being reported is either confirmation rejected or amendment rejected, then a reason for the rejection must be given. The individual order confirmation or confirmation amendment for which the status is given is identified with its order reference. The message identification of the message in which the individual order confirmation or confirmation amendment was conveyed may also be quoted in RelatedReference, but this is not recommended.
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 %% OrderConfirmationStatusReportV02 recursion level 0 with max 0 OrderConfirmationStatusReportV02 *-- "1..1" MessageIdentification1 : MessageIdentification OrderConfirmationStatusReportV02 *-- "0..1" IReferences61Choice : Reference OrderConfirmationStatusReportV02 *-- "1..1" IndividualOrderConfirmationStatusAndReason2 : IndividualOrderConfirmationDetailsReport OrderConfirmationStatusReportV02 *-- "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 |
---|
IndividualOrderConfirmationDetailsReport building block
Status report details of an individual order confirmation. Status report of the individual orders confirmation that was previously received. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IndividualOrderConfirmationStatusAndReason2 recursion level 0 with max 1 class IndividualOrderConfirmationStatusAndReason2{ MasterReference IsoMax35Text OrderReference IsoMax35Text ClientReference IsoMax35Text DealReference IsoMax35Text } IndividualOrderConfirmationStatusAndReason2 *-- "1..1" IConfirmationStatus1Choice : Confirmation IndividualOrderConfirmationStatusAndReason2 *-- "0..1" PartyIdentification113 : StatusInitiator IndividualOrderConfirmationStatusAndReason2 *-- "0..1" InvestmentAccount58 : InvestmentAccountDetails IndividualOrderConfirmationStatusAndReason2 *-- "0..1" FinancialInstrument57 : FinancialInstrumentDetails %% IConfirmationStatus1Choice recursion level 1 with max 1 %% PartyIdentification113 recursion level 1 with max 1 class PartyIdentification113{ LEI IsoLEIIdentifier } PartyIdentification113 *-- "1..1" IPartyIdentification90Choice : Party %% InvestmentAccount58 recursion level 1 with max 1 class InvestmentAccount58{ AccountIdentification IsoMax35Text AccountName IsoMax35Text AccountDesignation IsoMax35Text OrderOriginatorEligibility OrderOriginatorEligibility1Code } InvestmentAccount58 *-- "0..0" PartyIdentification113 : OwnerIdentification InvestmentAccount58 *-- "0..1" PartyIdentification113 : AccountServicer InvestmentAccount58 *-- "0..1" SubAccount6 : SubAccountDetails %% FinancialInstrument57 recursion level 1 with max 1 class FinancialInstrument57{ Name IsoMax350Text ShortName IsoMax35Text SupplementaryIdentification IsoMax35Text ClassType IsoMax35Text SecuritiesForm FormOfSecurity1Code DistributionPolicy DistributionPolicy1Code ProductGroup IsoMax140Text } FinancialInstrument57 *-- "1..1" ISecurityIdentification25Choice : Identification FinancialInstrument57 *-- "0..1" Series1 : SeriesIdentification
IndividualOrderConfirmationStatusAndReason2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MasterReference | Reference assigned to a set of orders or trades in order to link them together. | IsoMax35Text - Optional 0..1 |
OrderReference | Unique and unambiguous identifier for the order, as assigned by the instructing party. | IsoMax35Text - Required 1..1 |
Confirmation | Status of the order confirmation cancellation. | IConfirmationStatus1Choice - Required 1..1 |
ClientReference | Unique and unambiguous investor’s identification of an order. This reference can typically be used in a hub scenario to give the reference of the order as assigned by the underlying client. | IsoMax35Text - Optional 0..1 |
DealReference | Unique and unambiguous identifier for the order execution, as assigned by the confirming party. | IsoMax35Text - Optional 0..1 |
StatusInitiator | Party that initiates the status of the order confirmation. | PartyIdentification113 - Optional 0..1 |
InvestmentAccountDetails | Account information of the individual order confirmation for which the status is given. | InvestmentAccount58 - Optional 0..1 |
FinancialInstrumentDetails | Financial instrument information of the individual order confirmation for which the status is given. | FinancialInstrument57 - Optional 0..1 |
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 OrderConfirmationStatusReportV02 implementation follows a specific implementaiton pattern. First of all, OrderConfirmationStatusReportV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, OrderConfirmationStatusReportV02Document implements IOuterDocument. Because OrderConfirmationStatusReportV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type OrderConfirmationStatusReportV02.
classDiagram class IOuterRecord OrderConfirmationStatusReportV02 --|> IOuterRecord : Implements OrderConfirmationStatusReportV02Document --|> IOuterDocument~OrderConfirmationStatusReportV02~ : Implements class IOuterDocument~OrderConfirmationStatusReportV02~ { OrderConfirmationStatusReportV02 Message }
Document wrapper for serialization
The only real purpose OrderConfirmationStatusReportV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.057.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using OrderConfirmationStatusReportV02.ToDocument() method. The returned OrderConfirmationStatusReportV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram OrderConfirmationStatusReportV02Document *-- OrderConfirmationStatusReportV02 : 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.057.001.02">
<OrdrConfStsRpt>
<MsgId>
<!-- MessageIdentification inner content -->
</MsgId>
<Ref>
<!-- Reference inner content -->
</Ref>
<IndvOrdrConfDtlsRpt>
<!-- IndividualOrderConfirmationDetailsReport inner content -->
</IndvOrdrConfDtlsRpt>
<Xtnsn>
<!-- Extension inner content -->
</Xtnsn>
</OrdrConfStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Aab8NTbLEead9bDRE_1DAQ"
previousVersion="_hzzSMNE7Ed-BzquC8wXy7w_-354500985"
name="OrderConfirmationStatusReportV02"
definition="Scope
The OrderConfirmationStatusReport 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 report the status of an order confirmation or an order confirmation amendment.
Usage
The OrderConfirmationStatusReport message is used to report on the status of one or more individual:
- subscription confirmations,
- subscription confirmation amendments,
- redemption confirmations,
- redemption confirmation amendments,
- switch order confirmations,
- switch order confirmation amendments.
One of the following statuses can be reported:
- confirmation rejected, or,
- amendment rejected, or,
- sent to next party, or,
- communication problem with next party, or,
- confirmation accepted, or,
- confirmation received.
It is likely that the OrderConfirmationStatusReport is only sent by the order instructing party to the order executing party to reject an order confirmation or to reject an order confirmation amendment, although if an intermediary party is used, the statuses sent to next party and communication problem with next party are also likely be used. The statuses confirmation accepted and confirmation received would only be used in the event the order executing party sends a RequestForOrderConfirmationStatusReport message and one of the other statuses does not apply.
If the status being reported is either confirmation rejected or amendment rejected, then a reason for the rejection must be given.
The individual order confirmation or confirmation amendment for which the status is given is identified with its order reference. The message identification of the message in which the individual order confirmation or confirmation amendment was conveyed may also be quoted in RelatedReference, but this is not recommended."
registrationStatus="Registered"
messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
xmlTag="OrdrConfStsRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_NEOWYaHGEeaQVOfmA3AVng"
name="MessageNameAndReferenceGuideline"
definition="If Reference/RelatedReference/MessageName or Reference/OtherReference/MessageName is present, it must contain 502 or must start with setr.047, setr.049, setr.051, setr.053, setr.055, setr.058 and Reference/RelatedReference/Reference must contain the message reference of a message in this list."
registrationStatus="Provisionally Registered" />
<constraint
xmi:id="_lOb3oaHGEeaQVOfmA3AVng"
name="OtherReferenceGuideline"
definition="OtherReference should be used to reference an order confirmation 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="_Aab8PTbLEead9bDRE_1DAQ"
previousVersion="_hzzSMdE7Ed-BzquC8wXy7w_1729546836"
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="_JkdC0EhAEea8pJjypp-yMQ"
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="_Aab8QzbLEead9bDRE_1DAQ"
previousVersion="_hzzSNNE7Ed-BzquC8wXy7w_1394750346"
name="IndividualOrderConfirmationDetailsReport"
definition="Status report details of an individual order confirmation."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="IndvOrdrConfDtlsRpt"
complexType="_ArbrJTbtEead9bDRE_1DAQ" />
<messageBuildingBlock
xmi:id="_Aab8RTbLEead9bDRE_1DAQ"
previousVersion="_hzzSNdE7Ed-BzquC8wXy7w_1567010081"
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="057"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.