GetBusinessDayInformationV05

camt.018.001.05

Scope The GetBusinessDayInformation message is sent by a member to the transaction administrator. It is used to request information on different types of administrative data linked to the system. 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, not related to the transactions created in the system. The type of business day information available can vary depending on the system. At any time during the operating hours of the system, the member can query the transaction administrator to get information about the static data of the system. The member can request information based on the following elements:

identification of the system
currency within the system concerned
status of the system
period of availability of a given currency linked to the system concerned (in case the system handles more than one currency)
closure information (dates when the system will be inactive and reasons for this inactivity)
event indicator (types of event and precise timing of their occurrence within the system concerned) This message will be replied to by a ReturnBusinessDayInformation message. Additional information on the generic design of the Get/Return messages can be found in the 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
%% GetBusinessDayInformationV05 recursion level 0 with max 0
GetBusinessDayInformationV05 *-- "1..1" MessageHeader9 : MessageHeader
GetBusinessDayInformationV05 *-- "0..1" BusinessDayQuery2 : BusinessDayInformationQueryDefinition
GetBusinessDayInformationV05 *-- "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
%% MessageHeader9 recursion level 0 with max 1
class MessageHeader9{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
MessageHeader9 *-- "0..1" IRequestType4Choice : RequestType
%% IRequestType4Choice recursion level 1 with max 1

MessageHeader9 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

BusinessDayInformationQueryDefinition building block

Defines the business day information query criteria. Defines the query criteria. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BusinessDayQuery2 recursion level 0 with max 1
class BusinessDayQuery2{
    QueryType QueryType2Code
}
BusinessDayQuery2 *-- "0..1" IBusinessDayCriteria3Choice : Criteria
%% IBusinessDayCriteria3Choice recursion level 1 with max 1

BusinessDayQuery2 members

Member name	Description	Data Type / Multiplicity
QueryType	Specifies the type of matching items to be returned in the response to the query.	QueryType2Code - Optional 0..1
Criteria	Defines the business day information query criteria.	IBusinessDayCriteria3Choice - Optional 0..1

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 GetBusinessDayInformationV05 implementation follows a specific implementaiton pattern. First of all, GetBusinessDayInformationV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, GetBusinessDayInformationV05Document implements IOuterDocument. Because GetBusinessDayInformationV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type GetBusinessDayInformationV05.

classDiagram
    class IOuterRecord
    GetBusinessDayInformationV05 --|> IOuterRecord : Implements
    GetBusinessDayInformationV05Document --|> IOuterDocument~GetBusinessDayInformationV05~ : Implements
    class IOuterDocument~GetBusinessDayInformationV05~ {
        GetBusinessDayInformationV05 Message
     }

Document wrapper for serialization

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

classDiagram
    GetBusinessDayInformationV05Document *-- GetBusinessDayInformationV05 : 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.018.001.05">
    <GetBizDayInf>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <BizDayInfQryDef>
            <!-- BusinessDayInformationQueryDefinition inner content -->
        </BizDayInfQryDef>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </GetBizDayInf>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_jwlbbxbvEeiyVv5j1vf1VQ"
  name="GetBusinessDayInformationV05"
  definition="Scope&#xD;&#xA;The GetBusinessDayInformation message is sent by a member to the transaction administrator.&#xD;&#xA;It is used to request information on different types of administrative data linked to the system.&#xD;&#xA;Usage&#xD;&#xA;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, not related to the transactions created in the system. The type of business day information available can vary depending on the system.&#xD;&#xA;At any time during the operating hours of the system, the member can query the transaction administrator to get information about the static data of the system.&#xD;&#xA;The member can request information based on the following elements:&#xD;&#xA;- identification of the system&#xD;&#xA;- currency within the system concerned&#xD;&#xA;- status of the system&#xD;&#xA;- period of availability of a given currency linked to the system concerned (in case the system handles more than one currency)&#xD;&#xA;- closure information (dates when the system will be inactive and reasons for this inactivity)&#xD;&#xA;- event indicator (types of event and precise timing of their occurrence within the system concerned)&#xD;&#xA;This message will be replied to by a ReturnBusinessDayInformation message. Additional information on the generic design of the Get/Return messages can be found in the section How to Use the Cash Management Messages."
  registrationStatus="Registered"
  messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
  xmlTag="GetBizDayInf"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_jwlbcRbvEeiyVv5j1vf1VQ"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_jAUZkZIhEeect698_YsnIA" />
  <messageBuildingBlock
    xmi:id="_jwlbcxbvEeiyVv5j1vf1VQ"
    name="BusinessDayInformationQueryDefinition"
    definition="Defines the business day information query criteria."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="BizDayInfQryDef"
    complexType="_x03f5ZlcEeeE1Ya-LgRsuQ" />
  <messageBuildingBlock
    xmi:id="_jwlbdRbvEeiyVv5j1vf1VQ"
    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="018"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

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