tag Document
type Document
path: /Document[1..1]
X-path: /Document
mode:
minOccurs 1
maxOccurs 1
Elements:
Document [Sequence]
GetGnlBizInf
tag GetGnlBizInf
type GetGeneralBusinessInformationV04
fullName GetGeneralBusinessInformationV04
path: /Document[1..1]/GetGnlBizInf[1..1]
X-path: /Document/GetGnlBizInf
mode: Sequence
minOccurs 1
maxOccurs 1
Documentation:
ISO Message 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.
Building Block:
Name MessageHeader
Definition Common business identification for the message.
Building Block:
Name GeneralBusinessInformationQueryDefinition
Definition Definition of the general business information query.
Building Block:
Name SupplementaryData
Definition Additional information that cannot be captured in the structured elements and/or any other specific block.
GetGnlBizInf
tag MsgHdr
type MessageHeader1
path: /Document[1..1]/GetGnlBizInf[1..1]/MsgHdr[1..1]
X-path: /Document/GetGnlBizInf/MsgHdr
mode: Sequence
minOccurs 1
maxOccurs 1
Documentation:
ISO Type Definition Set of characteristics, such as the identification or the creation date and time, specific to the message.
Elements:
Document/GetGnlBizInf/MsgHdr [Sequence]
MsgId Message Identification
CreDtTm Creation Date Time
GetGnlBizInf
+MsgHdr
tag MsgId
type Max35Text
fullName MessageIdentification
path: /Document[1..1]/GetGnlBizInf[1..1]/MsgHdr[1..1]/MsgId[1..1]
X-path: /Document/GetGnlBizInf/MsgHdr/MsgId
mode: Sequence
minOccurs 1
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name Message Identification
ISO Element Definition Point to point reference, as assigned by the sender, to unambiguously identify the message.
ISO Element Usage The sender has to make sure that MessageIdentification is unique for a pre-agreed period.
GetGnlBizInf
+MsgHdr
tag CreDtTm
type ISODateTime
fullName CreationDateTime
path: /Document[1..1]/GetGnlBizInf[1..1]/MsgHdr[1..1]/CreDtTm[0..1]
X-path: /Document/GetGnlBizInf/MsgHdr/CreDtTm
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Element Name Creation Date Time
ISO Element Definition Date and time at which the message was created.
GetGnlBizInf
tag GnlBizInfQryDef
type BusinessInformationQueryDefinition3
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Type Definition Defines the query criteria.
Elements:
Document/GetGnlBizInf/GnlBizInfQryDef [Sequence]
QryTp Query Type
GnlBizInfCrit General Business Information Criteria
GetGnlBizInf
+GnlBizInfQryDef
tag QryTp
type QueryType2Code
fullName QueryType
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/QryTp[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/QryTp
mode: Sequence
minOccurs 0
maxOccurs 1
Enumeration:
ALLL
Definition Specifies that the query requests that all matching items be returned.
Name All
ISO Definition Specifies that the query requests that all matching items be returned.
ISO Name All
CHNG
Definition Specifies that the query requests that only new matching items since the last similar query be returned.
Name Changed
ISO Definition Specifies that the query requests that only new matching items since the last similar query be returned.
ISO Name Changed
MODF
Definition Specifies that the query requests that only items that have changed since the last query be returned.
Name Modified
ISO Definition Specifies that the query requests that only items that have changed since the last query be returned.
ISO Name Modified
DELD
Definition Specifies that the query requests that items that have been deleted since the last query be returned.
Name Deleted
ISO Definition Specifies that the query requests that items that have been deleted since the last query be returned.
ISO Name Deleted
Documentation:
ISO Element Name Query Type
ISO Element Definition Specifies the type of matching items to be returned in the response to the query.
ISO Type Definition Specifies the nature of the query, i.e. whether the query requests that all matching items be returned or only new matching items since the last similar query be returned.
GetGnlBizInf
+GnlBizInfQryDef
tag GnlBizInfCrit
type GeneralBusinessInformationCriteriaDefinition1Choice
fullName GeneralBusinessInformationCriteria
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Element Name General Business Information Criteria
ISO Element Definition Defines the general business information query criteria.
ISO Type Definition Defines the information that is searched either implicitly by recalling a previous query or explicitly by defining the criteria.
Elements:
Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit [Choice]
QryNm Query Name
NewCrit New Criteria
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
tag QryNm
type Max35Text
fullName QueryName
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/QryNm[1..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/QryNm
mode: Choice
minOccurs 1
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name Query Name
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
tag NewCrit
type BusinessInformationCriteria1
fullName NewCriteria
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit
mode: Choice
minOccurs 1
maxOccurs 1
Documentation:
ISO Element Name New Criteria
ISO Type Definition Defines the criteria used to search for business information and to report on the business information. A name may be given to the new query.
Elements:
Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit [Sequence]
NewQryNm New Query Name
SchCrit Search Criteria
RtrCrit Return Criteria
Constraint:
Name ReturnCriteriaAndOrSearchCriteriaRule
Definition If ReturnCriteria is not present, then at least one occurrence of SearchCriteria must be present. If ReturnCriteria is present, then any occurrence of SearchCriteria is optional.
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
tag NewQryNm
type Max35Text
fullName NewQueryName
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/NewQryNm[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/NewQryNm
mode: Sequence
minOccurs 0
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name New Query Name
ISO Element Definition Name of the query defined by the search criteria and return criteria.
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
tag SchCrit
type GeneralBusinessInformationSearchCriteria1
fullName SearchCriteria
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit
mode: Sequence
minOccurs 0
maxOccurs unbounded
Documentation:
ISO Element Name Search Criteria
ISO Element Definition Defines the criteria based on which the information is extracted.
ISO Type Definition Defines the criteria used to search for business information.
Elements:
Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit [Sequence]
Ref Reference
Sbjt Subject
Qlfr Qualifier
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++SchCrit
tag Ref
type Max35Text
fullName Reference
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]/Ref[0..unbounded]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Ref
mode: Sequence
minOccurs 0
maxOccurs unbounded
minLength 1
maxLength 35
Documentation:
ISO Element Name Reference
ISO Element Definition Unique and unambiguous reference assigned to a general business information system.
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++SchCrit
tag Sbjt
type CharacterSearch1Choice
fullName Subject
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]/Sbjt[0..unbounded]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Sbjt
mode: Sequence
minOccurs 0
maxOccurs unbounded
Documentation:
ISO Element Name Subject
ISO Element Definition Subject line of an item of general business information, summarizing the topic and intended destination of the information.
ISO Type Definition Set of characters to be matched to be considered as valid.
Elements:
Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Sbjt [Choice]
EQ Equal
NEQ Not Equal
CT Contain
NCT Not Contain
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++SchCrit
+++++Sbjt
tag EQ
type Max35Text
fullName Equal
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]/Sbjt[0..unbounded]/EQ[1..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Sbjt/EQ
mode: Choice
minOccurs 1
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name Equal
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++SchCrit
+++++Sbjt
tag NEQ
type Max35Text
fullName NotEqual
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]/Sbjt[0..unbounded]/NEQ[1..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Sbjt/NEQ
mode: Choice
minOccurs 1
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name Not Equal
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++SchCrit
+++++Sbjt
tag CT
type Max35Text
fullName Contain
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]/Sbjt[0..unbounded]/CT[1..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Sbjt/CT
mode: Choice
minOccurs 1
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name Contain
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++SchCrit
+++++Sbjt
tag NCT
type Max35Text
fullName NotContain
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]/Sbjt[0..unbounded]/NCT[1..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Sbjt/NCT
mode: Choice
minOccurs 1
maxOccurs 1
minLength 1
maxLength 35
Documentation:
ISO Element Name Not Contain
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++SchCrit
tag Qlfr
type InformationQualifierType1
fullName Qualifier
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]/Qlfr[0..unbounded]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Qlfr
mode: Sequence
minOccurs 0
maxOccurs unbounded
Documentation:
ISO Element Name Qualifier
ISO Element Definition Further information about the criticality or importance of a general business information system.
ISO Type Definition Further qualifies the information provided in terms of its importance and its format.
Elements:
Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Qlfr [Sequence]
IsFrmtd Is Formatted
Prty Priority
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++SchCrit
+++++Qlfr
tag IsFrmtd
type YesNoIndicator
fullName IsFormatted
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]/Qlfr[0..unbounded]/IsFrmtd[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Qlfr/IsFrmtd
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Element Name Is Formatted
ISO Element Definition Indicates whether the information is formatted.
ISO Type Definition Indicates a "Yes" or "No" type of answer for an element.
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++SchCrit
+++++Qlfr
tag Prty
type Priority1Code
fullName Priority
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/SchCrit[0..unbounded]/Qlfr[0..unbounded]/Prty[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/SchCrit/Qlfr/Prty
mode: Sequence
minOccurs 0
maxOccurs 1
Enumeration:
HIGH
Definition Priority level is high.
Name High
ISO Definition Priority level is high.
ISO Name High
NORM
Definition Priority level is normal.
Name Normal
ISO Definition Priority level is normal.
ISO Name Normal
LOWW
Definition Priority level is low.
Name Low
ISO Definition Priority level is low.
ISO Name Low
Documentation:
ISO Element Name Priority
ISO Element Definition Priority of the information.
ISO Type Definition Specifies the priority level of an event.
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
tag RtrCrit
type GeneralBusinessInformationReturnCriteria1
fullName ReturnCriteria
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/RtrCrit[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/RtrCrit
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Element Name Return Criteria
ISO Element Definition Defines the expected report.
ISO Type Definition Defines the criteria used to report on business information.
Elements:
Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/RtrCrit [Sequence]
QlfrInd Qualifier Indicator
SbjtInd Subject Indicator
SbjtDtlsInd Subject Details Indicator
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++RtrCrit
tag QlfrInd
type RequestedIndicator
fullName QualifierIndicator
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/RtrCrit[0..1]/QlfrInd[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/RtrCrit/QlfrInd
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Element Name Qualifier Indicator
ISO Element Definition Indicates whether the qualifier is requested.
ISO Type Definition Indicates if requested or not.
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++RtrCrit
tag SbjtInd
type RequestedIndicator
fullName SubjectIndicator
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/RtrCrit[0..1]/SbjtInd[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/RtrCrit/SbjtInd
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Element Name Subject Indicator
ISO Element Definition Indicates whether the subject is requested.
ISO Type Definition Indicates if requested or not.
GetGnlBizInf
+GnlBizInfQryDef
++GnlBizInfCrit
+++NewCrit
++++RtrCrit
tag SbjtDtlsInd
type RequestedIndicator
fullName SubjectDetailsIndicator
path: /Document[1..1]/GetGnlBizInf[1..1]/GnlBizInfQryDef[0..1]/GnlBizInfCrit[0..1]/NewCrit[1..1]/RtrCrit[0..1]/SbjtDtlsInd[0..1]
X-path: /Document/GetGnlBizInf/GnlBizInfQryDef/GnlBizInfCrit/NewCrit/RtrCrit/SbjtDtlsInd
mode: Sequence
minOccurs 0
maxOccurs 1
Documentation:
ISO Element Name Subject Details Indicator
ISO Element Definition Indicates whether the subject details are requested.
ISO Type Definition Indicates if requested or not.
GetGnlBizInf
tag SplmtryData
type SupplementaryData1
path: /Document[1..1]/GetGnlBizInf[1..1]/SplmtryData[0..unbounded]
X-path: /Document/GetGnlBizInf/SplmtryData
mode: Sequence
minOccurs 0
maxOccurs unbounded
Documentation:
ISO Type Definition Additional information that can not be captured in the structured fields and/or any other specific block.
Elements:
Document/GetGnlBizInf/SplmtryData [Sequence]
PlcAndNm Place And Name
Envlp Envelope
Constraint:
Name SupplementaryDataRule
Definition This component may not be used without the explicit approval of a SEG and submission to the RA of ISO 20022 compliant structure(s) to be used in the Envelope element.
GetGnlBizInf
+SplmtryData
tag PlcAndNm
type Max350Text
fullName PlaceAndName
path: /Document[1..1]/GetGnlBizInf[1..1]/SplmtryData[0..unbounded]/PlcAndNm[0..1]
X-path: /Document/GetGnlBizInf/SplmtryData/PlcAndNm
mode: Sequence
minOccurs 0
maxOccurs 1
minLength 1
maxLength 350
Documentation:
ISO Element Name Place And Name
ISO Element Definition 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.
GetGnlBizInf
+SplmtryData
tag Envlp
type SupplementaryDataEnvelope1
fullName Envelope
path: /Document[1..1]/GetGnlBizInf[1..1]/SplmtryData[0..unbounded]/Envlp[1..1]
X-path: /Document/GetGnlBizInf/SplmtryData/Envlp
mode: Sequence
minOccurs 1
maxOccurs 1
Documentation:
ISO Element Name Envelope
ISO Element Definition Technical element wrapping the supplementary data.
ISO Type Definition Technical component that contains the validated supplementary data information. This technical envelope allows to segregate the supplementary data information from any other information.
Elements:
Document/GetGnlBizInf/SplmtryData/Envlp [Sequence]