task-5704: update expectations, documentation and add release notes

RELEASE.md

@@ -1,12 +1,39 @@
-# *CDM Distribution - Code Generation - CDM in Excel format*
+# _Product Model - Refactoring of Extraordinary Events and Substitution Provisions_
+
+It was agreed with the CDM ARC in early 2023 that the description and determination of extraordinary events and substitution provisions do not pertain to economic terms of a financial products but should rather be positioned within the legal agreement that conditions the performance of the transaction. Accordingly the following changes have been addressed to enrich the representation of legal `Agreement` with additional terms at transaction level `TransactionAdditionalTerms`. This new data type will encompass the data effectively used to draft OTC Trade Long Form Confirmations. For each asset class the data set will describe:
+1.	`ExtraordinaryEvents`, as previously an attribute of `EconomicTerms`,
+2.	`DeterminationRolesAndTerms`, representing the roles of the parties determining the occurrence of the extraordinary events
+3.	UnderlierSubstitutionProvision, describing the terms of a substitution of the underlier(s)
+
+The `EquityAdditionalTerms` was designed based on the ISDA Equity Derivatives Definitions 2002.  The `foreignExchangeAdditionalTerms` has been released mainly based on 1998 FX and Currency Option Definitions.  The  `commoditiesAdditionalTerms`, `interestRateAdditionalTerm`, `digitalAssetAdditionalTerms` have been created as placeholder strings, until related terms are digitized as well in CDM.
 
 _What is being released?_
 
-This release changes the deployed Excel code generation from a zipped folder to an .xlsx file. Instructions on the download page have been updated to be clearer for users to follow. 
+The description of Extraordinary events has been abstracted from the economic terms and the `TransactionAdditionalTerms` data type  has been added as a new attribute of `Agreement`, with the following attributes :
+1.	`equityAdditionalTerms` – attributes : extraordinaryEvents (prior existing type, removed from EconomicTerms), `determinationTerms and substitutionProvisions
+2.	`foreignExchangeAdditionalTerms` – attributes : `disruptionEvents` and `determinationTerms`
+3.	`commoditiesAdditionalTerms` – string type (“place holder” object)
+4.	`interestRateAdditionalTerms` – string type (“place holder” object)
+5.	`digitalAssetAdditionalTerms` – string type (“place holder” object)
+
+`SubstitutionProvisions` is an optional item, mainly made of a role definition by re-using again `CounterpartyRoleEnum` with label `whoToSubstitute`, and the description of the substitution provisions as such is of type string.
+
+A new generic type `Clause` has been used to introduced to document digital any additional Bespoke Terms, that cannot for now be modelled in CDM and yet critically needed to foster CDM implementation.
+This type has been used for the following new attribute
+1.	`ExtraordinaryEvents` -> `additionalBespokeTerms`
+2.	`ExtraordinaryEvents` -> `additionalDisruptionEvents` -> `additionalBespokeTerms`
+3.	`UnderlierSubstitutionProvision` -> `substitutionBespokeTerms`
+
+The description of certain existing data type has been simplified to remove the overlaps with existing ISDA documents, for example `AdditionalDisruptionEvents`
+
+The values of the Enum `ContractualDefinitionsEnum` have been aligned with the title of the documents they are referring to. The corresponding FpML synonym mapping have been adjusted.
+
+References to the Emerging Markets Traders Association and the Foreign Exchange Committee haven added to the `LegalAgreementPublisherEnum`
+
+The FpML synonym mapping for extraordinary events and sub-components have been removed temporarily and will be reintroduced in a second part
 
 _Review directions_
 
-In the CDM documentation, go to Downloads (https://cdm.finos.org/docs/download/), and download CDM as Excel.
+In the CDM Portal, select the textual view or the graphical representation and inspect the structural definitions of the data type mentioned above.
 
-- Review the .xlsx file.
-- Inspect the Pull Request: https://github.com/finos/common-domain-model/pull/2403
+PR: https://github.com/finos/common-domain-model/pull/2424

docs/legal-agreements.md

@@ -330,6 +330,7 @@ type Agreement:
   collateralTransferAgreementElections CollateralTransferAgreementElections (0..1)
   securityAgreementElections SecurityAgreementElections (0..1)
   masterAgreementSchedule MasterAgreementSchedule (0..1)
+  transactionAdditionalTerms TransactionAdditionalTerms (0..1)
   condition: one-of
 ```
 

docs/product-model.md

@@ -677,7 +677,6 @@ type EconomicTerms:
   dateAdjustments BusinessDayAdjustments (0..1)
   payout Payout (1..1)
   terminationProvision TerminationProvision (0..1)
-  extraordinaryEvents ExtraordinaryEvents (0..1)
   calculationAgent CalculationAgent (0..1)
   nonStandardisedTerms boolean (0..1)
   collateral Collateral (0..1)

examples/src/test/resources/template/trade-state-merged.json

@@ -24,7 +24,7 @@
             "contractualDefinitionsType" : [ {
               "value" : "ISDA2000"
             }, {
-              "value" : "ISDA_2002_EQUITY"
+              "value" : "ISDA_2002_EQUITY_DERIVATIVES"
             } ]
           }
         },

examples/src/test/resources/template/trade-state-unmerged.json

@@ -1,6 +1,6 @@
 {
   "meta" : {
-    "globalKey" : "bfeec7a1"
+    "globalKey" : "44ead8e"
   },
   "trade" : {
     "contractDetails" : {
@@ -24,23 +24,23 @@
             "contractualDefinitionsType" : [ {
               "value" : "ISDA2000"
             }, {
-              "value" : "ISDA_2002_EQUITY"
+              "value" : "ISDA_2002_EQUITY_DERIVATIVES"
             } ]
           }
         },
         "meta" : {
-          "globalKey" : "ed9ef3fc"
+          "globalKey" : "157c0be9"
         }
       } ],
       "governingLaw" : {
         "value" : "GBEN"
       },
       "meta" : {
-        "globalKey" : "92c7c587"
+        "globalKey" : "37be9634"
       }
     },
     "meta" : {
-      "globalKey" : "bfeec7a1"
+      "globalKey" : "44ead8e"
     },
     "party" : [ {
       "meta" : {

rosetta-source/src/main/java/cdm/observable/event/processor/DisruptionEventsDeterminingPartyMappingProcessor.java

@@ -2,7 +2,7 @@
 
 import cdm.base.staticdata.party.AncillaryRoleEnum;
 import cdm.legaldocumentation.contract.processor.PartyMappingHelper;
-import cdm.observable.event.AdditionalDisruptionEvents;
+import cdm.legaldocumentation.master.AdditionalDisruptionEvents;
 import com.regnosys.rosetta.common.translation.MappingContext;
 import com.regnosys.rosetta.common.translation.MappingProcessor;
 import com.regnosys.rosetta.common.translation.Path;