Lionel Smith-Gordon Refactor ETD qualification (P3+) - Release (#3200)

* Refactor ETD qualification (P3+) Refactor product qualification for ETDs (ART P3+) * correct typo correct typo * typo typo * release note * update expectations * update expectations * update expectations * update expectations * update expectations * update expectations * update tests and expectations * Reinstated ETD enum and added mappings To address ETD product qualification exceptions * update expectations * update RN * Fix instrumentType mappings for loans and listed derivatives * Update expectations * Reduce logging * update expectations --------- Co-authored-by: Lionel Smith-Gordon <lionel@oblongs.uk> Co-authored-by: Lionel SG <146734978+Oblongs@users.noreply.github.com> Co-authored-by: PayalKhanna <payal.khanna@regnosys.com> Co-authored-by: hugohills-regnosys <hugo.hills@regnosys.com>
finos · Nov 1, 2024 · cd9644e · cd9644e
1 parent 691504f
commit cd9644e
Show file tree

Hide file tree

Showing 333 changed files with 1,315 additions and 1,601 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -25,4 +25,30 @@ _Backward-incompatible changes_
 
 This release contains changes that are not backward-compatible:
 - All references to a payout need to be updated as references to a payout are now treated as capitalised Data Types rather than lower case Attributes.  For example, a previous reference might have read:  `payout -> interestRatePayout -> floatingAmount` must now be written as:  `payout -> InterestRatePayout -> floatingAmount`.
-- Logic or mapping that expects certain cardinality may need to be reviewed; see the explanation above.
+- Logic or mapping that expects certain cardinality may need to be reviewed; see the explanation above.
+
+# *CDM Product Model* - Refactor ETD Product Qualification
+
+_Background_
+
+In an earlier Asset Refactoring release, the modelling of Exchange Traded Derivatives was enhanced
+by introducing a new item `ListedDerivative` as an option of one of the values in the `Asset` choice
+data type.  However, the product qualification functions were still expecting these products to be
+modelled using the `Security` choice within `Asset`.  This has been corrected.
+The enumerator type `SecurityTypeEnum` has been renamed to `InstrumentTypeEnum` and the value of
+`ListedDerivative` has been removed from the list.  This broadens the potential use of this
+enumeration for additional assets.
+
+The attribute `instrumentType`, using the `InstrumentTypeEnum` data type, has been added to `InstrumentBase`
+so that this basic type determination is on all types of instrument.  The corresponding attribute,
+`securityType` has been removed from `Security` to avoid duplication.
+
+The attribute `securityType` on the data type `AssetType` has been changed to use the renamed data
+type, ie `InstrumentTypeEnum`.
+
+Occurrences of logic to test the type of a security or instrument
+have also been updated to use this new name `InstrumentTypeEnum`, including a number of references
+to this enumerator in the product qualification logic.  Where product qualification was only
+looking for the type of a `security`, it has also been broadened to `instrument`.
+
+Changes can be reviewed in PR [#3200](https://github.com/finos/common-domain-model/pull/3200)
diff --git a/docs/product-model.md b/docs/product-model.md
@@ -1105,23 +1105,22 @@ ISDA definitions for reference benchmarks. Security has a
 set of additional attributes, as shown below:
 
 ``` Haskell
-type Security extends InstrumentBase:
-  securityType SecurityTypeEnum (1..1)
-  debtType DebtType (0..1)
-  equityType EquityTypeEnum (0..1)
-  fundType FundProductTypeEnum (0..1)
-
-  condition DebtSubType:
-    if securityType <> SecurityTypeEnum -> Debt
-    then debtType is absent
-
-  condition EquitySubType:
-    if securityType <> SecurityTypeEnum -> Equity
-    then equityType is absent
-
-  condition FundSubType:
-    if securityType <> SecurityTypeEnum -> Fund
-    then fundType is absent
+type Security extends InstrumentBase: 
+    debtType DebtType (0..1)
+    equityType EquityTypeEnum (0..1) 
+    fundType FundProductTypeEnum (0..1)
+
+    condition DebtSubType:
+        if instrumentType <> InstrumentTypeEnum -> Debt
+        then debtType is absent
+
+    condition EquitySubType:
+        if instrumentType <> InstrumentTypeEnum -> Equity
+        then equityType is absent
+
+    condition FundSubType:
+        if instrumentType <> InstrumentTypeEnum -> Fund
+        then fundType is absent
 ```
 
 The product identifier will uniquely identify the security. The

diff --git a/...finos/cdm/example/functions/CreateEligibleCollateralSpecificationFromInstructionTest.java b/...finos/cdm/example/functions/CreateEligibleCollateralSpecificationFromInstructionTest.java
@@ -58,7 +58,7 @@ private static EligibleCollateralCriteria getCommonCriteria() {
                 .addAsset(AssetCriteria.builder()
                         .addCollateralAssetType(AssetType.builder()
                                 .setAssetType(AssetTypeEnum.SECURITY)
-                                .setSecurityType(SecurityTypeEnum.DEBT)))
+                                .setSecurityType(InstrumentTypeEnum.DEBT)))
                 .addIssuer(IssuerCriteria.builder()
                         .addIssuerType(CollateralIssuerType.builder()
                                 .setIssuerType(IssuerTypeEnum.SOVEREIGN_CENTRAL_BANK))

diff --git a/rosetta-source/src/main/java/cdm/event/workflow/processor/FISMapperMappingProcessor.java b/rosetta-source/src/main/java/cdm/event/workflow/processor/FISMapperMappingProcessor.java
@@ -8,8 +8,8 @@
 import cdm.base.math.UnitType;
 import cdm.base.staticdata.asset.common.AssetIdTypeEnum;
 import cdm.base.staticdata.asset.common.AssetIdentifier;
+import cdm.base.staticdata.asset.common.InstrumentTypeEnum;
 import cdm.base.staticdata.asset.common.Security;
-import cdm.base.staticdata.asset.common.SecurityTypeEnum;
 import cdm.base.staticdata.party.CounterpartyRoleEnum;
 import cdm.base.staticdata.party.PartyIdentifier;
 import cdm.event.common.ExecutionTypeEnum;
@@ -94,7 +94,7 @@ private void staticMappings(PathValue<TradeStateBuilder> tradeState) {
         getIRP(tradeState).getValue().getOrCreatePaymentDates().getOrCreatePaymentFrequency().setPeriodMultiplier(1);
 
         //sec lending payout
-        getSecPO(tradeState).getValue().getOrCreateUnderlier().getOrCreateInstrument().getOrCreateSecurity().setSecurityType(SecurityTypeEnum.EQUITY);
+        getSecPO(tradeState).getValue().getOrCreateUnderlier().getOrCreateInstrument().getOrCreateSecurity().setInstrumentType(InstrumentTypeEnum.EQUITY);
 
         getSecPO(tradeState).getValue().getOrCreatePayerReceiver().setPayer(CounterpartyRoleEnum.PARTY_1);
         getSecPO(tradeState).getValue().getOrCreatePayerReceiver().setReceiver(CounterpartyRoleEnum.PARTY_2);
@@ -338,7 +338,7 @@ private Multimap<String, MappingConsumer<TradeStateBuilder>> buildCommonMappings
             // key
             PathValue<PriceQuantityBuilder> pq = getPriceQuantityForSecurityFinancePayout(tradeState);
             Security security = Security.builder()
-                    .setSecurityType(SecurityTypeEnum.EQUITY)
+                    .setInstrumentType(InstrumentTypeEnum.EQUITY)
                     .addIdentifier(AssetIdentifier.builder()
                             .setIdentifierValue(value)
                             .setIdentifierType(AssetIdTypeEnum.SEDOL));

diff --git a/.../business-event/contract-formation/contract-formation-credit-default-swap-func-input.json b/.../business-event/contract-formation/contract-formation-credit-default-swap-func-input.json
@@ -160,7 +160,7 @@
                             },
                             "identifierType" : "ISIN"
                           } ],
