Iso20022

ActivityReportV03

tsmt.002.001.03

Scope The ActivityReport message is sent by the matching application to the requester of an activity report. This message is used to report on all transactions for which an activity has taken place within a given time span. Usage The ActivityReport message can be sent

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
%% ActivityReportV03 recursion level 0 with max 0
ActivityReportV03 *-- "1..1" MessageIdentification1 : ReportIdentification
ActivityReportV03 *-- "0..1" MessageIdentification1 : RelatedMessageReference
ActivityReportV03 *-- "0..1" ActivityReportItems2 : Report

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

RelatedMessageReference building block

Reference to the previous message requesting 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

Report building block

Describes the events that occurred for one transaction. Describes the events that occurred for one transaction. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ActivityReportItems2 recursion level 0 with max 1
class ActivityReportItems2{
    TransactionIdentification IsoMax35Text
}
ActivityReportItems2 *-- "0..2" DocumentIdentification5 : UserTransactionReference
ActivityReportItems2 *-- "1..1" BICIdentification1 : ReportedEntity
ActivityReportItems2 *-- "1..0" ActivityDetails1 : ReportedItem
ActivityReportItems2 *-- "0..0" PendingActivity2 : PendingRequestForAction
%% DocumentIdentification5 recursion level 1 with max 1
class DocumentIdentification5{
    Identification IsoMax35Text
}
DocumentIdentification5 *-- "1..1" BICIdentification1 : IdentificationIssuer
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
%% ActivityDetails1 recursion level 1 with max 1
class ActivityDetails1{
    DateTime IsoISODateTime
}
ActivityDetails1 *-- "1..1" Activity1 : Activity
ActivityDetails1 *-- "1..1" BICIdentification1 : Initiator
%% PendingActivity2 recursion level 1 with max 1
class PendingActivity2{
    Type Action2Code
    Description IsoMax140Text
}

ActivityReportItems2 members

Member name Description Data Type / Multiplicity
TransactionIdentification Unique identification assigned by the matching application to the transaction. This identification is to be used in any communication between the parties.
UserTransactionReference Reference to the transaction for each financial institution which is a party to the transaction. DocumentIdentification5 - Collection 0..2
ReportedEntity Entity for which the activity is reported. BICIdentification1 - Required 1..1
ReportedItem Describes an activity that took place during a period. ActivityDetails1 - Unknown 1..0
PendingRequestForAction Next processing step required. PendingActivity2 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ActivityReportV03 --|> IOuterRecord : Implements
    ActivityReportV03Document --|> IOuterDocument~ActivityReportV03~ : Implements
    class IOuterDocument~ActivityReportV03~ {
        ActivityReportV03 Message
     }

Document wrapper for serialization

The only real purpose ActivityReportV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:tsmt.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 ActivityReportV03.ToDocument() method. The returned ActivityReportV03Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    ActivityReportV03Document *-- ActivityReportV03 : 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.002.001.03">
    <ActvtyRpt>
        <RptId>
            <!-- ReportIdentification inner content -->
        </RptId>
        <RltdMsgRef>
            <!-- RelatedMessageReference inner content -->
        </RltdMsgRef>
        <Rpt>
            <!-- Report inner content -->
        </Rpt>
    </ActvtyRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_i8_5eNE8Ed-BzquC8wXy7w_1638780045"
  nextVersions="_fPCaYefGEeKNfc-Rw_dPYg"
  name="ActivityReportV03"
  definition="Scope&#xD;&#xA;The ActivityReport message is sent by the matching application to the requester of an activity report.&#xD;&#xA;This message is used to report on all transactions for which an activity has taken place within a given time span.&#xD;&#xA;Usage&#xD;&#xA;The ActivityReport message can be sent&#xD;&#xA;- at a pre-determined time every 24 hours. The message reports on all transactions that the requester is involved in and for which an activity has taken place within the last 24 hours.&#xD;&#xA;- on demand in response to an ActivityReportRequest message. The message reports on all transactions that the requester is involved in and for which an activity has taken place within a time span specified by the requester in the ActivityReportRequest message."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _urpIICeJEeOCeO5e7islRQ"
  xmlTag="ActvtyRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_i8_5edE8Ed-BzquC8wXy7w_1638780078"
    nextVersions="_fPCaZefGEeKNfc-Rw_dPYg"
    name="ReportIdentification"
    definition="Identifies the report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_i8_5etE8Ed-BzquC8wXy7w_1638780138"
    nextVersions="_fPCaZ-fGEeKNfc-Rw_dPYg"
    name="RelatedMessageReference"
    definition="Reference to the previous message requesting the report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="RltdMsgRef"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_i9JDYNE8Ed-BzquC8wXy7w_1638780107"
    nextVersions="_fPCaaefGEeKNfc-Rw_dPYg"
    name="Report"
    definition="Describes the events that occurred for one transaction."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="Rpt"
    complexType="_RZ5JL9p-Ed-ak6NoX_4Aeg_-990880323" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="002"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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