Merge pull request #3065 from TechnologyEnhancedLearning/Develop/Features/TD-5233-BulkImportTidyUp

kevwhitt-hee · web-flow · commit ad4b3b06d46d · 2025-01-17T17:19:37.000Z
TD-5233 bulk import tidy up tasks
diff --git a/DigitalLearningSolutions.Data/Models/Frameworks/Import/CompetencyTableRow.cs b/DigitalLearningSolutions.Data/Models/Frameworks/Import/CompetencyTableRow.cs
@@ -9,7 +9,6 @@ public enum RowStatus
         CompetencyGroupAndCompetencyInserted,
         CompetencyInserted,
         CompetencyUpdated,
-        CompetencyUpdatedAndReordered,
         CompetencyGroupInserted,
         CompetencyGroupUpdated,
         CompetencyGroupAndCompetencyUpdated,
@@ -42,6 +41,7 @@ public CompetencyTableRow(IXLTable table, IXLRangeRow row)
         public string? AlwaysShowDescriptionRaw { get; set; }
         public ImportCompetenciesResult.ErrorReason? Error { get; set; }
         public RowStatus RowStatus { get; set; }
+        public bool Reordered { get; set; } = false;
         public bool Validate()
         {
             if (string.IsNullOrEmpty(Competency))
diff --git a/DigitalLearningSolutions.Data/Models/Frameworks/Import/ImportCompetenciesResult.cs b/DigitalLearningSolutions.Data/Models/Frameworks/Import/ImportCompetenciesResult.cs
@@ -22,10 +22,10 @@ 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 | dr.RowStatus == RowStatus.CompetencyUpdatedAndReordered);
-            CompetencyReorderedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.CompetencyUpdatedAndReordered);
+            CompetencyUpdatedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.CompetencyUpdated | dr.RowStatus == RowStatus.CompetencyGroupAndCompetencyUpdated);
             GroupAddedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.CompetencyGroupInserted | dr.RowStatus == RowStatus.CompetencyGroupAndCompetencyInserted);
-            SkippedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.Skipped);
+            SkippedCount = competencyTableRows.Count(dr => dr.RowStatus == RowStatus.Skipped && dr.Reordered == false);
+            CompetencyReorderedCount = competencyTableRows.Count(dr => dr.Reordered == true);
             Errors = competencyTableRows.Where(dr => dr.Error.HasValue).Select(dr => (dr.RowNumber, dr.Error!.Value));
             FlagCount = competencyTableRows
                 .Where(row => !string.IsNullOrWhiteSpace(row.FlagsCsv))
diff --git a/DigitalLearningSolutions.Web/Services/ImportCompetenciesFromFileService.cs b/DigitalLearningSolutions.Web/Services/ImportCompetenciesFromFileService.cs
@@ -61,13 +61,10 @@ private void PreProcessCompetencyRow(CompetencyTableRow competencyRow, List<int>
                 {
                     int originalIndex = existingIds.IndexOf(id);
                     int newIndex = newIds.IndexOf(id);
-                    if (originalIndex == newIndex)
+                    competencyRow.RowStatus = RowStatus.CompetencyUpdated;
+                    if (originalIndex != newIndex)
                     {
-                        competencyRow.RowStatus = RowStatus.CompetencyUpdated;
-                    }
-                    else
-                    {
-                        competencyRow.RowStatus = RowStatus.CompetencyUpdatedAndReordered;
+                        competencyRow.Reordered = true;
                     }
                 }
             }
@@ -125,7 +122,7 @@ internal ImportCompetenciesResult ProcessCompetenciesTable(IXLTable table, int a
             {
                 maxFrameworkCompetencyGroupId = ProcessCompetencyRow(adminUserId, frameworkId, maxFrameworkCompetencyId, maxFrameworkCompetencyGroupId, addAssessmentQuestionsOption, reorderCompetenciesOption, customAssessmentQuestionID, defaultQuestionIds, competencyRow);
             }
-            // TO DO: Check for changes to competency group order and apply them if appropriate:
+            // Check for changes to competency group order and apply them if appropriate:
             if (reorderCompetenciesOption == 2)
             {
                 var distinctCompetencyGroups = competenciesRows
@@ -147,6 +144,10 @@ internal ImportCompetenciesResult ProcessCompetenciesTable(IXLTable table, int a
                         {
                             frameworkService.MoveFrameworkCompetencyGroup(thisGroup.ID, true, direction);
                         }
+                        competenciesRows
+                                .Where(row => row.CompetencyGroup == thisGroup.Name)
+                                .ToList()
+                                .ForEach(row => row.Reordered = true);
                     }
                 }
             }
@@ -274,10 +275,7 @@ CompetencyTableRow competencyRow
                         frameworkService.MoveFrameworkCompetency(frameworkCompetencyId, true, direction);
                     }
 
-                    if (competencyRow.RowStatus == RowStatus.Skipped)
-                    {
-                        competencyRow.RowStatus = RowStatus.CompetencyUpdated;
-                    }
+                    competencyRow.Reordered = true;
                 }
             }
 