-                          "securityType" : "Debt"
+                          "instrumentType" : "Debt"
                         },
                         "primaryObligorReference" : {
                           "globalReference" : "e414546d",

diff --git a/...business-event/contract-formation/contract-formation-credit-default-swap-func-output.json b/...business-event/contract-formation/contract-formation-credit-default-swap-func-output.json
@@ -162,7 +162,7 @@
                             },
                             "identifierType" : "ISIN"
                           } ],
-                          "securityType" : "Debt"
+                          "instrumentType" : "Debt"
                         },
                         "primaryObligorReference" : {
                           "globalReference" : "e414546d",
@@ -704,7 +704,7 @@
                         },
                         "identifierType" : "ISIN"
                       } ],
-                      "securityType" : "Debt"
+                      "instrumentType" : "Debt"
                     },
                     "primaryObligorReference" : {
                       "globalReference" : "e414546d",

diff --git a/...le-files/functions/business-event/execution/execution-credit-default-swap-func-input.json b/...le-files/functions/business-event/execution/execution-credit-default-swap-func-input.json
@@ -159,7 +159,7 @@
                           },
                           "identifierType" : "ISIN"
                         } ],
-                        "securityType" : "Debt"
+                        "instrumentType" : "Debt"
                       },
                       "primaryObligorReference" : {
                         "globalReference" : "e414546d",

diff --git a/...e-files/functions/business-event/execution/execution-credit-default-swap-func-output.json b/...e-files/functions/business-event/execution/execution-credit-default-swap-func-output.json
@@ -160,7 +160,7 @@
                           },
                           "identifierType" : "ISIN"
                         } ],
