PriceReportCancellationV02

reda.002.001.02

Scope The PriceReportCancellation message is sent by a report provider, eg, a fund accountant, transfer agent, market data provider, or any other interested party, to a report user, eg, a fund management company, a transfer agent, market data provider, regulator or any other interested party. The message is used to cancel a previously sent PriceReport message. Usage The PriceReportCancellation message is used to cancel an entire PriceReport message that was previously sent by the report provider. If only a part of the information needs to be cancelled and replaced, the PriceReportCorrection message must be used. This message must contain the reference of the message to be cancelled. This message may also contain details of the message to be cancelled, 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
%% PriceReportCancellationV02 recursion level 0 with max 0
PriceReportCancellationV02 *-- "0..1" AdditionalReference3 : PoolReference
PriceReportCancellationV02 *-- "1..1" AdditionalReference3 : PreviousReference
PriceReportCancellationV02 *-- "0..1" PriceReport1 : PriceReportToBeCancelled
  

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

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

Member name Description Data Type / Multiplicity
Reference Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. IsoMax35Text - Required 1..1
ReferenceIssuer Issuer of the reference. IPartyIdentification2Choice - Optional 0..1
MessageName Name of a message. IsoMax35Text - Optional 0..1

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

Member name Description Data Type / Multiplicity
Reference Business reference of a message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. IsoMax35Text - Required 1..1
ReferenceIssuer Issuer of the reference. IPartyIdentification2Choice - Optional 0..1
MessageName Name of a message. IsoMax35Text - Optional 0..1

PriceReportToBeCancelled building block

Common information related to all the price reports to be cancelled. Information about a price report. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PriceReport1 recursion level 0 with max 1
PriceReport1 *-- "1..0" PriceValuation2 : PriceValuationDetails
PriceReport1 *-- "0..0" Extension1 : Extension
%% PriceValuation2 recursion level 1 with max 1
class PriceValuation2{
    Identification IsoMax35Text
    TotalNAV IsoActiveOrHistoricCurrencyAndAmount
    ValuationCycle ValuationTiming1Code
    SuspendedIndicator IsoYesNoIndicator
}
PriceValuation2 *-- "0..1" IDateAndDateTimeChoice : ValuationDateTime
PriceValuation2 *-- "1..1" IDateAndDateTimeChoice : TradeDateTime
PriceValuation2 *-- "1..1" FinancialInstrument5 : FinancialInstrumentDetails
PriceValuation2 *-- "0..1" FinancialInstrumentQuantity1 : TotalUnitsNumber
PriceValuation2 *-- "0..1" IDateAndDateTimeChoice : NextValuationDateTime
PriceValuation2 *-- "0..1" IDateAndDateTimeChoice : PreviousValuationDateTime
PriceValuation2 *-- "0..0" UnitPrice6 : PriceDetails
PriceValuation2 *-- "0..0" ValuationStatistics2 : ValuationStatistics
%% Extension1 recursion level 1 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}
  

PriceReport1 members

Member name Description Data Type / Multiplicity
PriceValuationDetails Information related to the price valuation of a financial instrument. PriceValuation2 - Unknown 1..0
Extension Additional information that cannot be captured in the structured elements and/or any other specific block. Extension1 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    PriceReportCancellationV02 --|> IOuterRecord : Implements
    PriceReportCancellationV02Document --|> IOuterDocument~PriceReportCancellationV02~ : Implements
    class IOuterDocument~PriceReportCancellationV02~ {
        PriceReportCancellationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    PriceReportCancellationV02Document *-- PriceReportCancellationV02 : 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:reda.002.001.02">
    <reda.002.001.02>
        <PoolRef>
            <!-- PoolReference inner content -->
        </PoolRef>
        <PrvsRef>
            <!-- PreviousReference inner content -->
        </PrvsRef>
        <PricRptToBeCanc>
            <!-- PriceReportToBeCancelled inner content -->
        </PricRptToBeCanc>
    </reda.002.001.02>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Zski2NEvEd-BzquC8wXy7w_-1589707882"
  nextVersions="_ZstsytEvEd-BzquC8wXy7w_-609818463"
  name="PriceReportCancellationV02"
  definition="Scope&#xD;&#xA;The PriceReportCancellation message is sent by a report provider, eg, a fund accountant, transfer agent, market data provider, or any other interested party, to a report user, eg, a fund management company, a transfer agent, market data provider, regulator or any other interested party.&#xD;&#xA;The message is used to cancel a previously sent PriceReport message.&#xD;&#xA;Usage&#xD;&#xA;The PriceReportCancellation message is used to cancel an entire PriceReport message that was previously sent by the report provider. If only a part of the information needs to be cancelled and replaced, the PriceReportCorrection message must be used.&#xD;&#xA;This message must contain the reference of the message to be cancelled. This message may also contain details of the message to be cancelled, but this is not recommended."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="reda.002.001.02"
  xmlTag="reda.002.001.02"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_Zski2dEvEd-BzquC8wXy7w_-1891280241"
    name="PoolReference"
    definition="Collective reference identifying a set of messages."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PoolRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_Zski2tEvEd-BzquC8wXy7w_-1948539540"
    name="PreviousReference"
    definition="Reference to a linked message that was previously sent."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="PrvsRef"
    complexType="_Q6vvAdp-Ed-ak6NoX_4Aeg_2101402955" />
  <messageBuildingBlock
    xmi:id="_Zski29EvEd-BzquC8wXy7w_-1321950502"
    name="PriceReportToBeCancelled"
    definition="Common information related to all the price reports to be cancelled."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="PricRptToBeCanc"
    complexType="_U1YYmtp-Ed-ak6NoX_4Aeg_-666628245" />
  <messageDefinitionIdentifier
    businessArea="reda"
    messageFunctionality="002"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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