camt.019.001.07
Scope The ReturnBusinessDayInformation message is sent by the transaction administrator to a member of the system. It is used to provide information on different types of administrative data linked to the system. The ReturnBusinessDayInformation message can be sent as a response to a related GetBusines DayInformation message (pull mode), or initiated by the transaction administrator (push mode). The push of information can take place either at prearranged times or as a warning or alarm when a problem has occurred. Usage The transaction administrator is in charge of providing the members with business information. The term business day information covers all information related to the management of the system, that is, not related to the transactions or requests created in the system. The type of business information available can vary depending on the system. The member can request information about the static data of the system through a series of criteria, corresponding to the known information stored within the transaction administrator. Based on the criteria received within the request, the transaction administrator will select items that match the request and report them to the requester. The transaction administrator may also send a ReturnBusinessDayInformation message with pre-defined information at times previously agreed with the member or to warn the member about a particular problem that may have arisen and which needs attention. The message from the transaction administrator can contain information based on the following elements:
- identification of the system
- status of the system and period in which this status is valid
- currency within the system concerned and details of the hours of availability linked to that particular currency
- events related to the functioning of the system and the timing of their occurrence Additional information on the generic design of the Get/Return messages can be found in the MDR Part 1 section How to Use the Cash Management Messages.
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
%% ReturnBusinessDayInformationV07 recursion level 0 with max 0
ReturnBusinessDayInformationV07 *-- "1..1" MessageHeader7 : MessageHeader
ReturnBusinessDayInformationV07 *-- "1..1" IBusinessDayReportOrError9Choice : ReportOrError
ReturnBusinessDayInformationV07 *-- "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. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MessageHeader7 recursion level 0 with max 1
class MessageHeader7{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
QueryName IsoMax35Text
}
MessageHeader7 *-- "0..1" IRequestType4Choice : RequestType
MessageHeader7 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
%% IRequestType4Choice recursion level 1 with max 1
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader7 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 |
| RequestType | Specific actions to be executed through the request. | IRequestType4Choice - Optional 0..1 |
| OriginalBusinessQuery | Unique identification of the original query message. | OriginalBusinessQuery1 - Optional 0..1 |
| QueryName | Recalls the criteria (search and return criteria) defined in a preceding query. | IsoMax35Text - Optional 0..1 |
ReportOrError building block
Reports on business day information. Choice between business day information details or an operational error when the requested data cannot be retrieved. For comparison, see the ISO20022 official specification
classDiagram direction tb %% IBusinessDayReportOrError9Choice recursion level 0 with max 1
BusinessDayReportOrError9Choice 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 ReturnBusinessDayInformationV07 implementation follows a specific implementaiton pattern. First of all, ReturnBusinessDayInformationV07 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ReturnBusinessDayInformationV07Document implements IOuterDocument. Because ReturnBusinessDayInformationV07 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ReturnBusinessDayInformationV07.
classDiagram
class IOuterRecord
ReturnBusinessDayInformationV07 --|> IOuterRecord : Implements
ReturnBusinessDayInformationV07Document --|> IOuterDocument~ReturnBusinessDayInformationV07~ : Implements
class IOuterDocument~ReturnBusinessDayInformationV07~ {
ReturnBusinessDayInformationV07 Message
}
Document wrapper for serialization
The only real purpose ReturnBusinessDayInformationV07Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.019.001.07’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ReturnBusinessDayInformationV07.ToDocument() method. The returned ReturnBusinessDayInformationV07Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ReturnBusinessDayInformationV07Document *-- ReturnBusinessDayInformationV07 : 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:camt.019.001.07">
<RtrBizDayInf>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RptOrErr>
<!-- ReportOrError inner content -->
</RptOrErr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</RtrBizDayInf>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_jwlcARbvEeiyVv5j1vf1VQ"
name="ReturnBusinessDayInformationV07"
definition="Scope
The ReturnBusinessDayInformation message is sent by the transaction administrator to a member of the system.
It is used to provide information on different types of administrative data linked to the system.
The ReturnBusinessDayInformation message can be sent as a response to a related GetBusines DayInformation message (pull mode), or initiated by the transaction administrator (push mode). The push of information can take place either at prearranged times or as a warning or alarm when a problem has occurred.
Usage
The transaction administrator is in charge of providing the members with business information. The term business day information covers all information related to the management of the system, that is, not related to the transactions or requests created in the system. The type of business information available can vary depending on the system.
The member can request information about the static data of the system through a series of criteria, corresponding to the known information stored within the transaction administrator. Based on the criteria received within the request, the transaction administrator will select items that match the request and report them to the requester.
The transaction administrator may also send a ReturnBusinessDayInformation message with pre-defined information at times previously agreed with the member or to warn the member about a particular problem that may have arisen and which needs attention.
The message from the transaction administrator can contain information based on the following elements:
- identification of the system
- status of the system and period in which this status is valid
- currency within the system concerned and details of the hours of availability linked to that particular currency
- events related to the functioning of the system and the timing of their occurrence
Additional information on the generic design of the Get/Return messages can be found in the MDR Part 1 section How to Use the Cash Management Messages."
registrationStatus="Registered"
messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
xmlTag="RtrBizDayInf"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jwlcAxbvEeiyVv5j1vf1VQ"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_imfkUZIhEeect698_YsnIA" />
<messageBuildingBlock
xmi:id="_jwlcBRbvEeiyVv5j1vf1VQ"
name="ReportOrError"
definition="Reports on business day information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RptOrErr"
complexType="_N58csXXyEei3jO6riKEVXg" />
<messageBuildingBlock
xmi:id="_jwlcBxbvEeiyVv5j1vf1VQ"
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="camt"
messageFunctionality="019"
flavour="001"
version="07" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.