TD-5220 Implements store competency ordering option form

kevwhitt-hee · kevwhitt-hee · commit b635d1fe764e · 2025-01-03T16:25:22.000Z
diff --git a/DigitalLearningSolutions.Data/Models/Frameworks/Import/CompetencyTableRow.cs b/DigitalLearningSolutions.Data/Models/Frameworks/Import/CompetencyTableRow.cs
@@ -9,6 +9,7 @@ public enum RowStatus
         CompetencyGroupAndCompetencyInserted,
         CompetencyInserted,
         CompetencyUpdated,
+        CompetencyUpdatedAndReordered,
         CompetencyGroupInserted,
         CompetencyGroupUpdated,
         CompetencyGroupAndCompetencyUpdated,
diff --git a/DigitalLearningSolutions.Data/Models/Frameworks/Import/ImportCompetenciesResult.cs b/DigitalLearningSolutions.Data/Models/Frameworks/Import/ImportCompetenciesResult.cs
@@ -22,7 +22,8 @@ IReadOnlyCollection<CompetencyTableRow> competencyTableRows
         {
             ProcessedCount = competencyTableRows.Count;
             CompetencyAddedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.CompetencyInserted | dr.RowStatus == RowStatus.CompetencyGroupAndCompetencyInserted);
-            CompetencyUpdatedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.CompetencyUpdated);
+            CompetencyUpdatedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.CompetencyUpdated | dr.RowStatus == RowStatus.CompetencyUpdatedAndReordered);
+            CompetencyReorderedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.CompetencyUpdatedAndReordered);
             GroupAddedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.CompetencyGroupInserted | dr.RowStatus == RowStatus.CompetencyGroupAndCompetencyInserted);
             SkippedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.Skipped);
             Errors = competencyTableRows.Where(dr => dr.Error.HasValue).Select(dr => (dr.RowNumber, dr.Error!.Value));
@@ -47,6 +48,7 @@ IReadOnlyCollection<CompetencyTableRow> competencyTableRows
         public int ProcessedCount { get; set; }
         public int CompetencyAddedCount { get; set; }
         public int CompetencyUpdatedCount { get; set; }
+        public int CompetencyReorderedCount { get; set; }
         public int GroupAddedCount { get; set; }
         public int GroupUpdatedCount { get; set; }
         public int SkippedCount { get; set; }
diff --git a/DigitalLearningSolutions.Web/Controllers/FrameworksController/ImportCompetencies.cs b/DigitalLearningSolutions.Web/Controllers/FrameworksController/ImportCompetencies.cs
@@ -84,6 +84,7 @@ public IActionResult ImportCompleted()
                 data.CompetenciesToProcessCount = resultsModel.ToProcessCount;
                 data.CompetenciesToAddCount = resultsModel.CompetenciesToAddCount;
                 data.CompetenciesToUpdateCount = resultsModel.ToUpdateOrSkipCount;
+                data.CompetenciesToReorderCount = results.CompetencyReorderedCount;
                 setBulkUploadData(data);
                 return View("Developer/Import/ImportCompleted", resultsModel);
             }
@@ -93,6 +94,30 @@ public IActionResult ImportCompleted()
                 return View("Developer/Import/ImportFailed");
             }
         }
