reda.043.001.01
The PartyAuditTrailReport message is sent by the executing party to an instructing party to provide detailed information on the requested party audit trail recorded in the system.
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
%% PartyAuditTrailReportV01 recursion level 0 with max 0
PartyAuditTrailReportV01 *-- "0..1" MessageHeader12 : MessageHeader
PartyAuditTrailReportV01 *-- "1..1" IPartyAuditTrailOrError1Choice : ReportOrError
PartyAuditTrailReportV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
MessageHeader building block
Common business identification for the message. Specifies the header data such as the identification and the creation date and time, specific to the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MessageHeader12 recursion level 0 with max 1
class MessageHeader12{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader12 *-- "0..1" OriginalBusinessInstruction1 : OriginalBusinessInstruction
%% OriginalBusinessInstruction1 recursion level 1 with max 1
class OriginalBusinessInstruction1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader12 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the sender, to unambiguously identify the message. | Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period. |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Optional 0..1 |
| OriginalBusinessInstruction | Unique identification of the original instruction. | OriginalBusinessInstruction1 - Optional 0..1 |
ReportOrError building block
Provides the party audit trail data or error resulting from the audit trail query request. Used to report between the party reference data or an operational error. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IPartyAuditTrailOrError1Choice recursion level 0 with max 1
PartyAuditTrailOrError1Choice members
| Member name | Description | Data Type / Multiplicity |
|---|
SupplementaryData building block
Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
SupplementaryData1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
| Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the PartyAuditTrailReportV01 implementation follows a specific implementaiton pattern. First of all, PartyAuditTrailReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PartyAuditTrailReportV01Document implements IOuterDocument. Because PartyAuditTrailReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PartyAuditTrailReportV01.
classDiagram
class IOuterRecord
PartyAuditTrailReportV01 --|> IOuterRecord : Implements
PartyAuditTrailReportV01Document --|> IOuterDocument~PartyAuditTrailReportV01~ : Implements
class IOuterDocument~PartyAuditTrailReportV01~ {
PartyAuditTrailReportV01 Message
}
Document wrapper for serialization
The only real purpose PartyAuditTrailReportV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.043.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using PartyAuditTrailReportV01.ToDocument() method. The returned PartyAuditTrailReportV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
PartyAuditTrailReportV01Document *-- PartyAuditTrailReportV01 : 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:reda.043.001.01">
<PtyAudtTrlRpt>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RptOrErr>
<!-- ReportOrError inner content -->
</RptOrErr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</PtyAudtTrlRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_88xHgZeSEeen_cyMrluY4w"
name="PartyAuditTrailReportV01"
definition="The PartyAuditTrailReport message is sent by the executing party to an instructing party to provide detailed information on the requested party audit trail recorded in the system."
registrationStatus="Registered"
messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
xmlTag="PtyAudtTrlRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_QvJJ0VhGEeih3fUfzR38Ig"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="MsgHdr"
complexType="_Hm0DQYtSEeih5rmIxWMzEw" />
<messageBuildingBlock
xmi:id="_88xHi5eSEeen_cyMrluY4w"
name="ReportOrError"
definition="Provides the party audit trail data or error resulting from the audit trail query request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptOrErr"
complexType="_QgdAwZ9uEee7Qpz45yWJJw" />
<messageBuildingBlock
xmi:id="_88xHjZeSEeen_cyMrluY4w"
name="SupplementaryData"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="reda"
messageFunctionality="043"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.