Exception handling added around incorrectly formatted template collection files.

Author: RoelantVos

Virtual_EDW/Form_Main.cs

@@ -165,7 +165,7 @@ public FormMain()
         private void RefreshTemplateGrid()
         {
             // Load the template collection into memory.
-            VdwConfigurationSettings.templateList = TemplateHandling.LoadTemplateCollection();
+            VdwConfigurationSettings.templateList = TemplateHandling.LoadTemplateCollection(VdwConfigurationSettings.VdwEventLog);
 
             if ((VdwConfigurationSettings.templateList != null) && (!VdwConfigurationSettings.templateList.Any()))
             {
@@ -1136,7 +1136,7 @@ private void PictureBoxUpdateTemplatePath_Click(object sender, EventArgs e)
 
                 // Reload the files into the grid
                 VdwConfigurationSettings.templateList.Clear();
-                VdwConfigurationSettings.templateList = TemplateHandling.LoadTemplateCollection();
+                VdwConfigurationSettings.templateList = TemplateHandling.LoadTemplateCollection(VdwConfigurationSettings.VdwEventLog);
                 PopulateTemplateCollectionDataGrid();
             }
         }

Virtual_EDW/TemplateHandling.cs

@@ -1,7 +1,11 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using Microsoft.SqlServer.Management.Smo;
 using Newtonsoft.Json;
+using TEAM_Library;
+using static System.Net.Mime.MediaTypeNames;
+using static System.Runtime.InteropServices.JavaScript.JSType;
 
 namespace Virtual_Data_Warehouse
 {
@@ -77,17 +81,24 @@ internal static string SaveTemplateCollection(string templateFilePath, string fi
             return returnMessage;
         }
 
-        internal static List<TemplateHandling> LoadTemplateCollection()
+        internal static List<TemplateHandling> LoadTemplateCollection(EventLog eventLog)
         {
             List<TemplateHandling> templateList = new List<TemplateHandling>();
 
-            // Retrieve the file contents and store in a string.
-            if (File.Exists(FormBase.VdwConfigurationSettings.TemplatePath + FormBase.GlobalParameters.TemplateCollectionFileName))
+            try
             {
-                var jsonInput = File.ReadAllText(FormBase.VdwConfigurationSettings.TemplatePath + FormBase.GlobalParameters.TemplateCollectionFileName);
+                // Retrieve the file contents and store in a string.
+                if (File.Exists(FormBase.VdwConfigurationSettings.TemplatePath + FormBase.GlobalParameters.TemplateCollectionFileName))
+                {
+                    var jsonInput = File.ReadAllText(FormBase.VdwConfigurationSettings.TemplatePath + FormBase.GlobalParameters.TemplateCollectionFileName);
 
-                //Move the (json) string into a List object (a list of the type Template).
-                templateList = JsonConvert.DeserializeObject<List<TemplateHandling>>(jsonInput);
+                    //Move the (json) string into a List object (a list of the type Template).
+                    templateList = JsonConvert.DeserializeObject<List<TemplateHandling>>(jsonInput);
+                }
+            }
+            catch (Exception exception)
+            {
+                eventLog.Add(Event.CreateNewEvent(EventTypes.Error, $"An error was encountered loading the template collection from '{FormBase.VdwConfigurationSettings.TemplatePath + FormBase.GlobalParameters.TemplateCollectionFileName}. The error encountered was '{exception.Message}'."));
             }
 
             // Return the list to the instance

Virtual_EDW/Templates/templateCollection.json

@@ -46,7 +46,7 @@
     "TemplateOutputFileConvention": "{targetDataObject.name}.sql",
     "TemplateFilePath": "templateSatelliteViewWithDeliveryKey.handlebars",
     "TemplateNotes": "Regular Satellite pattern extended with delivery key concept."
-  }.  
+  }, 
   {
     "TemplateName": "100 Dimension / PIT Select Template",
     "TemplateType": "Presentation",