DataSetMatchReportV03

tsmt.013.001.03

Scope The DataSetMatchReport message is sent by the matching application to the parties involved in a data set match. This message is used to either

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
%% DataSetMatchReportV03 recursion level 0 with max 0
DataSetMatchReportV03 *-- "1..1" MessageIdentification1 : ReportIdentification
DataSetMatchReportV03 *-- "1..1" SimpleIdentificationInformation : TransactionIdentification
DataSetMatchReportV03 *-- "1..1" DocumentIdentification3 : EstablishedBaselineIdentification
DataSetMatchReportV03 *-- "1..1" TransactionStatus4 : TransactionStatus
DataSetMatchReportV03 *-- "0..2" DocumentIdentification5 : UserTransactionReference
DataSetMatchReportV03 *-- "1..1" PartyIdentification26 : Buyer
DataSetMatchReportV03 *-- "1..1" PartyIdentification26 : Seller
DataSetMatchReportV03 *-- "1..1" BICIdentification1 : BuyerBank
DataSetMatchReportV03 *-- "1..1" BICIdentification1 : SellerBank
DataSetMatchReportV03 *-- "2..1" DocumentIdentification10 : ComparedDocumentReference
DataSetMatchReportV03 *-- "1..1" ReportType3 : SubmissionType
DataSetMatchReportV03 *-- "1..1" MisMatchReport3 : Report
DataSetMatchReportV03 *-- "0..1" PendingActivity2 : RequestForAction
  

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

ReportIdentification building block

Identifies the report. 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

TransactionIdentification building block

Unique identification assigned by the matching application to the transaction. This identification is to be used in any communication between the parties. Information related to an identification, eg, party identification or account identification. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SimpleIdentificationInformation recursion level 0 with max 1
class SimpleIdentificationInformation{
    Identification IsoMax35Text
}
  

SimpleIdentificationInformation members

Member name Description Data Type / Multiplicity
Identification Name or number assigned by an entity to enable recognition of that entity, eg, account identifier. IsoMax35Text - Required 1..1

EstablishedBaselineIdentification building block

Unique identification assigned by the matching application to the baseline when it is established. Identifies a document by a unique identification and a version. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification3 recursion level 0 with max 1
class DocumentIdentification3{
    Identification IsoMax35Text
    Version IsoNumber
}
  

DocumentIdentification3 members

Member name Description Data Type / Multiplicity
Identification Identification of a set of data. IsoMax35Text - Required 1..1
Version Unambiguous identification of the version of a set of data. Example: Version 1. IsoNumber - Required 1..1

TransactionStatus building block

Identifies the status of the transaction by means of a code. Identifies the status of the transaction by means of a code. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TransactionStatus4 recursion level 0 with max 1
class TransactionStatus4{
    Status BaselineStatus3Code
}
  

TransactionStatus4 members

Member name Description Data Type / Multiplicity
Status Identifies the status of the transaction by means of a code. BaselineStatus3Code - Required 1..1

UserTransactionReference building block

Reference to the transaction for each financial institution which is a party to the transaction. Identifies a document by a unique identification and its issuer. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification5 recursion level 0 with max 1
class DocumentIdentification5{
    Identification IsoMax35Text
}
DocumentIdentification5 *-- "1..1" BICIdentification1 : IdentificationIssuer
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

DocumentIdentification5 members

Member name Description Data Type / Multiplicity
Identification Identification of a set of data. IsoMax35Text - Required 1..1
IdentificationIssuer Uniquely identifies the financial institution which has issued the identification of the set of data by using a BIC. BICIdentification1 - Required 1..1

Buyer building block

Party that buys goods or services, or a financial instrument. Entity involved in an activity. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PartyIdentification26 recursion level 0 with max 1
class PartyIdentification26{
    Name IsoMax70Text
}
PartyIdentification26 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
PartyIdentification26 *-- "1..1" PostalAddress5 : PostalAddress
%% GenericIdentification4 recursion level 1 with max 1
class GenericIdentification4{
    Identification IsoMax35Text
    IdentificationType IsoMax35Text
}
%% PostalAddress5 recursion level 1 with max 1
class PostalAddress5{
    StreetName IsoMax70Text
    PostCodeIdentification IsoMax16Text
    TownName IsoMax35Text
    CountrySubDivision IsoMax35Text
    Country CountryCode
}
  