diff --git a/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/ImportCompetenciesResultsViewModel.cs b/DigitalLearningSolutions.Web/ViewModels/Frameworks/Import/ImportCompetenciesResultsViewModel.cs
@@ -14,6 +14,7 @@ public ImportCompetenciesResultsViewModel(ImportCompetenciesResult importCompete
             CompetenciesUpdatedCount = importCompetenciesResult.CompetencyUpdatedCount;
             CompetencyGroupsInsertedCount = importCompetenciesResult.GroupAddedCount;
             CompetencyGroupsUpdatedCount = importCompetenciesResult.GroupUpdatedCount;
+            CompetenciesReorderedCount = importCompetenciesResult.CompetencyReorderedCount;
             SkippedCount = importCompetenciesResult.SkippedCount;
             Errors = importCompetenciesResult.Errors.Select(x => (x.RowNumber, MapReasonToErrorMessage(x.Reason)));
             FrameworkID = frameworkId;
@@ -26,6 +27,7 @@ public ImportCompetenciesResultsViewModel(ImportCompetenciesResult importCompete
         public int ProcessedCount { get; set; }
         public int CompetenciesInsertedCount { get; set; }
         public int CompetenciesUpdatedCount { get; set; }
+        public int CompetenciesReorderedCount { get; set; }
         public int CompetencyGroupsInsertedCount { get; set; }
         public int CompetencyGroupsUpdatedCount { get; set; }
         public int SkippedCount { get; set; }
diff --git a/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/ApplyCompetencyOrdering.cshtml b/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/ApplyCompetencyOrdering.cshtml
@@ -41,7 +41,7 @@
                         <p>We strongly recommend including all framework competencies in your uploaded sheet if reordering competencies to ensure that the correct sequence is applied.</p>
                     </div>
                     <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.
+                        Your uploaded file includes changes to the order of existing @Model.FrameworkVocabularyPlural.ToLower(). Choose whether to store the changes to @Model.FrameworkVocabularySingular.ToLower() order during update.
                     </div>
                     <div class="nhsuk-hint">
                         Select an option
@@ -51,7 +51,7 @@
                             <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
+                                    Ignore changes to @Model.FrameworkVocabularySingular.ToLower() order
                                 </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.
@@ -60,10 +60,10 @@
                             <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
+                                    Apply changes to @Model.FrameworkVocabularySingular.ToLower() order
                                 </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.
+                                    The oder of @Model.FrameworkVocabularyPlural.ToLower() in the framework will be changed to reflect the order in the sheet during processing.
                                 </div>
                             </div>
                         </div>
diff --git a/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/ImportSummary.cshtml b/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/ImportSummary.cshtml
@@ -31,6 +31,10 @@
 <div class="nhsuk-grid-row">
     <div class="nhsuk-grid-column-full">
         <h1 class="nhsuk-heading-xl">@Model.FrameworkVocabularyPlural import summary</h1>
+        @if (Model.PublishStatusID == 3)
+        {
+            <partial name="Shared/_PublishedWarning" />
+        }
         <p class="nhsuk-body-l nhsuk-u-reading-width">Your @Model.FrameworkVocabularySingular.ToLower() sheet is ready to be processed. Please check the details below are correct before proceeding to @process @Model.FrameworkVocabularyPlural.ToLower() in the framework @Model.FrameworkName.</p>
         <h2>Upload summary</h2>
         <dl class="nhsuk-summary-list">
diff --git a/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/Index.cshtml b/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/Index.cshtml
@@ -36,11 +36,23 @@
             {
                 <partial name="Shared/_PublishedWarning" />
             }
-            @* <vc:inset-text css-class="" text="The building blocks for your framework will be referred to as 'competencies' for the purpose of importing. Once they have been imported, they will be referred to using your chosen vocabulary."></vc:inset-text> *@
+            
             <div class="nhsuk-form-group">
                 @if (Model.IsNotBlank)
                 {
-
+                    <div class="nhsuk-inset-text">
+                        <span class="nhsuk-u-visually-hidden">Note: </span>
+                        <p>
+                            Bulk upload <strong>cannot</strong> be used to:
+                        </p>
+                            <ul>
+                            <li>Delete @Model.FrameworkVocabularyPlural.ToLower() or @Model.FrameworkVocabularySingular.ToLower() groups</li>
+                            <li>Remove assessment questions from existing @Model.FrameworkVocabularyPlural.ToLower()</li>
+                            <li>Add more than one custom assessment question to uploaded @Model.FrameworkVocabularyPlural.ToLower()</li>
+                            <li>Remove flags from @Model.FrameworkVocabularyPlural.ToLower()</li>
+                            </ul>
+                        
+                    </div>
                     <p class="nhsuk-body-m">
                         To bulk add and/or update @Model.FrameworkVocabularyPlural.ToLower() in the framework, <strong>@Model.FrameworkName</strong>, download an Excel workbook using one of the options below.
                     </p>
@@ -91,6 +103,7 @@
                 }
                 else
                 {
+                    <vc:inset-text css-class="" text="Bulk upload cannot be used to add more than one custom assessment question to uploaded @Model.FrameworkVocabularyPlural.ToLower()."></vc:inset-text>
                     <p class="nhsuk-body-m">
                         Download a blank template for bulk adding @Model.FrameworkVocabularyPlural.ToLower() to your framework, <strong>@Model.FrameworkName</strong>. This Excel file will be empty. New @Model.FrameworkVocabularyPlural.ToLower() can be added by including their details on a blank row.
                     </p>
diff --git a/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/UploadResults.cshtml b/DigitalLearningSolutions.Web/Views/Frameworks/Developer/Import/UploadResults.cshtml
@@ -37,6 +37,7 @@
                 <li>@Model.CompetencyGroupsInsertedCount new @(Model.CompetencyGroupsInsertedCount == 1 ? $"{Model.FrameworkVocabularySingular.ToLower()} group" : $"{Model.FrameworkVocabularySingular.ToLower()} groups") inserted</li>
                 <li>@Model.CompetenciesInsertedCount new @(Model.CompetenciesInsertedCount == 1 ? Model.FrameworkVocabularySingular.ToLower() : Model.FrameworkVocabularyPlural.ToLower()) inserted</li>
                 <li>@Model.CompetenciesUpdatedCount existing @(Model.CompetenciesUpdatedCount == 1 ? Model.FrameworkVocabularySingular.ToLower() : Model.FrameworkVocabularyPlural.ToLower()) updated</li>
+                <li>@Model.CompetenciesReorderedCount existing @(Model.CompetenciesReorderedCount == 1 ? Model.FrameworkVocabularySingular.ToLower() : Model.FrameworkVocabularyPlural.ToLower()) reordered</li>
                 <li>@Model.SkippedCount rows @(Model.SkippedCount == 1 ? "line" : "lines") skipped (nothing inserted or updated but no errors)</li>
                 <li>@Model.ErrorCount @(Model.ErrorCount == 1 ? "line" : "lines") skipped due to errors</li>
             </ul>

Original file line number	Diff line number	Diff line change
`@@ -61,13 +61,10 @@ private void PreProcessCompetencyRow(CompetencyTableRow competencyRow, List<int>`
`61`	`61`	`{`
`62`	`62`	`int originalIndex = existingIds.IndexOf(id);`
`63`	`63`	`int newIndex = newIds.IndexOf(id);`
`64`		`- if (originalIndex == newIndex)`
	`64`	`+ competencyRow.RowStatus = RowStatus.CompetencyUpdated;`
	`65`	`+ if (originalIndex != newIndex)`
`65`	`66`	`{`
`66`		`- competencyRow.RowStatus = RowStatus.CompetencyUpdated;`
`67`		`- }`
`68`		`- else`
`69`		`- {`
`70`		`- competencyRow.RowStatus = RowStatus.CompetencyUpdatedAndReordered;`
	`67`	`+ competencyRow.Reordered = true;`
`71`	`68`	`}`
`72`	`69`	`}`
`73`	`70`	`}`
`@@ -125,7 +122,7 @@ internal ImportCompetenciesResult ProcessCompetenciesTable(IXLTable table, int a`
`125`	`122`	`{`
`126`	`123`	`maxFrameworkCompetencyGroupId = ProcessCompetencyRow(adminUserId, frameworkId, maxFrameworkCompetencyId, maxFrameworkCompetencyGroupId, addAssessmentQuestionsOption, reorderCompetenciesOption, customAssessmentQuestionID, defaultQuestionIds, competencyRow);`
`127`	`124`	`}`
`128`		`- // TO DO: Check for changes to competency group order and apply them if appropriate:`
	`125`	`+ // Check for changes to competency group order and apply them if appropriate:`
`129`	`126`	`if (reorderCompetenciesOption == 2)`
`130`	`127`	`{`
`131`	`128`	`var distinctCompetencyGroups = competenciesRows`
`@@ -147,6 +144,10 @@ internal ImportCompetenciesResult ProcessCompetenciesTable(IXLTable table, int a`
`147`	`144`	`{`
`148`	`145`	`frameworkService.MoveFrameworkCompetencyGroup(thisGroup.ID, true, direction);`
`149`	`146`	`}`
	`147`	`+ competenciesRows`
	`148`	`+ .Where(row => row.CompetencyGroup == thisGroup.Name)`
	`149`	`+ .ToList()`
	`150`	`+ .ForEach(row => row.Reordered = true);`
`150`	`151`	`}`
`151`	`152`	`}`
`152`	`153`	`}`
`@@ -274,10 +275,7 @@ CompetencyTableRow competencyRow`
`274`	`275`	`frameworkService.MoveFrameworkCompetency(frameworkCompetencyId, true, direction);`
`275`	`276`	`}`
`276`	`277`
`277`		`- if (competencyRow.RowStatus == RowStatus.Skipped)`
`278`		`- {`
`279`		`- competencyRow.RowStatus = RowStatus.CompetencyUpdated;`
`280`		`- }`
	`278`	`+ competencyRow.Reordered = true;`
`281`	`279`	`}`
`282`	`280`	`}`
`283`	`281`