-                        "securityType" : "Debt"
+                        "instrumentType" : "Debt"
                       },
                       "primaryObligorReference" : {
                         "globalReference" : "e414546d",
@@ -634,7 +634,7 @@
                         },
                         "identifierType" : "ISIN"
                       } ],
-                      "securityType" : "Debt"
+                      "instrumentType" : "Debt"
                     },
                     "primaryObligorReference" : {
                       "globalReference" : "e414546d",

diff --git a/...les/functions/business-event/quantity-change/full-termination-equity-swap-func-input.json b/...les/functions/business-event/quantity-change/full-termination-equity-swap-func-input.json
@@ -510,7 +510,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }

diff --git a/...es/functions/business-event/quantity-change/full-termination-equity-swap-func-output.json b/...es/functions/business-event/quantity-change/full-termination-equity-swap-func-output.json
@@ -526,7 +526,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }
@@ -1231,7 +1231,7 @@
                         "globalKey" : "247344"
                       }
                     },
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }

diff --git a/...ns/business-event/quantity-change/increase-equity-swap-existing-trade-lot-func-input.json b/...ns/business-event/quantity-change/increase-equity-swap-existing-trade-lot-func-input.json
@@ -574,7 +574,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }
@@ -750,7 +750,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }

diff --git a/...s/business-event/quantity-change/increase-equity-swap-existing-trade-lot-func-output.json b/...s/business-event/quantity-change/increase-equity-swap-existing-trade-lot-func-output.json
@@ -576,7 +576,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }
@@ -752,7 +752,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }
@@ -1466,7 +1466,7 @@
                         "globalKey" : "247344"
                       }
                     },
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }
@@ -1642,7 +1642,7 @@
                         "globalKey" : "247344"
                       }
                     },
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }

diff --git a/...ample-files/functions/business-event/quantity-change/increase-equity-swap-func-input.json b/...ample-files/functions/business-event/quantity-change/increase-equity-swap-func-input.json
@@ -51,7 +51,7 @@
                       },
                       "identifierType" : "Other"
                     } ],
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }
@@ -657,7 +657,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }

diff --git a/...mple-files/functions/business-event/quantity-change/increase-equity-swap-func-output.json b/...mple-files/functions/business-event/quantity-change/increase-equity-swap-func-output.json
@@ -52,7 +52,7 @@
                       },
                       "identifierType" : "Other"
                     } ],
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }
@@ -654,7 +654,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }
@@ -1369,7 +1369,7 @@
                         "globalKey" : "247344"
                       }
                     },
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }
@@ -1513,7 +1513,7 @@
                       },
                       "identifierType" : "Other"
                     } ],
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }

diff --git a/.../functions/business-event/quantity-change/partial-termination-equity-swap-func-input.json b/.../functions/business-event/quantity-change/partial-termination-equity-swap-func-input.json
@@ -533,7 +533,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }
@@ -709,7 +709,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }

diff --git a/...functions/business-event/quantity-change/partial-termination-equity-swap-func-output.json b/...functions/business-event/quantity-change/partial-termination-equity-swap-func-output.json
@@ -546,7 +546,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }
@@ -722,7 +722,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }
@@ -1436,7 +1436,7 @@
                         "globalKey" : "247344"
                       }
                     },
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }
@@ -1612,7 +1612,7 @@
                         "globalKey" : "247344"
                       }
                     },
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }

diff --git a/...sample-files/functions/business-event/stock-split/stock-split-equity-swap-func-input.json b/...sample-files/functions/business-event/stock-split/stock-split-equity-swap-func-input.json
@@ -460,7 +460,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }

diff --git a/...ample-files/functions/business-event/stock-split/stock-split-equity-swap-func-output.json b/...ample-files/functions/business-event/stock-split/stock-split-equity-swap-func-output.json
@@ -468,7 +468,7 @@
                             "globalKey" : "247344"
                           }
                         },
-                        "securityType" : "Equity"
+                        "instrumentType" : "Equity"
                       }
                     }
                   }
@@ -1173,7 +1173,7 @@
                         "globalKey" : "247344"
                       }
                     },
-                    "securityType" : "Equity"
+                    "instrumentType" : "Equity"
                   }
                 }
               }