camt.035.001.05
Scope The ProprietaryFormatInvestigation 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. The ProprietaryData element must contain a well formed XML document. This means XML special characters such as ‘<’ must be used in a way that is consistent with XML well-formedness criteria.
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
%% ProprietaryFormatInvestigationV05 recursion level 0 with max 0
ProprietaryFormatInvestigationV05 *-- "1..1" CaseAssignment5 : Assignment
ProprietaryFormatInvestigationV05 *-- "0..1" Case5 : Case
ProprietaryFormatInvestigationV05 *-- "1..1" ProprietaryData7 : ProprietaryData
ProprietaryFormatInvestigationV05 *-- "0..1" SupplementaryData1 : SupplementaryData
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: The assigner must be the sender of this confirmation and the assignee must be the receiver. Represents the assignment of a case to a party. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CaseAssignment5 recursion level 0 with max 1
class CaseAssignment5{
Identification IsoMax35Text
CreationDateTime IsoISODateTime
}
CaseAssignment5 *-- "1..1" IParty40Choice : Assigner
CaseAssignment5 *-- "1..1" IParty40Choice : Assignee
%% IParty40Choice recursion level 1 with max 1
%% IParty40Choice recursion level 1 with max 1
CaseAssignment5 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. Provides further details to identify an investigation case. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Case5 recursion level 0 with max 1
class Case5{
Identification IsoMax35Text
ReopenCaseIndication IsoYesNoIndicator
}
Case5 *-- "1..1" IParty40Choice : Creator
%% IParty40Choice recursion level 1 with max 1
Case5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Identification | Uniquely identifies the case. | IsoMax35Text - Required 1..1 |
| Creator | Party that created the investigation case. | IParty40Choice - 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
%% ProprietaryData7 recursion level 0 with max 1
class ProprietaryData7{
Type IsoMax35Text
}
ProprietaryData7 *-- "1..1" ProprietaryData6 : Data
%% ProprietaryData6 recursion level 1 with max 1
ProprietaryData6 *-- "1..1" IsoSkipPayload : Any
ProprietaryData7 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Type | Specifies the type of proprietary document. | IsoMax35Text - Required 1..1 |
| Data | Proprietary data content. | ProprietaryData6 - Required 1..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 ProprietaryFormatInvestigationV05 implementation follows a specific implementaiton pattern. First of all, ProprietaryFormatInvestigationV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ProprietaryFormatInvestigationV05Document implements IOuterDocument. Because ProprietaryFormatInvestigationV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ProprietaryFormatInvestigationV05.
classDiagram
class IOuterRecord
ProprietaryFormatInvestigationV05 --|> IOuterRecord : Implements
ProprietaryFormatInvestigationV05Document --|> IOuterDocument~ProprietaryFormatInvestigationV05~ : Implements
class IOuterDocument~ProprietaryFormatInvestigationV05~ {
ProprietaryFormatInvestigationV05 Message
}
Document wrapper for serialization
The only real purpose ProprietaryFormatInvestigationV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.035.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ProprietaryFormatInvestigationV05.ToDocument() method. The returned ProprietaryFormatInvestigationV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ProprietaryFormatInvestigationV05Document *-- ProprietaryFormatInvestigationV05 : 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.05">
<PrtryFrmtInvstgtn>
<Assgnmt>
<!-- Assignment inner content -->
</Assgnmt>
<Case>
<!-- Case inner content -->
</Case>
<PrtryData>
<!-- ProprietaryData inner content -->
</PrtryData>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</PrtryFrmtInvstgtn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_eYI_FW2PEei3KuUgpx7Xcw"
previousVersion="_AOwWE11tEeehlLdFiIrRgQ"
name="ProprietaryFormatInvestigationV05"
definition="Scope
The ProprietaryFormatInvestigation 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.
The ProprietaryData element must contain a well formed XML document. This means XML special characters such as '<' must be used in a way that is consistent with XML well-formedness criteria."
registrationStatus="Registered"
messageSet="_moz48_2VEeGjgKzdN0DbWA"
xmlTag="PrtryFrmtInvstgtn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_eYI_F22PEei3KuUgpx7Xcw"
previousVersion="_AOwWFV1tEeehlLdFiIrRgQ"
name="Assignment"
definition="Identifies the assignment of an investigation case from an assigner to an assignee.
Usage: 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="_BzPdIW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_eYI_GW2PEei3KuUgpx7Xcw"
previousVersion="_AOwWF11tEeehlLdFiIrRgQ"
name="Case"
definition="Identifies the investigation case."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="Case"
complexType="_8BF4W248EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_eYI_G22PEei3KuUgpx7Xcw"
previousVersion="_AOwWGV1tEeehlLdFiIrRgQ"
name="ProprietaryData"
definition="Proprietary information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="PrtryData"
complexType="_1UAkgYKYEee7hrXqLO3yQg" />
<messageBuildingBlock
xmi:id="_eYI_HW2PEei3KuUgpx7Xcw"
previousVersion="_AOwWG11tEeehlLdFiIrRgQ"
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="035"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.