PartyIdentification26 members

Member name Description Data Type / Multiplicity
Name Name by which a party is known and which is usually used to identify that party. IsoMax70Text - Required 1..1
ProprietaryIdentification Unique and unambiguous identifier assigned to a party using a proprietary identification scheme. GenericIdentification4 - Optional 0..1
PostalAddress Information that locates and identifies a specific address, as defined by postal services. PostalAddress5 - Required 1..1

Seller building block

Party that sells goods or services, or a financial instrument. Entity involved in an activity. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PartyIdentification26 recursion level 0 with max 1
class PartyIdentification26{
    Name IsoMax70Text
}
PartyIdentification26 *-- "0..1" GenericIdentification4 : ProprietaryIdentification
PartyIdentification26 *-- "1..1" PostalAddress5 : PostalAddress
%% GenericIdentification4 recursion level 1 with max 1
class GenericIdentification4{
    Identification IsoMax35Text
    IdentificationType IsoMax35Text
}
%% PostalAddress5 recursion level 1 with max 1
class PostalAddress5{
    StreetName IsoMax70Text
    PostCodeIdentification IsoMax16Text
    TownName IsoMax35Text
    CountrySubDivision IsoMax35Text
    Country CountryCode
}
  

PartyIdentification26 members

Member name Description Data Type / Multiplicity
Name Name by which a party is known and which is usually used to identify that party. IsoMax70Text - Required 1..1
ProprietaryIdentification Unique and unambiguous identifier assigned to a party using a proprietary identification scheme. GenericIdentification4 - Optional 0..1
PostalAddress Information that locates and identifies a specific address, as defined by postal services. PostalAddress5 - Required 1..1

BuyerBank building block

The financial institution of the buyer, uniquely identified by its BIC. Unique and unambiguous identifier of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BICIdentification1 recursion level 0 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

BICIdentification1 members

Member name Description Data Type / Multiplicity
BIC Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 “Banking - Banking telecommunication messages - Business identifier code (BIC)”. IsoBICIdentifier - Required 1..1

SellerBank building block

The financial institution of the seller, uniquely identified by its BIC. Unique and unambiguous identifier of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BICIdentification1 recursion level 0 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

BICIdentification1 members

Member name Description Data Type / Multiplicity
BIC Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 “Banking - Banking telecommunication messages - Business identifier code (BIC)”. IsoBICIdentifier - Required 1..1

ComparedDocumentReference building block

Identifies the documents compared in this report. Identifies a document by a unique identification and a version together with the submitter of the document. Also specifies the type of document and an index for easy referencing. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification10 recursion level 0 with max 1
class DocumentIdentification10{
    Identification IsoMax35Text
    Version IsoNumber
    Type DataSetType2Code
    DocumentIndex IsoMax3NumericText
}
DocumentIdentification10 *-- "1..1" BICIdentification1 : Submitter
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

DocumentIdentification10 members

Member name Description Data Type / Multiplicity
Identification Identification of a set of data. IsoMax35Text - Required 1..1
Version Unambiguous identification of the version of a set of data. Example: Version 1. IsoNumber - Required 1..1
Type Identifies the type of data set. DataSetType2Code - Required 1..1
Submitter Uniquely identifies the financial institution which has submitted the set of data by using a BIC. BICIdentification1 - Required 1..1
DocumentIndex Index assigned to the document, to allow easy referencing. IsoMax3NumericText - Required 1..1

SubmissionType building block

Specifies whether the data set was submitted for match or pre-match. Specifies the type of report. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ReportType3 recursion level 0 with max 1
class ReportType3{
    Type InstructionType3Code
}
  

ReportType3 members

Member name Description Data Type / Multiplicity
Type Specifies whether the report is for a matched or pre-matched data set. InstructionType3Code - Required 1..1

Report building block

