ProprietaryFormatInvestigationV02

camt.035.001.02

Scope The Proprietary Format Investigation message type is used by financial institutions, with their own offices, and/or with other financial institutions with which they have established bilateral agreements. Usage The user should ensure that an existing standard message cannot be used before using the proprietary message. As defined in the scope, this ProprietaryFormatInvestigation message may only be used when bilaterally agreed. It is used as an envelope for a non standard message and provides means to manage an exception or investigation which falls outside the scope or capability of any other formatted message.

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
%% ProprietaryFormatInvestigationV02 recursion level 0 with max 0
ProprietaryFormatInvestigationV02 *-- "1..1" CaseAssignment2 : Assignment
ProprietaryFormatInvestigationV02 *-- "1..1" Case2 : Case
ProprietaryFormatInvestigationV02 *-- "1..1" ProprietaryData4 : ProprietaryData
  

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

Assignment building block

Identifies the assignment of an investigation case from an assigner to an assignee. Usage Rule: the Assigner must be the sender of this confirmation and the Assignee must be the receiver. Set of elements used to represent the assignment of a case to a party. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CaseAssignment2 recursion level 0 with max 1
class CaseAssignment2{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
CaseAssignment2 *-- "1..1" IParty7Choice : Assigner
CaseAssignment2 *-- "1..1" IParty7Choice : Assignee
%% IParty7Choice recursion level 1 with max 1
%% IParty7Choice recursion level 1 with max 1
  

CaseAssignment2 members

Member name Description Data Type / Multiplicity
Identification Uniquely identifies the case assignment. IsoMax35Text - Required 1..1
Assigner Party who assigns the case. Usage: This is also the sender of the message.
Assignee Party to which the case is assigned. Usage: This is also the receiver of the message.
CreationDateTime Date and time at which the assignment was created. IsoISODateTime - Required 1..1

Case building block

Identifies the investigation case. Set of elements used to identify a case. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Case2 recursion level 0 with max 1
class Case2{
    Identification IsoMax35Text
    ReopenCaseIndication IsoYesNoIndicator
}
Case2 *-- "1..1" IParty7Choice : Creator
%% IParty7Choice recursion level 1 with max 1
  

Case2 members

Member name Description Data Type / Multiplicity
Identification Uniquely identifies the case. IsoMax35Text - Required 1..1
Creator Party that created the investigation case. IParty7Choice - Required 1..1
ReopenCaseIndication Indicates whether or not the case was previously closed and is now re-opened. IsoYesNoIndicator - Optional 0..1

ProprietaryData building block

Proprietary information. Container for proprietary information. Business content of this element is not specified. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ProprietaryData4 recursion level 0 with max 1
class ProprietaryData4{
    Type IsoMax35Text
}
ProprietaryData4 *-- "1..1" ProprietaryData3 : Data
%% ProprietaryData3 recursion level 1 with max 1
ProprietaryData3 *-- "1..1" SkipProcessing : Any
  

ProprietaryData4 members

Member name Description Data Type / Multiplicity
Type Specifies the type of proprietary document. IsoMax35Text - Required 1..1
Data Proprietary data content. ProprietaryData3 - Required 1..1

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the ProprietaryFormatInvestigationV02 implementation follows a specific implementaiton pattern. First of all, ProprietaryFormatInvestigationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ProprietaryFormatInvestigationV02Document implements IOuterDocument. Because ProprietaryFormatInvestigationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ProprietaryFormatInvestigationV02.

classDiagram
    class IOuterRecord
    ProprietaryFormatInvestigationV02 --|> IOuterRecord : Implements
    ProprietaryFormatInvestigationV02Document --|> IOuterDocument~ProprietaryFormatInvestigationV02~ : Implements
    class IOuterDocument~ProprietaryFormatInvestigationV02~ {
        ProprietaryFormatInvestigationV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ProprietaryFormatInvestigationV02Document *-- ProprietaryFormatInvestigationV02 : 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.035.001.02">
    <PrtryFrmtInvstgtn>
        <Assgnmt>
            <!-- Assignment inner content -->
        </Assgnmt>
        <Case>
            <!-- Case inner content -->
        </Case>
        <PrtryData>
            <!-- ProprietaryData inner content -->
        </PrtryData>
    </PrtryFrmtInvstgtn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_OT9RiNE_Ed-BzquC8wXy7w_-1238871994"
  nextVersions="_sW_aQlkyEeGeoaLUQk__nA_781357375"
  name="ProprietaryFormatInvestigationV02"
  definition="Scope&#xD;&#xA;The Proprietary Format Investigation message type is used by financial institutions, with their own offices, and/or with other financial institutions with which they have established bilateral agreements.&#xD;&#xA;Usage&#xD;&#xA;The user should ensure that an existing standard message cannot be used before using the proprietary message.&#xD;&#xA;As defined in the scope, this ProprietaryFormatInvestigation message may only be used when bilaterally agreed.&#xD;&#xA;It is used as an envelope for a non standard message and provides means to manage an exception or investigation which falls outside the scope or capability of any other formatted message."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="PrtryFrmtInvstgtn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_OT9RidE_Ed-BzquC8wXy7w_2139879859"
    name="Assignment"
    definition="Identifies the assignment of an investigation case from an assigner to an assignee.&#xA;Usage Rule: the Assigner must be the sender of this confirmation and the Assignee must be the receiver."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Assgnmt"
    complexType="_T9Nac9p-Ed-ak6NoX_4Aeg_-1609381277" />
  <messageBuildingBlock
    xmi:id="_OT9RitE_Ed-BzquC8wXy7w_2139880168"
    name="Case"
    definition="Identifies the investigation case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Case"
    complexType="_SpAnptp-Ed-ak6NoX_4Aeg_-1565053133" />
  <messageBuildingBlock
    xmi:id="_OT9Ri9E_Ed-BzquC8wXy7w_2139880260"
    name="ProprietaryData"
    definition="Proprietary information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="PrtryData"
    complexType="_RqIklNp-Ed-ak6NoX_4Aeg_1327453189" />
  <messageDefinitionIdentifier
    businessArea="camt"
    messageFunctionality="035"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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