#181 and Notes update

OpenExposureData/Docs/Abbreviations.csv

@@ -0,0 +1,23 @@
+"Abbreviation","Description"
+"Acc","Account"
+"Agg","Aggregate"
+"BI","Business Interruption"
+"Cond","Condition"
+"Cov","Coverage"
+"Ded","Deductible"
+"Def","Defined"
+"FX","Exchange"
+"Geog","Geography"
+"LOB","Line of Business"
+"Loc","Location"
+"Max","Maximum"
+"Min","Minimum"
+"Occ","Occurrence"
+"Org","Original"
+"PD","Property Damage"
+"POI","Period of Indemnity"
+"Pol","Policy"
+"Port","Portfolio"
+"Reins","Reinsurance"
+"TIV","Total Insurable Value"
+"Vuln","Vulnerability"

OpenExposureData/Docs/Notes.rst

@@ -6,18 +6,18 @@ Peril Values
 
 For filtering:
 
-b = fire
-o = flood
-q = quake
-x = convective storm (e.g. hail, tornado, etc.)
-z = winterstorm
-w = wind (e.g. tropical cyclone, etc.)
-m = terrorism
-s = subsidence
-g = agriculture
-p = pandemic
-v = volcanic
-s = sewage backup
+* b = fire
+* o = flood
+* q = quake
+* x = convective storm (e.g. hail, tornado, etc.)
+* z = winterstorm
+* w = wind (e.g. tropical cyclone, etc.)
+* m = terrorism
+* s = subsidence
+* g = agriculture
+* p = pandemic
+* v = volcanic
+* s = sewage backup
 
 Examples of combining peril codes:
 
@@ -34,3 +34,61 @@ Examples of combining peril codes:
 
 |
 
+Conditionally Required (CR) fields
+##################################
+
+Notes on Conditionally Required (CR) fields (to be used in conjunction with 'OEDCRFieldAppendix' table):
+
+Grouping format: most granular - CRx-xx-x-x, higher level group - CRx-xx-x, higher level group - CRx-xx, highest level groups - CRx, where x is a digit between 0 and 9.
+
+Some conditionally required fields have just the highest level hierarchy group.
+
+If there is data in the most granular level group, then all the fields in that group and its higher levels must be included in the file too.
+
+**Example 1** 
+
+|
+
+if a user wants to include Policy Blanket Deductible, PolDed6All with Conditionally Required code: CR2-06-1
+Then the following logic is used to find additional fields that need to be populated:
+
+* Require all other fields with exactly the same conditionally required field, (CR2-06-1), i.e. PolDedType6All
+* Require all fields with code CR2, i.e. PolPeril
+
+There are two fields with the last digit different (CR2-06-x), i.e. PolMinDed6All and PolMaxDed6All, that can be used with PolDed6All field, either individually or both.
+
+|
+
+**Example 2** 
+
+If a user wants to include Minimum Policy Blanket Deductible, PolminDed6All with Conditionally Required code: CR2-06-2
+Then the following logic is used to find additional fields that need to be populated:
+
+* As there are no other fields with the same level, then only the next hierarchical levels should be considered.
+* Require all other fields with code CR2-06, i.e. PolDedCodeAll
+* Require all fields with code CR2, i.e. PolPeril
+
+|
+
+**Example 3** 
+
+To define reinsurance scope, at least one field in CR6-xx group must be present. If a user wants to filter by Location Number (LocNumber) with Conditionally Required field: CR6-01-1-3
+
+Then the following logic is used to find additional fields that need to be populated:
+
+*Require all other fields with code CR6-01-1, i.e. AccNumber
+*Require all fields with code CR6-01, i.e. PortNumber
+
+Any additional fields within CR6-xx-x-x group can also be added (or in the higher levels), as required.
+
+|
+
+Motor classification
+####################
+
+References for motor classification:
+
+.. _HAZUS: https://www.hsdl.org/?view&did=480580
+
+.. _GEC: https://www.mvn.usace.army.mil/Portals/56/docs/PD/Donaldsv-Gulf.pdf
+