+        [Route("/Framework/{frameworkId}/{tabname}/Import/Ordering")]
+        public IActionResult ApplyCompetencyOrdering()
+        {
+            var data = GetBulkUploadData();
+            if (data.CompetenciesToReorderCount > 0)
+            {
+                var model = new ApplyCompetencyOrderingViewModel(data.FrameworkId, data.FrameworkName, data.FrameworkVocubulary, data.CompetenciesToReorderCount, data.ReorderCompetenciesOption);
+                return View("Developer/Import/ApplyCompetencyOrdering", model);
+            }
+            return RedirectToAction("AddAssessmentQuestions", "Frameworks", new { frameworkId = data.FrameworkId, tabname = data.TabName });
+        }
+        [HttpPost]
+        [Route("/Framework/{frameworkId}/{tabname}/Import/Ordering")]
+        public IActionResult ApplyCompetencyOrdering(int reorderCompetenciesOption)
+        {
+            var data = GetBulkUploadData();
+
+            if (data.ReorderCompetenciesOption != reorderCompetenciesOption)
+            {
+                data.ReorderCompetenciesOption = reorderCompetenciesOption;
+                setBulkUploadData(data);
+            }
+            return RedirectToAction("AddAssessmentQuestions", "Frameworks", new { frameworkId = data.FrameworkId, tabname = data.TabName });
+        }
         [Route("/Framework/{frameworkId}/{tabname}/Import/AssessmentQuestions")]
         public IActionResult AddAssessmentQuestions()
         {
@@ -119,6 +144,7 @@ public IActionResult AddAssessmentQuestions()
                 data.PublishStatusID,
                 data.CompetenciesToAddCount,
                 data.CompetenciesToUpdateCount,
+                data.CompetenciesToReorderCount,
                 defaultQuestions,
                 questionSelectList
                 );
diff --git a/DigitalLearningSolutions.Web/Models/BulkCompetenciesData.cs b/DigitalLearningSolutions.Web/Models/BulkCompetenciesData.cs
@@ -35,6 +35,8 @@ public BulkCompetenciesData(DetailFramework framework, int adminUserId, string c
         public int CompetenciesToProcessCount { get; set; }
         public int CompetenciesToAddCount { get; set; }
         public int CompetenciesToUpdateCount { get; set; }
+        public int CompetenciesToReorderCount { get; set; }
+        public int ReorderCompetenciesOption { get; set; } = 1; //1 = ignore order, 2 = apply order
         public int LastRowProcessed { get; set; }
         public int SubtotalCompetenciesAdded { get; set; }
         public int SubtotalCompetenciesUpdated { get; set; }
diff --git a/DigitalLearningSolutions.Web/Services/ImportCompetenciesFromFileService.cs b/DigitalLearningSolutions.Web/Services/ImportCompetenciesFromFileService.cs
@@ -34,29 +34,40 @@ public ImportCompetenciesResult PreProcessCompetenciesTable(IXLWorkbook workbook
         {
             var table = OpenCompetenciesTable(workbook, vocabulary);
             var competencyRows = table.Rows().Skip(1).Select(row => new CompetencyTableRow(table, row)).ToList();
+            var newCompetencyIds = competencyRows.Select(row => row.ID ?? 0).ToList();
             var existingCompetencies = frameworkService.GetBulkCompetenciesForFramework(frameworkId);
             var existingIds = existingCompetencies.Select(bc => (int)bc.ID).ToList();
             foreach (var competencyRow in competencyRows)
             {
-                PreProcessCompetencyRow(competencyRow, existingIds);
+                PreProcessCompetencyRow(competencyRow, newCompetencyIds, existingIds);
             }
             return new ImportCompetenciesResult(competencyRows);
         }
-        private void PreProcessCompetencyRow(CompetencyTableRow competencyRow, List<int> existingIds)
+        private void PreProcessCompetencyRow(CompetencyTableRow competencyRow, List<int> newIds, List<int> existingIds)
         {
             if (competencyRow.ID == null)
             {
                 competencyRow.RowStatus = RowStatus.CompetencyInserted;
             }
             else
             {
-                if (!existingIds.Contains((int)(competencyRow?.ID)))
+                var id = (int)(competencyRow?.ID);
+                if (!existingIds.Contains(id))
                 {
                     competencyRow.RowStatus = RowStatus.InvalidId;
                 }
                 else
                 {
-                    competencyRow.RowStatus = RowStatus.CompetencyUpdated;
+                    int originalIndex = existingIds.IndexOf(id);
+                    int newIndex = newIds.IndexOf(id);
+                    if(originalIndex == newIndex)
+                    {
+                        competencyRow.RowStatus = RowStatus.CompetencyUpdated;
+                    }
+                    else
+                    {
+                        competencyRow.RowStatus = RowStatus.CompetencyUpdatedAndReordered;
+                    }
                 }
             }
             competencyRow.Validate();
diff --git a/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/AddAssessmentQuestionsViewModel.cs b/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/AddAssessmentQuestionsViewModel.cs
@@ -12,6 +12,7 @@ public class AddAssessmentQuestionsViewModel(
         int publishStatusId,
         int newCompetencies,
         int existingCompetencies,
+        int competenciesToReorderCount,
         IEnumerable<AssessmentQuestion> defaultQuestions,
         SelectList questionSelectList
         ) : AddAssessmentQuestionsFormData
@@ -23,6 +24,7 @@ SelectList questionSelectList
         public int PublishStatusID { get; set; } = publishStatusId;
         public int NewCompetencies { get; set; } = newCompetencies;
         public int ExistingCompetencies { get; set; } = existingCompetencies;
+        public int CompetenciesToReorderCount { get; set; } = competenciesToReorderCount;
         public IEnumerable<AssessmentQuestion>? DefaultQuestions { get; set; } = defaultQuestions;
         public SelectList? QuestionSelectList { get; set; } = questionSelectList;
     }
diff --git a/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/AddQuestionsToWhichCompetenciesViewModel.cs b/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/AddQuestionsToWhichCompetenciesViewModel.cs
@@ -37,5 +37,6 @@ public AddQuestionsToWhichCompetenciesViewModel
         public int CompetenciesToProcessCount { get; set; }
         public int CompetenciesToAddCount { get; set; }
         public int CompetenciesToUpdateCount { get; set; }
+        
     }
 }
