Expand import validation in MCC (#157)

* Expand import validation in MCC

Author: bbimber

mcc/resources/web/mcc/exampleData/MCC_Data_Template.xlsx

@@ -33,7 +33,8 @@ Ext4.define('MCC.panel.MccImportPanel', {
         allowRowSpan: false,
         alwaysShow: true,
         transform: 'animalId',
-        allowBlank: false
+        allowBlank: false,
+        expectInImport: true
     },{
         name: 'alternateIds',
         labels: ['Alternate Ids', 'previous Ids'],
@@ -46,7 +47,8 @@ Ext4.define('MCC.panel.MccImportPanel', {
         labels: ['Source Colony', 'Source'],
         allowRowSpan: false,
         allowBlank: true,
-        alwaysShow: true
+        alwaysShow: true,
+        expectInImport: true
     },{
         name: 'shippingDestination',
         labels: ['Shipping Destination'],
@@ -65,13 +67,15 @@ Ext4.define('MCC.panel.MccImportPanel', {
         labels: ['Birth', 'DOB', 'DOB (mm/dd/yyyy)'],
         allowRowSpan: false,
         allowBlank: true,
-        transform: 'genericDate'
+        transform: 'genericDate',
+        expectInImport: true
     },{
         name: 'gender',
         labels: ['Sex'],
         allowRowSpan: false,
         allowBlank: true,
-        transform: 'sex'
+        transform: 'sex',
+        expectInImport: true
     },{
         name: 'status',
         labels: ['Status'],
@@ -84,26 +88,32 @@ Ext4.define('MCC.panel.MccImportPanel', {
         labels: ['Dam', 'maternal ID'],
         allowRowSpan: false,
         allowBlank: true,
-        transform: 'damOrSire'
+        alwaysShow: true,
+        transform: 'damOrSire',
+        expectInImport: true
     },{
         name: 'sire',
         labels: ['Sire', 'paternal ID'],
         allowRowSpan: false,
         allowBlank: true,
-        transform: 'damOrSire'
+        alwaysShow: true,
+        transform: 'damOrSire',
+        expectInImport: true
     },{
         name: 'weight',
         labels: ['Weight (g)', 'Weight (grams)', 'current weight (g)', 'current weight (grams)'],
         allowRowSpan: false,
         allowBlank: true,
-        transform: 'weight'
+        transform: 'weight',
+        expectInImport: true
     },{
         name: 'weightDate',
         labels: ['Date of Weight', 'date of weight', 'date of weight (mm/dd/yyyy)'],
         alwaysShow: true,
         allowRowSpan: false,
         transform: 'genericDate',
-        allowBlank: true
+        allowBlank: true,
+        expectInImport: true
     },{
         name: 'date',
         labels: ['Observation Date', 'date'],
@@ -117,13 +127,15 @@ Ext4.define('MCC.panel.MccImportPanel', {
         alwaysShow: false,
         allowRowSpan: false,
         allowBlank: false,
-        transform: 'u24'
+        transform: 'u24',
+        expectInImport: true
     },{
         name: 'availability',
         labels: ['Available to Transfer', 'available to transfer'],
         allowRowSpan: false,
         allowBlank: true,
-        transform: 'available'
+        transform: 'available',
+        expectInImport: true
     },{
         name: 'breedingPartnerId',
         labels: ['Breeding Partner Id'],
@@ -134,25 +146,29 @@ Ext4.define('MCC.panel.MccImportPanel', {
         labels: ['Current Housing Status'],
         allowRowSpan: false,
         allowBlank: true,
-        transform: 'housingStatus'
+        transform: 'housingStatus',
+        expectInImport: true
     },{
         name: 'infantHistory',
         labels: ['Infant History'],
         allowRowSpan: false,
         alwaysShow: true,
-        transform: 'infantHistory'
+        transform: 'infantHistory',
+        expectInImport: true
     },{
         name: 'fertilityStatus',
         labels: ['Fertility Status'],
         allowRowSpan: false,
         alwaysShow: true,
-        transform: 'fertilityStatus'
+        transform: 'fertilityStatus',
+        expectInImport: true
     },{
         name: 'medicalHistory',
         labels: ['Medical History'],
         allowRowSpan: false,
         allowBlank: true,
-        transform: 'medicalHistory'
+        transform: 'medicalHistory',
+        expectInImport: true
     },{
         name: 'currentUsage',
         labels: ['Usage (Current)', 'usage (current)'],
@@ -437,6 +453,16 @@ Ext4.define('MCC.panel.MccImportPanel', {
 
         var rows = LDK.Utils.CSVToArray(text, '\t');
         var colArray = this.parseHeader(rows.shift());
+        var foundColsNames = colArray.map(x => x.name)
+        var missingExpectedCols = this.COLUMNS.filter(x => x.expectInImport).map(x => x.name).filter(x => foundColsNames.indexOf(x) === -1)
+        if (missingExpectedCols.length) {
+            // now convert from name to label:
+            var colNameToLabel = {}
+            this.COLUMNS.forEach(x => colNameToLabel[x.name] = x.labels[0])
+            Ext4.Msg.alert('Error', 'The following columns were expected but not found:<br>' + missingExpectedCols.map(x => colNameToLabel[x]).join('<br>'))
+            return null;
+        }
+
         var errorsMsgs = [];
         var parsedRows = this.parseRows(colArray, rows, errorsMsgs);
 

mcc/resources/web/mcc/panel/MccImportPanel.js

@@ -68,7 +68,7 @@ public void testMccModule() throws Exception
         testAnimalImportAndTransfer();
     }
 
-    private static final String ANIMAL_DATA_HEADER = "animal ID\tprevious IDs\tsource\t\"DOB\n(MM/DD/YYYY)\"\tsex\tmaternal ID\tpaternal ID\t\"weight(grams)\"\t\"date of weight\n(MM/DD/YY)\"\tU24 status\tavailable to transfer\tcurrent housing status\tinfant history\tfertility status\tmedical history\n";
+    private static final String ANIMAL_DATA_HEADER = "animal ID\tprevious IDs\tsource\t\"DOB\n(MM/DD/YYYY)\"\tsex\tmaternal ID\tpaternal ID\t\"weight (grams)\"\t\"date of weight\n(MM/DD/YY)\"\tU24 status\tavailable to transfer\tcurrent housing status\tinfant history\tfertility status\tmedical history\n";
 
     private static final String ANIMAL_DATA1 = "12345\t\t\t7/10/2011\t0 - male\t23456\t23453\t382.8\t5/19/2021\t0 - not assigned to U24 breeding colony\t0 - not available for transfer\t1 - natal family unit\t3 - successful rearing of offspring\t2 - successful offspring produced\t0 - naive animal\n";