camt.020.001.04
Scope The GetGeneralBusinessInformation message is sent by a member to the transaction administrator. It is used to request information on a broadcast-type message previously sent by the transaction administrator to all or some of the members, giving information related to the processing business. Usage The transaction administrator can send general business information messages to the members, which may request further action from them. General business information can contain either static data announcing foreseen events affecting the system operations, or dynamic data warning or notifying about unexpected events. This type of information can be transmitted in either of the two following ways:
- non-solicited reports are pushed by the transaction administrator to the (selected) members together with a reference, a qualifier and a subject line
- upon request from the members (pull mode), the transaction administrator delivers the full text/content of the message back to the user The Get General Business Information message is used in this second context. At any time during the operating hours of the system, the member can query the transaction administrator to get information about a report of general business information previously sent. The member can request information based on the following elements:
- reference of the report previously delivered
- subject of the report previously delivered, detailing the purpose and content of the message
- priority of the report previously sent, and indication of its format. (Note that if the format is indicated, the subject refers to a set of pre-agreed texts. This enumeration has to be agreed upon by the transaction administrator and the members of the system.)
- details of the previously sent message This message will be replied to by a ReturnGeneralBusinessInformation 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
%% GetGeneralBusinessInformationV04 recursion level 0 with max 0
GetGeneralBusinessInformationV04 *-- "1..1" MessageHeader1 : MessageHeader
GetGeneralBusinessInformationV04 *-- "0..1" BusinessInformationQueryDefinition3 : GeneralBusinessInformationQueryDefinition
GetGeneralBusinessInformationV04 *-- "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
%% MessageHeader1 recursion level 0 with max 1
class MessageHeader1{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader1 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. | IsoMax35Text - Required 1..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Optional 0..1 |
GeneralBusinessInformationQueryDefinition building block
Definition of the general business information query. Defines the query criteria. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% BusinessInformationQueryDefinition3 recursion level 0 with max 1
class BusinessInformationQueryDefinition3{
QueryType QueryType2Code
}
BusinessInformationQueryDefinition3 *-- "0..1" IGeneralBusinessInformationCriteriaDefinition1Choice : GeneralBusinessInformationCriteria
%% IGeneralBusinessInformationCriteriaDefinition1Choice recursion level 1 with max 1
BusinessInformationQueryDefinition3 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 |
| GeneralBusinessInformationCriteria | Defines the general business information query criteria. | IGeneralBusinessInformationCriteriaDefinition1Choice - 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 GetGeneralBusinessInformationV04 implementation follows a specific implementaiton pattern. First of all, GetGeneralBusinessInformationV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, GetGeneralBusinessInformationV04Document implements IOuterDocument. Because GetGeneralBusinessInformationV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type GetGeneralBusinessInformationV04.
classDiagram
class IOuterRecord
GetGeneralBusinessInformationV04 --|> IOuterRecord : Implements
GetGeneralBusinessInformationV04Document --|> IOuterDocument~GetGeneralBusinessInformationV04~ : Implements
class IOuterDocument~GetGeneralBusinessInformationV04~ {
GetGeneralBusinessInformationV04 Message
}
Document wrapper for serialization
The only real purpose GetGeneralBusinessInformationV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.020.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using GetGeneralBusinessInformationV04.ToDocument() method. The returned GetGeneralBusinessInformationV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram
GetGeneralBusinessInformationV04Document *-- GetGeneralBusinessInformationV04 : 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.020.001.04">
<GetGnlBizInf>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<GnlBizInfQryDef>
<!-- GeneralBusinessInformationQueryDefinition inner content -->
</GnlBizInfQryDef>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</GetGnlBizInf>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_jwlbfxbvEeiyVv5j1vf1VQ"
name="GetGeneralBusinessInformationV04"
definition="Scope
The GetGeneralBusinessInformation message is sent by a member to the transaction administrator.
It is used to request information on a broadcast-type message previously sent by the transaction administrator to all or some of the members, giving information related to the processing business.
Usage
The transaction administrator can send general business information messages to the members, which may request further action from them. General business information can contain either static data announcing foreseen events affecting the system operations, or dynamic data warning or notifying about unexpected events.
This type of information can be transmitted in either of the two following ways:
- non-solicited reports are pushed by the transaction administrator to the (selected) members together with a reference, a qualifier and a subject line
- upon request from the members (pull mode), the transaction administrator delivers the full text/content of the message back to the user
The Get General Business Information message is used in this second context. At any time during the operating hours of the system, the member can query the transaction administrator to get information about a report of general business information previously sent.
The member can request information based on the following elements:
- reference of the report previously delivered
- subject of the report previously delivered, detailing the purpose and content of the message
- priority of the report previously sent, and indication of its format. (Note that if the format is indicated, the subject refers to a set of pre-agreed texts. This enumeration has to be agreed upon by the transaction administrator and the members of the system.)
- details of the previously sent message
This message will be replied to by a ReturnGeneralBusinessInformation 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="GetGnlBizInf"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jwlbgRbvEeiyVv5j1vf1VQ"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_75DzkaMgEeCJ6YNENx4h-w_-613853819" />
<messageBuildingBlock
xmi:id="_jwlbgxbvEeiyVv5j1vf1VQ"
name="GeneralBusinessInformationQueryDefinition"
definition="Definition of the general business information query."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="GnlBizInfQryDef"
complexType="_1NvnkZlZEeeE1Ya-LgRsuQ" />
<messageBuildingBlock
xmi:id="_jwlbhRbvEeiyVv5j1vf1VQ"
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="020"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.