reda.002.001.03
Scope A report provider, eg, a transfer agent, fund accountant or market data provider, sends the PriceReportCancellation message to the report recipient, eg, a fund management company, transfer agent, market data provider, regulator or any other interested party to cancel a previously sent PriceReport message. Usage The PriceReportCancellation is used to cancel an entire PriceReport message that was previously sent. 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 %% PriceReportCancellationV03 recursion level 0 with max 0 PriceReportCancellationV03 *-- "1..1" MessageIdentification1 : MessageIdentification PriceReportCancellationV03 *-- "0..1" AdditionalReference3 : PoolReference PriceReportCancellationV03 *-- "1..1" AdditionalReference3 : PreviousReference PriceReportCancellationV03 *-- "1..1" Pagination : MessagePagination PriceReportCancellationV03 *-- "0..1" PriceReport2 : PriceReportToBeCancelled
Now, we will zero-in one-by-one on each of these building blocks.
MessageIdentification building block
Reference that uniquely identifies a 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 |
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 |
MessagePagination building block
Pagination of the message. Number used to sequence pages when it is not possible for data to be conveyed in a single message and the data has to be split across several pages (messages). For comparison, see the ISO20022 official specification
classDiagram direction tb %% Pagination recursion level 0 with max 1 class Pagination{ PageNumber IsoMax5NumericText LastPageIndicator IsoYesNoIndicator }
Pagination members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PageNumber | Page number. | IsoMax5NumericText - Required 1..1 |
LastPageIndicator | Indicates the last page. | IsoYesNoIndicator - Required 1..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 %% PriceReport2 recursion level 0 with max 1 PriceReport2 *-- "1..0" PriceValuation3 : PriceValuationDetails PriceReport2 *-- "0..0" Extension1 : Extension %% PriceValuation3 recursion level 1 with max 1 class PriceValuation3{ Identification IsoMax35Text TotalNAV IsoActiveOrHistoricCurrencyAndAmount ValuationType ValuationTiming1Code ValuationFrequency EventFrequency1Code OfficialValuationIndicator IsoYesNoIndicator SuspendedIndicator IsoYesNoIndicator } PriceValuation3 *-- "0..1" IDateAndDateTimeChoice : ValuationDateTime PriceValuation3 *-- "1..1" IDateAndDateTimeChoice : NAVDateTime PriceValuation3 *-- "1..1" FinancialInstrument8 : FinancialInstrumentDetails PriceValuation3 *-- "0..1" IPartyIdentification2Choice : FundManagementCompany PriceValuation3 *-- "0..1" FinancialInstrumentQuantity1 : TotalUnitsNumber PriceValuation3 *-- "0..1" IDateAndDateTimeChoice : NextValuationDateTime PriceValuation3 *-- "0..1" IDateAndDateTimeChoice : PreviousValuationDateTime PriceValuation3 *-- "0..0" UnitPrice15 : PriceDetails PriceValuation3 *-- "0..0" ValuationStatistics3 : ValuationStatistics PriceValuation3 *-- "0..1" PerformanceFactors1 : PerformanceDetails %% Extension1 recursion level 1 with max 1 class Extension1{ PlaceAndName IsoMax350Text Text IsoMax350Text }
PriceReport2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
PriceValuationDetails | Information related to the price valuation of a financial instrument. | PriceValuation3 - 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 PriceReportCancellationV03 implementation follows a specific implementaiton pattern. First of all, PriceReportCancellationV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PriceReportCancellationV03Document implements IOuterDocument. Because PriceReportCancellationV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PriceReportCancellationV03.
classDiagram class IOuterRecord PriceReportCancellationV03 --|> IOuterRecord : Implements PriceReportCancellationV03Document --|> IOuterDocument~PriceReportCancellationV03~ : Implements class IOuterDocument~PriceReportCancellationV03~ { PriceReportCancellationV03 Message }
Document wrapper for serialization
The only real purpose PriceReportCancellationV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.002.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using PriceReportCancellationV03.ToDocument() method. The returned PriceReportCancellationV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram PriceReportCancellationV03Document *-- PriceReportCancellationV03 : 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.03">
<PricRptCxlV03>
<MsgId>
<!-- MessageIdentification inner content -->
</MsgId>
<PoolRef>
<!-- PoolReference inner content -->
</PoolRef>
<PrvsRef>
<!-- PreviousReference inner content -->
</PrvsRef>
<MsgPgntn>
<!-- MessagePagination inner content -->
</MsgPgntn>
<PricRptToBeCanc>
<!-- PriceReportToBeCancelled inner content -->
</PricRptToBeCanc>
</PricRptCxlV03>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_ZstsytEvEd-BzquC8wXy7w_-609818463"
nextVersions="_M87dQRj3EeKxeog5DTmtgg"
previousVersion="_Zski2NEvEd-BzquC8wXy7w_-1589707882"
name="PriceReportCancellationV03"
definition="Scope
A report provider, eg, a transfer agent, fund accountant or market data provider, sends the PriceReportCancellation message to the report recipient, eg, a fund management company, transfer agent, market data provider, regulator or any other interested party to cancel a previously sent PriceReport message.
Usage
The PriceReportCancellation is used to cancel an entire PriceReport message that was previously sent.
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."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="PricRptCxlV03"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_Zstsy9EvEd-BzquC8wXy7w_1351026833"
name="MessageIdentification"
definition="Reference that uniquely identifies a message from a business application standpoint."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgId"
complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
<messageBuildingBlock
xmi:id="_ZstszNEvEd-BzquC8wXy7w_980486135"
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="_ZstszdEvEd-BzquC8wXy7w_990644277"
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="_ZstsztEvEd-BzquC8wXy7w_-603797657"
name="MessagePagination"
definition="Pagination of the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgPgntn"
complexType="_Q65gBdp-Ed-ak6NoX_4Aeg_-21330104" />
<messageBuildingBlock
xmi:id="_Zs3dwNEvEd-BzquC8wXy7w_675721186"
name="PriceReportToBeCancelled"
definition="Common information related to all the price reports to be cancelled."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="PricRptToBeCanc"
complexType="_RLuxUtp-Ed-ak6NoX_4Aeg_166863578" />
<messageDefinitionIdentifier
businessArea="reda"
messageFunctionality="002"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.