setr.058.001.02
Scope The RequestForOrderConfirmationStatusReport message is ent by an executing party, for example, a transfer agent, to the instructing party, for example, an investment manager or its authorised representative, to request the status of one or more order confirmations. Usage The RequestForOrderConfirmationStatusReport message is used to request the status of either:
- one or several individual order confirmations, or,
- one or several order confirmation messages. The response to a RequestForOrderConfirmationStatusReport message is the OrderConfirmationStatusReport message. When the RequestForOrderConfirmationStatusReport message is used to request the status of several individual order confirmations or one or more order confirmation messages, the executing party may receive several OrderConfirmationStatusReport messages from the instructing party. When the RequestForOrderConfirmationStatusReport is used to request the status of one or more individual order confirmations, each individual order confirmation is identified with its order reference. The message identification of the message in which the individual order confirmation was conveyed may also be quoted in PreviousReference. When the RequestForOrderConfirmationStatusReport is used to request the status of an order confirmation message, then the message identification of the order confirmation message is identified in PreviousReference.
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 %% RequestForOrderConfirmationStatusReportV02 recursion level 0 with max 0 RequestForOrderConfirmationStatusReportV02 *-- "1..1" MessageIdentification1 : MessageIdentification RequestForOrderConfirmationStatusReportV02 *-- "1..1" MessageAndBusinessReference10 : RequestDetails RequestForOrderConfirmationStatusReportV02 *-- "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 |
RequestDetails building block
Information to identify the order confirmation for which the status is requested. Information to identify funds order(s). For comparison, see the ISO20022 official specification
classDiagram direction tb %% MessageAndBusinessReference10 recursion level 0 with max 1 MessageAndBusinessReference10 *-- "0..1" IReferences62Choice : Reference MessageAndBusinessReference10 *-- "0..1" AdditionalReference8 : RelatedReference MessageAndBusinessReference10 *-- "0..0" InvestmentFundOrder8 : OrderReference %% IReferences62Choice recursion level 1 with max 1 %% AdditionalReference8 recursion level 1 with max 1 class AdditionalReference8{ Reference IsoMax35Text MessageName IsoMax35Text } AdditionalReference8 *-- "0..1" PartyIdentification113 : ReferenceIssuer %% InvestmentFundOrder8 recursion level 1 with max 1 class InvestmentFundOrder8{ MasterReference IsoMax35Text OrderReference IsoMax35Text ClientReference IsoMax35Text CancellationReference IsoMax35Text DealReference IsoMax35Text } InvestmentFundOrder8 *-- "0..1" InvestmentAccount58 : InvestmentAccountDetails InvestmentFundOrder8 *-- "0..1" FinancialInstrument57 : FinancialInstrumentDetails
MessageAndBusinessReference10 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Reference | Reference to a linked message that was previously sent. | IReferences62Choice - Optional 0..1 |
RelatedReference | Reference to a linked message that was previously received. | AdditionalReference8 - Optional 0..1 |
OrderReference | Unique and unambiguous identifiers of one or more individual order instructions or individual order cancellation requests. | InvestmentFundOrder8 - Unknown 0..0 |
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 RequestForOrderConfirmationStatusReportV02 implementation follows a specific implementaiton pattern. First of all, RequestForOrderConfirmationStatusReportV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RequestForOrderConfirmationStatusReportV02Document implements IOuterDocument. Because RequestForOrderConfirmationStatusReportV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RequestForOrderConfirmationStatusReportV02.
classDiagram class IOuterRecord RequestForOrderConfirmationStatusReportV02 --|> IOuterRecord : Implements RequestForOrderConfirmationStatusReportV02Document --|> IOuterDocument~RequestForOrderConfirmationStatusReportV02~ : Implements class IOuterDocument~RequestForOrderConfirmationStatusReportV02~ { RequestForOrderConfirmationStatusReportV02 Message }
Document wrapper for serialization
The only real purpose RequestForOrderConfirmationStatusReportV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:setr.058.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RequestForOrderConfirmationStatusReportV02.ToDocument() method. The returned RequestForOrderConfirmationStatusReportV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram RequestForOrderConfirmationStatusReportV02Document *-- RequestForOrderConfirmationStatusReportV02 : 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.058.001.02">
<ReqForOrdrConfStsRpt>
<MsgId>
<!-- MessageIdentification inner content -->
</MsgId>
<ReqDtls>
<!-- RequestDetails inner content -->
</ReqDtls>
<Xtnsn>
<!-- Extension inner content -->
</Xtnsn>
</ReqForOrdrConfStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Aab8RzbLEead9bDRE_1DAQ"
previousVersion="_v7tBCNE7Ed-BzquC8wXy7w_-862773278"
name="RequestForOrderConfirmationStatusReportV02"
definition="Scope
The RequestForOrderConfirmationStatusReport message is ent by an executing party, for example, a transfer agent, to the instructing party, for example, an investment manager or its authorised representative, to request the status of one or more order confirmations.
Usage
The RequestForOrderConfirmationStatusReport message is used to request the status of either:
- one or several individual order confirmations, or,
- one or several order confirmation messages.
The response to a RequestForOrderConfirmationStatusReport message is the OrderConfirmationStatusReport message.
When the RequestForOrderConfirmationStatusReport message is used to request the status of several individual order confirmations or one or more order confirmation messages, the executing party may receive several OrderConfirmationStatusReport messages from the instructing party.
When the RequestForOrderConfirmationStatusReport is used to request the status of one or more individual order confirmations, each individual order confirmation is identified with its order reference. The message identification of the message in which the individual order confirmation was conveyed may also be quoted in PreviousReference.
When the RequestForOrderConfirmationStatusReport is used to request the status of an order confirmation message, then the message identification of the order confirmation message is identified in PreviousReference."
registrationStatus="Registered"
messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
xmlTag="ReqForOrdrConfStsRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_ZNNCsqJ8EeasRMONNp89pg"
name="OtherReferenceGuideline"
definition="RequestDetails/Reference/OtherReference should be used to reference an order instruction or cancellation 'message' sent in a proprietary way or used for a system reference. If RequestDetails/Reference/OtherReference is present, RequestDetails/Reference/OtherReference/MessageName must contain 'fax' or 'phone' or 'email', etc."
registrationStatus="Provisionally Registered" />
<constraint
xmi:id="_ZNNCs6J8EeasRMONNp89pg"
name="PreviousReferenceGuideline"
definition="If RequestDetails/Reference/PreviousReference/MessageName is present, it must contain 502 or must start with setr.047, setr.049, setr.051, setr.053, or setr.055 and RequestDetails/Reference/PreviousReference/Reference must contain the reference of a message in this list."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_Aab8STbLEead9bDRE_1DAQ"
previousVersion="_v72yANE7Ed-BzquC8wXy7w_1937667668"
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="_Aab8SzbLEead9bDRE_1DAQ"
previousVersion="_v72yAdE7Ed-BzquC8wXy7w_-374664944"
name="RequestDetails"
definition="Information to identify the order confirmation for which the status is requested."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="ReqDtls"
complexType="_IGLlRzbtEead9bDRE_1DAQ" />
<messageBuildingBlock
xmi:id="_Aab8TTbLEead9bDRE_1DAQ"
previousVersion="_v72yAtE7Ed-BzquC8wXy7w_-2086704739"
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="058"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.