ErrorReportV03

tsmt.016.001.03

Scope The ErrorReport message is sent by the matching application to the party from which it received a message. This message is used to inform about the inability of the matching application to process a received message. Usage The ErrorReport message can be sent to a party from which the matching application received a message to inform about its inability to process the received message because

• the syntax of the message is incorrect,or
• the message content is inconsistent,or
• according to the workflow implemented in the matching application, it did not expect the received message.

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
%% ErrorReportV03 recursion level 0 with max 0
ErrorReportV03 *-- "1..1" MessageIdentification1 : ReportIdentification
ErrorReportV03 *-- "0..1" SimpleIdentificationInformation : TransactionIdentification
ErrorReportV03 *-- "0..1" DocumentIdentification3 : EstablishedBaselineIdentification
ErrorReportV03 *-- "0..1" TransactionStatus4 : TransactionStatus
ErrorReportV03 *-- "0..1" DocumentIdentification5 : UserTransactionReference
ErrorReportV03 *-- "0..1" MessageIdentification1 : RejectedMessageReference
ErrorReportV03 *-- "1..1" Count1 : NumberOfErrors
ErrorReportV03 *-- "1..1" ValidationResult3 : ErrorDescription
ErrorReportV03 *-- "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

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

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

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

UserTransactionReference building block

Reference to the transaction for the financial institution which is the sender of the rejected message. 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

RejectedMessageReference building block

Reference to the identification of the rejected message. 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

NumberOfErrors building block

Specifies the total number of errors identified in the rejected message. Specifies a sequence number or a total. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Count1 recursion level 0 with max 1
class Count1{
    Number IsoNumber
}
  

Count1 members

ErrorDescription building block

Describes the error that is the cause of the rejection. Describes the error that is the cause of the rejection. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ValidationResult3 recursion level 0 with max 1
class ValidationResult3{
    SequenceNumber IsoNumber
    RuleIdentification IsoMax35Text
    RuleDescription IsoMax350Text
}
ValidationResult3 *-- "0..0" ElementIdentification3 : Element
%% ElementIdentification3 recursion level 1 with max 1
class ElementIdentification3{
    ElementPath IsoMax350Text
    ElementName IsoMax35Text
    ElementValue IsoMax140Text
}
  

ValidationResult3 members

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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ErrorReportV03 --|> IOuterRecord : Implements
    ErrorReportV03Document --|> IOuterDocument~ErrorReportV03~ : Implements
    class IOuterDocument~ErrorReportV03~ {
        ErrorReportV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ErrorReportV03Document *-- ErrorReportV03 : 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.016.001.03">
    <ErrRpt>
        <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>
        <RjctdMsgRef>
            <!-- RejectedMessageReference inner content -->
        </RjctdMsgRef>
        <NbOfErrs>
            <!-- NumberOfErrors inner content -->
        </NbOfErrs>
        <ErrDesc>
            <!-- ErrorDescription inner content -->
        </ErrDesc>
        <ReqForActn>
            <!-- RequestForAction inner content -->
        </ReqForActn>
    </ErrRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_oHDjhdE8Ed-BzquC8wXy7w_-1687018808"
  name="ErrorReportV03"
  definition="Scope&#xD;&#xA;The ErrorReport message is sent by the matching application to the party from which it received a message.&#xD;&#xA;This message is used to inform about the inability of the matching application to process a received message.&#xD;&#xA;Usage&#xD;&#xA;The ErrorReport message can be sent to a party from which the matching application received a message to inform about its inability to process the received message because&#xD;&#xA;- the syntax of the message is incorrect,or&#xD;&#xA;- the message content is inconsistent,or&#xD;&#xA;- according to the workflow implemented in the matching application, it did not expect the received message."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="ErrRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_oHDjhtE8Ed-BzquC8wXy7w_-1686098714"
    name="ReportIdentification"
    definition="Identifies the report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_oHDjh9E8Ed-BzquC8wXy7w_-1686098652"
    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.&#xA;."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="TxId"
    complexType="_P-ile9p-Ed-ak6NoX_4Aeg_745508310" />
  <messageBuildingBlock
    xmi:id="_oHDjiNE8Ed-BzquC8wXy7w_-1686098591"
    name="EstablishedBaselineIdentification"
    definition="Unique identification assigned by the matching application to the baseline when it is established."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="EstblishdBaselnId"
    complexType="_RJNBwdp-Ed-ak6NoX_4Aeg_-1127047102" />
  <messageBuildingBlock
    xmi:id="_oHDjidE8Ed-BzquC8wXy7w_-1686098560"
    name="TransactionStatus"
    definition="Identifies the status of the transaction by means of a code."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="TxSts"
    complexType="_RbFb-Np-Ed-ak6NoX_4Aeg_1598523783" />
  <messageBuildingBlock
    xmi:id="_oHDjitE8Ed-BzquC8wXy7w_-1686098745"
    name="UserTransactionReference"
    definition="Reference to the transaction for the financial institution which is the sender of the rejected message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="UsrTxRef"
    complexType="_RJWLsdp-Ed-ak6NoX_4Aeg_-86119846" />
  <messageBuildingBlock
    xmi:id="_oHDji9E8Ed-BzquC8wXy7w_-1686098683"
    name="RejectedMessageReference"
    definition="Reference to the identification of the rejected message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="RjctdMsgRef"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_oHNUgNE8Ed-BzquC8wXy7w_-1687018798"
    name="NumberOfErrors"
    definition="Specifies the total number of errors identified in the rejected message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="NbOfErrs"
    complexType="_RJDQxNp-Ed-ak6NoX_4Aeg_1838853440" />
  <messageBuildingBlock
    xmi:id="_oHNUgdE8Ed-BzquC8wXy7w_-1686098797"
    name="ErrorDescription"
    definition="Describes the error that is the cause of the rejection."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="ErrDesc"
    complexType="_RFLdYdp-Ed-ak6NoX_4Aeg_-1930823301" />
  <messageBuildingBlock
    xmi:id="_oHNUgtE8Ed-BzquC8wXy7w_-1686098530"
    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="016"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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