Iso20022

BusinessMessageEnvelopeV01

nvlp.001.001.01

The BusinessMessageEnvelope is a technical message container used to bundle a business application header with a message definition, typically to support processing or transport. It may contain and define additional data elements that apply to the message instance container.

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
%% BusinessMessageEnvelopeV01 recursion level 0 with max 0
BusinessMessageEnvelopeV01 *-- "0..1" IsoLaxPayload : Header
BusinessMessageEnvelopeV01 *-- "1..1" IsoLaxPayload : Document
BusinessMessageEnvelopeV01 *-- "0..1" Reference22 : Reference
BusinessMessageEnvelopeV01 *-- "0..1" SupplementaryData1 : SupplementaryData

Now, we will zero-in one-by-one on each of these building blocks.

Header building block

ISO 20022 Business Application Header instance. Rule: The external schema must be an official ISO 20022 Business Application Header. Specifies a data structure that allows to include any valid XML Structure (e.g. through an XML Schema). The property namespace is set to ‘any’. The processContents value is ’lax’ which according to the above specification and to Iso20022:2013 means: If the item has a uniquely determined declaration available, it must be ·valid· with respect to that definition, that is, ·validate· if you can, don’t worry if you can’t, i.e. it MAY be validated or not. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IsoLaxPayload recursion level 0 with max 1

LaxPayload members

Member name Description Data Type / Multiplicity

Document building block

ISO 20022 Message Definition instance. Rule: The external schema must be an official ISO 20022 Message Definition. Specifies a data structure that allows to include any valid XML Structure (e.g. through an XML Schema). The property namespace is set to ‘any’. The processContents value is ’lax’ which according to the above specification and to Iso20022:2013 means: If the item has a uniquely determined declaration available, it must be ·valid· with respect to that definition, that is, ·validate· if you can, don’t worry if you can’t, i.e. it MAY be validated or not. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IsoLaxPayload recursion level 0 with max 1

LaxPayload members

Member name Description Data Type / Multiplicity

Reference building block

Reference related to the delivery of the business message whilst in transit from sending to receiving business application. Reference of the business message envelope. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Reference22 recursion level 0 with max 1
class Reference22{
    Name IsoMax35Text
}
Reference22 *-- "1..1" PartyIdentification135 : Issuer
Reference22 *-- "1..1" IReferenceValue1Choice : Value
Reference22 *-- "0..0" SupplementaryData1 : SupplementaryData
%% PartyIdentification135 recursion level 1 with max 1
class PartyIdentification135{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification135 *-- "0..1" PostalAddress24 : PostalAddress
PartyIdentification135 *-- "0..1" IParty38Choice : Identification
PartyIdentification135 *-- "0..1" Contact4 : ContactDetails
%% IReferenceValue1Choice recursion level 1 with max 1
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

Reference22 members

Member name Description Data Type / Multiplicity
Name Name of the reference. IsoMax35Text - Optional 0..1
Issuer Issuer of the reference. PartyIdentification135 - Required 1..1
Value Value of the reference. IReferenceValue1Choice - Required 1..1
SupplementaryData Additional information that cannot be captured in the structured fields and/or any other specific block. SupplementaryData1 - Unknown 0..0

SupplementaryData building block

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

classDiagram
    class IOuterRecord
    BusinessMessageEnvelopeV01 --|> IOuterRecord : Implements
    BusinessMessageEnvelopeV01Document --|> IOuterDocument~BusinessMessageEnvelopeV01~ : Implements
    class IOuterDocument~BusinessMessageEnvelopeV01~ {
        BusinessMessageEnvelopeV01 Message
     }

Document wrapper for serialization

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

classDiagram
    BusinessMessageEnvelopeV01Document *-- BusinessMessageEnvelopeV01 : Document

Sample of message format

This is an abbreviated version of what the message should look like.

<BizMsgEnvlp xmlns="urn:iso:std:iso:20022:tech:xsd:nvlp.001.001.01">
    <BizMsgEnvlp>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Doc>
            <!-- Document inner content -->
        </Doc>
        <Ref>
            <!-- Reference inner content -->
        </Ref>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </BizMsgEnvlp>
</BizMsgEnvlp>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_C7O-UQJ9Ee2MF-ort1OTzA"
  name="BusinessMessageEnvelopeV01"
  definition="The BusinessMessageEnvelope is a technical message container used to bundle a business application header with a message definition, typically to support processing or transport. It may contain and define additional data elements that apply to the message instance container."
  registrationStatus="Registered"
  xmlTag="BizMsgEnvlp"
  rootElement="BizMsgEnvlp"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_idzu8GDdEe2yZ71w6P_HbQ"
    name="SupplementaryDataAndDocumentRule"
    definition="The SupplementaryData can only be used to extend its parent elements and not other elements.&#xD;&#xA;&#xD;&#xA;Usage:  /SupplementaryData may only extends the envelope and /Reference/SupplementaryData may only extend the reference, but cannot extend  the Header nor the Document payload."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_vln_FAJ9Ee2o0-v8T2Svrw"
    name="Header"
    definition="ISO 20022 Business Application Header instance.&#xD;&#xA;Rule: The external schema must be an official ISO 20022 Business Application Header."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Hdr"
    complexType="_OTgzNDAz-AOSNFX-8224503" />
  <messageBuildingBlock
    xmi:id="_vln_FQJ9Ee2o0-v8T2Svrw"
    name="Document"
    definition="ISO 20022 Message Definition instance.&#xD;&#xA;Rule: The external schema must be an official ISO 20022 Message Definition."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Doc"
    complexType="_OTgzNDAz-AOSNFX-8224503" />
  <messageBuildingBlock
    xmi:id="_vln_FgJ9Ee2o0-v8T2Svrw"
    name="Reference"
    definition="Reference related to the delivery of the business message whilst in transit from sending to receiving business application."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="Ref"
    complexType="_QhajIK9aEeyk7opzt6Qlaw" />
  <messageBuildingBlock
    xmi:id="_vln_FwJ9Ee2o0-v8T2Svrw"
    name="SupplementaryData"
    definition="Additional information that cannot be captured in the structured fields and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="nvlp"
    messageFunctionality="001"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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