diff --git a/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/ApplyCompetencyOrderingViewModel.cs b/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/ApplyCompetencyOrderingViewModel.cs
@@ -0,0 +1,30 @@
+﻿using DigitalLearningSolutions.Web.Helpers;
+
+namespace DigitalLearningSolutions.Web.ViewModels.Frameworks.Import
+{
+    public class ApplyCompetencyOrderingViewModel
+    {
+        public ApplyCompetencyOrderingViewModel
+            (
+            int frameworkId,
+            string frameworkName,
+            string frameworkVocabulary,
+            int competenciesToReorderCount,
+            int reorderCompetenciesOption
+            )
+        {
+            FrameworkID = frameworkId;
+            FrameworkName = frameworkName;
+            FrameworkVocabularySingular = FrameworkVocabularyHelper.VocabularySingular(frameworkVocabulary);
+            FrameworkVocabularyPlural = FrameworkVocabularyHelper.VocabularyPlural(frameworkVocabulary);
+            CompetenciesToReorderCount = competenciesToReorderCount;
+            ReorderCompetenciesOption = reorderCompetenciesOption;
+        }
+        public int FrameworkID { get; set; }
+        public string FrameworkName { get; set; }
+        public string FrameworkVocabularySingular { get; set; }
+        public string FrameworkVocabularyPlural { get; set; }
+        public int ReorderCompetenciesOption { get; set; } = 1; //1 = ignore order, 2 = apply order
+        public int CompetenciesToReorderCount { get; set; }
+    }
+}
diff --git a/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/ImportCompetenciesPreProcessViewModel.cs b/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/ImportCompetenciesPreProcessViewModel.cs
@@ -17,6 +17,7 @@ public ImportCompetenciesPreProcessViewModel(ImportCompetenciesResult bulkCompet
             FrameworkVocabularyPlural = FrameworkVocabularyHelper.VocabularyPlural(bulkCompetenciesData.FrameworkVocubulary);
             ToProcessCount = bulkCompetenciesResult.ProcessedCount;
             CompetenciesToAddCount = bulkCompetenciesResult.CompetencyAddedCount;
+            CompetenciesToReorderCount = bulkCompetenciesResult.CompetencyReorderedCount;
             ToUpdateOrSkipCount = bulkCompetenciesResult.CompetencyUpdatedCount;
             Errors = bulkCompetenciesResult.Errors.Select(x => (x.RowNumber, MapReasonToErrorMessage(x.Reason, FrameworkVocabularyHelper.VocabularySingular(bulkCompetenciesData.FrameworkVocubulary))));
             FlagCount = bulkCompetenciesResult.FlagCount;
@@ -31,6 +32,7 @@ public ImportCompetenciesPreProcessViewModel(ImportCompetenciesResult bulkCompet
         public int ErrorCount => Errors.Count();
         public int ToProcessCount { get; set; }
         public int CompetenciesToAddCount { get; set; }
+        public int CompetenciesToReorderCount { get; set; }
         public int ToUpdateOrSkipCount { get; set; }
         public string? ImportFile { get; set; }
         public bool IsNotBlank { get; set; }
diff --git a/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/AddAssessmentQuestions.cshtml b/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/AddAssessmentQuestions.cshtml
@@ -96,9 +96,10 @@
                         </div>
                     </fieldset>
                 </div>
+                <a asp-controller="Frameworks" asp-action="@(Model.CompetenciesToReorderCount == 0 ? "ImportCompleted" : "ApplyCompetencyOrdering")" asp-all-route-data="@cancelLinkData" role="button" class="nhsuk-button nhsuk-button--secondary">Back</a>
                 <button class="nhsuk-button" type="submit">Next</button>
             </form>
-            <vc:back-link asp-controller="Frameworks" asp-action="Index" asp-all-route-data="@null" link-text="Cancel" />
+            <vc:cancel-link asp-controller="Frameworks" asp-action="CancelImport" asp-all-route-data="@cancelLinkData" link-text="Cancel" />
         </div>
     </div>
 </div>
diff --git a/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/AddQuestionsToWhichCompetencies.cshtml b/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/AddQuestionsToWhichCompetencies.cshtml
@@ -29,7 +29,7 @@
 <div class="nhsuk-grid-row">
     <div class="nhsuk-grid-column-full">
         <div class="nhsuk-u-reading-width">
-            <form class="nhsuk-u-margin-bottom-3" method="post" asp-action="SubmitAddWhoToGroup" enctype="multipart/form-data">
+            <form class="nhsuk-u-margin-bottom-3" method="post" enctype="multipart/form-data">
                 <fieldset class="nhsuk-fieldset">
                     <legend class="nhsuk-fieldset__legend nhsuk-fieldset__legend--l">
                         <h1 class="nhsuk-fieldset__heading">
@@ -81,7 +81,7 @@
                 <a asp-controller="Frameworks" asp-action="AddAssessmentQuestions" asp-all-route-data="@cancelLinkData" role="button" class="nhsuk-button nhsuk-button--secondary">Back</a>
                 <button class="nhsuk-button" type="submit">Next</button>
             </form>
-            <vc:back-link asp-controller="Frameworks" asp-action="Index" asp-all-route-data="@null" link-text="Cancel" />
+            <vc:cancel-link asp-controller="Frameworks" asp-action="CancelImport" asp-all-route-data="@cancelLinkData" link-text="Cancel" />
         </div>
     </div>
 </div>
diff --git a/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/ApplyCompetencyOrdering.cshtml b/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/ApplyCompetencyOrdering.cshtml
@@ -0,0 +1,75 @@
+﻿@using DigitalLearningSolutions.Web.Extensions
+@using DigitalLearningSolutions.Web.ViewModels.Frameworks.Import
+
+@model ApplyCompetencyOrderingViewModel
+
+@{
+    ViewData["Application"] = "Framework Service";
+    ViewData["HeaderPathName"] = "Framework Service";
+    var errorHasOccurred = !ViewData.ModelState.IsValid;
+    ViewData["Title"] = errorHasOccurred ? "Error: Add Assessment Questions" : "Add Assessment Questions";
+    var cancelLinkData = Html.GetRouteValues();
+}
+<link rel="stylesheet" href="@Url.Content("~/css/frameworks/frameworksShared.css")" asp-append-version="true">
+@section NavMenuItems {
+    <partial name="Shared/_NavMenuItems" />
+}
+@section NavBreadcrumbs {
+    <nav class="nhsuk-breadcrumb" aria-label="Breadcrumb">
+        <div class="nhsuk-width-container">
+            <ol class="nhsuk-breadcrumb__list">
+                <li class="nhsuk-breadcrumb__item"><a class="nhsuk-breadcrumb__link trigger-loader" asp-action="ViewFrameworks" asp-route-tabname="Mine">Frameworks</a></li>
+                <li class="nhsuk-breadcrumb__item"><a class="nhsuk-breadcrumb__link trigger-loader" asp-action="ViewFramework" asp-route-frameworkId="@ViewContext.RouteData.Values["frameworkId"]" asp-route-tabname="Structure">Framework Structure</a></li>
+                <li class="nhsuk-breadcrumb__item">Bulk upload</li>
+            </ol>
+            <p class="nhsuk-breadcrumb__back"><a class="nhsuk-breadcrumb__backlink" asp-action="ViewFramework" asp-route-frameworkId="@ViewContext.RouteData.Values["frameworkId"]" asp-route-tabname="Structure">Back to framework structure</a></p>
+        </div>
+    </nav>
+}
+<div class="nhsuk-grid-row">
+    <div class="nhsuk-grid-column-full">
+        <div class="nhsuk-u-reading-width">
+            <form class="nhsuk-u-margin-bottom-3" method="post" enctype="multipart/form-data">
+                <fieldset class="nhsuk-fieldset">
+                    <legend class="nhsuk-fieldset__legend nhsuk-fieldset__legend--l">
+                        <h1 class="nhsuk-fieldset__heading">
+                            Apply @Model.FrameworkVocabularySingular.ToLower() sequence changes?
+                        </h1>
+                    </legend>
+                    <div class="nhsuk-hint nhsuk-u-margin-bottom-2">
+                        Your uploaded file includes changes to the sequence of existing @Model.FrameworkVocabularyPlural.ToLower(). Choose whether to store the changes to @Model.FrameworkVocabularySingular.ToLower() sequence during update.
+                    </div>
+                    <div class="nhsuk-hint">
+                        Select an option
+                    </div>
+                    <div class="nhsuk-form-group">
+                        <div class="nhsuk-radios">
+                            <div class="nhsuk-radios__item">
+                                <input class="nhsuk-radios__input" id="option-1" asp-for="@Model.ReorderCompetenciesOption" type="radio" value="1" aria-describedby="option-1-hint">
+                                <label class="nhsuk-label nhsuk-radios__label" for="option-1">
+                                    Ignore changes to @Model.FrameworkVocabularySingular.ToLower() sequence
+                                </label>
+                                <div class="nhsuk-hint nhsuk-radios__hint" id="option-1-hint">
+                                    @Model.FrameworkVocabularyPlural will be updated if they have changed but there sequence/order in the framework will not change.
+                                </div>
+                            </div>
+                            <div class="nhsuk-radios__item">
+                                <input class="nhsuk-radios__input" id="option-2" asp-for="@Model.ReorderCompetenciesOption" type="radio" value="2" aria-describedby="option-2-hint">
+                                <label class="nhsuk-label nhsuk-radios__label" for="option-2">
+                                    Apply changes to @Model.FrameworkVocabularySingular.ToLower() sequence
+                                </label>
+                                <div class="nhsuk-hint nhsuk-radios__hint" id="option-2-hint">
+                                    The sequence of @Model.FrameworkVocabularyPlural.ToLower() in the framework will be changed to reflect the order in the sheet during processing.
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+
+                </fieldset>
+                <a asp-controller="Frameworks" asp-action="ImportCompleted" asp-all-route-data="@cancelLinkData" role="button" class="nhsuk-button nhsuk-button--secondary">Back</a>
+                <button class="nhsuk-button" type="submit">Next</button>
+            </form>
+            <vc:cancel-link asp-controller="Frameworks" asp-action="CancelImport" asp-all-route-data="@cancelLinkData" link-text="Cancel" />
+        </div>
+    </div>
+</div>
diff --git a/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/ImportCompleted.cshtml b/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/ImportCompleted.cshtml
diff --git a/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/Index.cshtml b/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/Index.cshtml

Original file line number	Diff line number	Diff line change
`@@ -34,29 +34,40 @@ public ImportCompetenciesResult PreProcessCompetenciesTable(IXLWorkbook workbook`
`34`	`34`	`{`
`35`	`35`	`var table = OpenCompetenciesTable(workbook, vocabulary);`
`36`	`36`	`var competencyRows = table.Rows().Skip(1).Select(row => new CompetencyTableRow(table, row)).ToList();`
	`37`	`+ var newCompetencyIds = competencyRows.Select(row => row.ID ?? 0).ToList();`
`37`	`38`	`var existingCompetencies = frameworkService.GetBulkCompetenciesForFramework(frameworkId);`
`38`	`39`	`var existingIds = existingCompetencies.Select(bc => (int)bc.ID).ToList();`
`39`	`40`	`foreach (var competencyRow in competencyRows)`
`40`	`41`	`{`
`41`		`- PreProcessCompetencyRow(competencyRow, existingIds);`
	`42`	`+ PreProcessCompetencyRow(competencyRow, newCompetencyIds, existingIds);`
`42`	`43`	`}`
`43`	`44`	`return new ImportCompetenciesResult(competencyRows);`
`44`	`45`	`}`
`45`		`- private void PreProcessCompetencyRow(CompetencyTableRow competencyRow, List<int> existingIds)`
	`46`	`+ private void PreProcessCompetencyRow(CompetencyTableRow competencyRow, List<int> newIds, List<int> existingIds)`
`46`	`47`	`{`
`47`	`48`	`if (competencyRow.ID == null)`
`48`	`49`	`{`
`49`	`50`	`competencyRow.RowStatus = RowStatus.CompetencyInserted;`
`50`	`51`	`}`
`51`	`52`	`else`
`52`	`53`	`{`
`53`		`- if (!existingIds.Contains((int)(competencyRow?.ID)))`
	`54`	`+ var id = (int)(competencyRow?.ID);`
	`55`	`+ if (!existingIds.Contains(id))`
`54`	`56`	`{`
`55`	`57`	`competencyRow.RowStatus = RowStatus.InvalidId;`
`56`	`58`	`}`
`57`	`59`	`else`
`58`	`60`	`{`
`59`		`- competencyRow.RowStatus = RowStatus.CompetencyUpdated;`
	`61`	`+ int originalIndex = existingIds.IndexOf(id);`
	`62`	`+ int newIndex = newIds.IndexOf(id);`
	`63`	`+ if(originalIndex == newIndex)`
	`64`	`+ {`
	`65`	`+ competencyRow.RowStatus = RowStatus.CompetencyUpdated;`
	`66`	`+ }`
	`67`	`+ else`
	`68`	`+ {`
	`69`	`+ competencyRow.RowStatus = RowStatus.CompetencyUpdatedAndReordered;`
	`70`	`+ }`
`60`	`71`	`}`
`61`	`72`	`}`
`62`	`73`	`competencyRow.Validate();`
Original file line number	Diff line number	Diff line change
`@@ -37,5 +37,6 @@ public AddQuestionsToWhichCompetenciesViewModel`
`37`	`37`	`public int CompetenciesToProcessCount { get; set; }`
`38`	`38`	`public int CompetenciesToAddCount { get; set; }`
`39`	`39`	`public int CompetenciesToUpdateCount { get; set; }`
	`40`	`+`
`40`	`41`	`}`
`41`	`42`	`}`