Description of the differences between the data set(s) and the baseline. Description of the mis-matched situation between two baselines or between a baseline and a data set. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MisMatchReport3 recursion level 0 with max 1
class MisMatchReport3{
    NumberOfMisMatches IsoNumber
}
MisMatchReport3 *-- "0..0" ValidationResult5 : MisMatchInformation
%% ValidationResult5 recursion level 1 with max 1
class ValidationResult5{
    SequenceNumber IsoNumber
    RuleIdentification IsoMax35Text
    RuleDescription IsoMax350Text
}
ValidationResult5 *-- "0..0" ElementIdentification1 : MisMatchedElement
  

MisMatchReport3 members

Member name Description Data Type / Multiplicity
NumberOfMisMatches Total number of mismatches between two baselines or between one baseline and one data set. IsoNumber - Required 1..1
MisMatchInformation Details of each mismatch occurrence. ValidationResult5 - Unknown 0..0

RequestForAction building block

Information on the next processing step required. Specifies the event that require an action from one of the parties to the trade transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PendingActivity2 recursion level 0 with max 1
class PendingActivity2{
    Type Action2Code
    Description IsoMax140Text
}
  

PendingActivity2 members

Member name Description Data Type / Multiplicity
Type Code which specifies the next course of action that the receiver of the message must take. Action2Code - Required 1..1
Description Further information on the course of action that the receiver of the message must take. IsoMax140Text - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    DataSetMatchReportV03 --|> IOuterRecord : Implements
    DataSetMatchReportV03Document --|> IOuterDocument~DataSetMatchReportV03~ : Implements
    class IOuterDocument~DataSetMatchReportV03~ {
        DataSetMatchReportV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    DataSetMatchReportV03Document *-- DataSetMatchReportV03 : 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:tsmt.013.001.03">
    <DataSetMtchRpt>
        <RptId>
            <!-- ReportIdentification inner content -->
        </RptId>
        <TxId>
            <!-- TransactionIdentification inner content -->
        </TxId>
        <EstblishdBaselnId>
            <!-- EstablishedBaselineIdentification inner content -->
        </EstblishdBaselnId>
        <TxSts>
            <!-- TransactionStatus inner content -->
        </TxSts>
        <UsrTxRef>
            <!-- UserTransactionReference inner content -->
        </UsrTxRef>
        <Buyr>
            <!-- Buyer inner content -->
        </Buyr>
        <Sellr>
            <!-- Seller inner content -->
        </Sellr>
        <BuyrBk>
            <!-- BuyerBank inner content -->
        </BuyrBk>
        <SellrBk>
            <!-- SellerBank inner content -->
        </SellrBk>
        <CmpardDocRef>
            <!-- ComparedDocumentReference inner content -->
        </CmpardDocRef>
        <SubmissnTp>
            <!-- SubmissionType inner content -->
        </SubmissnTp>
        <Rpt>
            <!-- Report inner content -->
        </Rpt>
        <ReqForActn>
            <!-- RequestForAction inner content -->
        </ReqForActn>
    </DataSetMtchRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_m1ZuaNE8Ed-BzquC8wXy7w_-439674056"
  name="DataSetMatchReportV03"
  definition="Scope&#xD;&#xA;The DataSetMatchReport message is sent by the matching application to the parties involved in a data set match.&#xD;&#xA;This message is used to either&#xD;&#xA;- inform about the successful match of data sets submitted with the instruction match or pre-match (DataSetSubmission message) and the related baseline,or&#xD;&#xA;- inform about mis-matches found between data sets submitted with the instruction match or pre-match (DataSetSubmission message) and the related baseline.&#xD;&#xA;Usage&#xD;&#xA;The DataSetMatchReport message can be sent by the matching application to the party requesting a data set pre-match for a transaction established in the push-through mode. In the outlined scenario, the DataSetMatchReport message will either inform about the successful pre-match or list the mis-matches between the data set(s) conveyed with the DataSetSubmission message and the related baseline.&#xD;&#xA;or&#xD;&#xA;The DataSetMatchReport message can be sent by the matching application to the parties involved in a data set match for a transaction established in the push-through mode. In the outlined scenario, the DataSetMatchReport message will either inform about the successful match or list the mis-matches between the data set(s) conveyed with the DataSetSubmission message and the related baseline.&#xD;&#xA;or&#xD;&#xA;The DataSetMatchReport message can be sent by the matching application to the party requesting a data set match or pre-match for a transaction established in the lodge mode. In the outlined scenario, the DataSetMatchReport will either inform about the successful match or list the mis-matches between the data set(s) conveyed with the DataSetSubmission message and the related baseline."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="DataSetMtchRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_m1i4UNE8Ed-BzquC8wXy7w_-439673685"
    name="ReportIdentification"
    definition="Identifies the report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_m1i4UdE8Ed-BzquC8wXy7w_-439673654"
    name="TransactionIdentification"
    definition="Unique identification assigned by the matching application to the transaction.&#xA;This identification is to be used in any communication between the parties."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxId"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_m1i4UtE8Ed-BzquC8wXy7w_-439673715"
    name="EstablishedBaselineIdentification"
    definition="Unique identification assigned by the matching application to the baseline when it is established."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="EstblishdBaselnId"
    complexType="_RJNBwdp-Ed-ak6NoX_4Aeg_-1127047102" />
  <messageBuildingBlock
    xmi:id="_m1i4U9E8Ed-BzquC8wXy7w_-439673623"
    name="TransactionStatus"
    definition="Identifies the status of the transaction by means of a code."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="TxSts"
    complexType="_RbFb-Np-Ed-ak6NoX_4Aeg_1598523783" />
  <messageBuildingBlock
    xmi:id="_m1i4VNE8Ed-BzquC8wXy7w_-439673775"
    name="UserTransactionReference"
    definition="Reference to the transaction for each financial institution which is a party to the transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="2"
    minOccurs="0"
    xmlTag="UsrTxRef"
    complexType="_RJWLsdp-Ed-ak6NoX_4Aeg_-86119846" />
  <messageBuildingBlock
    xmi:id="_m1i4VdE8Ed-BzquC8wXy7w_-439673168"
    name="Buyer"
    definition="Party that buys goods or services, or a financial instrument."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Buyr"
    complexType="_PcH049p-Ed-ak6NoX_4Aeg_-1219999095" />
  <messageBuildingBlock
    xmi:id="_m1i4VtE8Ed-BzquC8wXy7w_-439673229"
    name="Seller"
    definition="Party that sells goods or services, or a financial instrument."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Sellr"
    complexType="_PcH049p-Ed-ak6NoX_4Aeg_-1219999095" />
  <messageBuildingBlock
    xmi:id="_m1i4V9E8Ed-BzquC8wXy7w_-439673291"
    name="BuyerBank"
    definition="The financial institution of the buyer, uniquely identified by its BIC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BuyrBk"
    complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
  <messageBuildingBlock
    xmi:id="_m1spUNE8Ed-BzquC8wXy7w_-439673345"
    name="SellerBank"
    definition="The financial institution of the seller, uniquely identified by its BIC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SellrBk"
    complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
  <messageBuildingBlock
    xmi:id="_m1spUdE8Ed-BzquC8wXy7w_-439674053"
    name="ComparedDocumentReference"
    definition="Identifies the documents compared in this report."
    registrationStatus="Provisionally Registered"
    minOccurs="2"
    xmlTag="CmpardDocRef"
    complexType="_RaMEFtp-Ed-ak6NoX_4Aeg_-793210991" />
  <messageBuildingBlock
    xmi:id="_m1spUtE8Ed-BzquC8wXy7w_-439673137"
    name="SubmissionType"
    definition="Specifies whether the data set was submitted for match or pre-match."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SubmissnTp"
    complexType="_RKFykdp-Ed-ak6NoX_4Aeg_1945213198" />
  <messageBuildingBlock
    xmi:id="_m1spU9E8Ed-BzquC8wXy7w_-439674024"
    name="Report"
    definition="Description of the differences between the data set(s) and the baseline."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Rpt"
    complexType="_RaowANp-Ed-ak6NoX_4Aeg_-1146148189" />
  <messageBuildingBlock
    xmi:id="_m1spVNE8Ed-BzquC8wXy7w_-439673260"
    name="RequestForAction"
    definition="Information on the next processing step required."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="ReqForActn"
    complexType="_RaowBtp-Ed-ak6NoX_4Aeg_-888447978" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="013"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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