ActivityReportSetUpRequestV02

tsmt.004.001.02

Scope The ActivityReportSetUpRequest message is sent by any party involved in a transaction to the matching application. The ActivityReportSetUpRequest message can be sent to request the reset of the pre-determined time at which the daily production of the activity report should take place. Usage This message is sent to the matching application by a bank, in order to set the UTC offset specifying the hour when the matching application will generate every day an activity report covering the last 24 hours and send it. By default, this offset is equal to 0.

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
%% ActivityReportSetUpRequestV02 recursion level 0 with max 0
ActivityReportSetUpRequestV02 *-- "1..1" MessageIdentification1 : RequestIdentification
ActivityReportSetUpRequestV02 *-- "1..1" UTCOffset1 : UTCOffset
  

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

UTCOffset building block

Specifies the parameters to calculate the local reporting time. Specifies the parameters to calculate the local reporting time. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% UTCOffset1 recursion level 0 with max 1
class UTCOffset1{
    Sign IsoPlusOrMinusIndicator
    NumberOfHours IsoISOTime
}
  

UTCOffset1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    ActivityReportSetUpRequestV02 --|> IOuterRecord : Implements
    ActivityReportSetUpRequestV02Document --|> IOuterDocument~ActivityReportSetUpRequestV02~ : Implements
    class IOuterDocument~ActivityReportSetUpRequestV02~ {
        ActivityReportSetUpRequestV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ActivityReportSetUpRequestV02Document *-- ActivityReportSetUpRequestV02 : 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.004.001.02">
    <ActvtyRptSetUpReq>
        <ReqId>
            <!-- RequestIdentification inner content -->
        </ReqId>
        <UTCOffset>
            <!-- UTCOffset inner content -->
        </UTCOffset>
    </ActvtyRptSetUpReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ihSN2NE8Ed-BzquC8wXy7w_-1378853261"
  name="ActivityReportSetUpRequestV02"
  definition="Scope&#xD;&#xA;The ActivityReportSetUpRequest message is sent by any party involved in a transaction to the matching application.&#xD;&#xA;The ActivityReportSetUpRequest message can be sent to request the reset of the pre-determined time at which the daily production of the activity report should take place.&#xD;&#xA;Usage&#xD;&#xA;This message is sent to the matching application by a bank, in order to set the UTC offset specifying the hour when the matching application will generate every day an activity report covering the last 24 hours and send it. By default, this offset is equal to 0."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="ActvtyRptSetUpReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ihSN2dE8Ed-BzquC8wXy7w_-1378853229"
    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="_ihSN2tE8Ed-BzquC8wXy7w_-1378852898"
    name="UTCOffset"
    definition="Specifies the parameters to calculate the local reporting time."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="UTCOffset"
    complexType="_RKPjkNp-Ed-ak6NoX_4Aeg_-688976051" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="004"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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