ActivityReportRequestV03

tsmt.003.001.03

Scope The ActivityReportRequest message is sent by any party involved in a transaction to the matching application. This message is used to request a report on all transactions for which an activity has taken place within a given time span. Usage The ActivityReportRequest message can be sent

• at a pre-determined time. The message requests a report on all transactions that the requester is involved in and for which an activity has taken place within the last 24 hours.
• on demand. The message requests a report 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.

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
%% ActivityReportRequestV03 recursion level 0 with max 0
ActivityReportRequestV03 *-- "1..1" MessageIdentification1 : RequestIdentification
ActivityReportRequestV03 *-- "0..1" BICIdentification1 : EntitiesToBeReported
ActivityReportRequestV03 *-- "1..1" DateTimePeriodDetails1 : ReportPeriod
  

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

RequestIdentification building block

Identifies the request 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

EntitiesToBeReported building block

Specifies the entities of the submitter for which the activities have to be reported. 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

ReportPeriod building block

Specifies the period for which activities have to be reported. Time span defined by a start date and time, and an end date and time. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DateTimePeriodDetails1 recursion level 0 with max 1
class DateTimePeriodDetails1{
    FromDateTime IsoISODateTime
    ToDateTime IsoISODateTime
}
  

DateTimePeriodDetails1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ActivityReportRequestV03 --|> IOuterRecord : Implements
    ActivityReportRequestV03Document --|> IOuterDocument~ActivityReportRequestV03~ : Implements
    class IOuterDocument~ActivityReportRequestV03~ {
        ActivityReportRequestV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ActivityReportRequestV03Document *-- ActivityReportRequestV03 : 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.003.001.03">
    <ActvtyReqRpt>
        <ReqId>
            <!-- RequestIdentification inner content -->
        </ReqId>
        <NttiesToBeRptd>
            <!-- EntitiesToBeReported inner content -->
        </NttiesToBeRptd>
        <RptPrd>
            <!-- ReportPeriod inner content -->
        </RptPrd>
    </ActvtyReqRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_iE0UQNE8Ed-BzquC8wXy7w_1228841128"
  name="ActivityReportRequestV03"
  definition="Scope&#xD;&#xA;The ActivityReportRequest message is sent by any party involved in a transaction to the matching application.&#xD;&#xA;This message is used to request a report on all transactions for which an activity has taken place within a given time span.&#xD;&#xA;Usage&#xD;&#xA;The ActivityReportRequest message can be sent&#xD;&#xA;- at a pre-determined time. The message requests a report 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. The message requests a report 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."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="ActvtyReqRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_iE0UQdE8Ed-BzquC8wXy7w_1228841159"
    name="RequestIdentification"
    definition="Identifies the request message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ReqId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_iE0UQtE8Ed-BzquC8wXy7w_1228841591"
    name="EntitiesToBeReported"
    definition="Specifies the entities of the submitter for which the activities have to be reported."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="NttiesToBeRptd"
    complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
  <messageBuildingBlock
    xmi:id="_iE0UQ9E8Ed-BzquC8wXy7w_1228841529"
    name="ReportPeriod"
    definition="Specifies the period for which activities have to be reported."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptPrd"
    complexType="_T5xr8dp-Ed-ak6NoX_4Aeg_-1128572161" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="003"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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