Merge pull request #2331 from bcgov/feature/doarSummary

Added the DOAR summary

Author: SodhiA1

backend/src/components/assessments/assessments.js

@@ -1,9 +1,18 @@
 'use strict';
-const { logApiError, getAccessToken, getData, putData, postData, getCreateOrUpdateUserValue,  getDataWithParams, handleExceptionResponse} = require('../utils');
+const {
+  logApiError,
+  getAccessToken,
+  getData,
+  putData,
+  postData,
+  getCreateOrUpdateUserValue,
+  getDataWithParams,
+  handleExceptionResponse
+} = require('../utils');
 const HttpStatus = require('http-status-codes');
 const config = require('../../config');
 const cacheService = require('../cache-service');
-const { createMoreFiltersSearchCriteria } = require('./studentFilters');
+const {createMoreFiltersSearchCriteria} = require('./studentFilters');
 const moment = require('moment');
 const {DateTimeFormatter, LocalDate, LocalDateTime} = require('@js-joda/core');
 const {FILTER_OPERATION, VALUE_TYPE, CONDITION} = require('../../util/constants');
@@ -95,7 +104,7 @@ async function getAssessmentStudentsPaginated(req, res) {
     };
 
     const token = getAccessToken(req);
-    let data = await getDataWithParams(token,`${config.get('assessments:assessmentStudentsURL')}/paginated`, params);
+    let data = await getDataWithParams(token, `${config.get('assessments:assessmentStudentsURL')}/paginated`, params);
 
     if (req?.query?.returnKey) {
       let result = data?.content.map((student) => student[req?.query?.returnKey]);
@@ -115,7 +124,7 @@ async function getAssessmentStudentsPaginated(req, res) {
   }
 }
 
-async function postAssessmentStudent(req, res){
+async function postAssessmentStudent(req, res) {
   try {
     const payload = {
       ...req.body,
@@ -133,9 +142,9 @@ async function postAssessmentStudent(req, res){
 }
 
 async function getAssessmentStudentByID(req, res) {
-  try {  
+  try {
     const token = getAccessToken(req);
-    let assessmentStudent = getAssessmentStudent(req.params.assessmentStudentID, res, token, req.session?.correlationID);
+    let assessmentStudent = await getAssessmentStudent(req.params.assessmentStudentID, res, token, req.session?.correlationID);
     return res.status(200).json(includeAssessmentStudentProps(assessmentStudent));
   } catch (e) {
     if (e?.status === 404) {
@@ -159,21 +168,21 @@ async function removeAssessmentStudents(req, res) {
 }
 
 function includeAssessmentStudentProps(assessmentStudent) {
-  if(assessmentStudent) {
+  if (assessmentStudent) {
     let school = cacheService.getSchoolBySchoolID(assessmentStudent.schoolOfRecordSchoolID);
     let assessmentCenter = cacheService.getSchoolBySchoolID(assessmentStudent.assessmentCenterID);
 
-    if(school) {
+    if (school) {
       assessmentStudent.schoolName_desc = getSchoolName(school);
     }
-    
-    if(assessmentCenter) {
+
+    if (assessmentCenter) {
       assessmentStudent.assessmentCenterName_desc = getSchoolName(assessmentCenter);
-    }    
+    }
 
     assessmentStudent.assessmentTypeName_desc = assessmentStudent.assessmentTypeCode;
     assessmentStudent.provincialSpecialCaseName_desc = assessmentStudent.provincialSpecialCaseCode ? cacheService.getSpecialCaseTypeLabelByCode(assessmentStudent.provincialSpecialCaseCode) : null;
-    assessmentStudent.sessionName_desc = moment(assessmentStudent.courseMonth, 'MM').format('MMMM') +' '+assessmentStudent.courseYear;
+    assessmentStudent.sessionName_desc = moment(assessmentStudent.courseMonth, 'MM').format('MMMM') + ' ' + assessmentStudent.courseYear;
   }
   return assessmentStudent;
 }
@@ -187,7 +196,7 @@ async function updateAssessmentStudentByID(req, res) {
   try {
     const token = getAccessToken(req);
     const payload = req.body;
-    payload.updateUser =  getCreateOrUpdateUserValue(req);
+    payload.updateUser = getCreateOrUpdateUserValue(req);
     payload.updateDate = null;
     payload.createDate = null;
     const result = await putData(token, payload, `${config.get('assessments:assessmentStudentsURL')}/${req.params.assessmentStudentID}`, getCreateOrUpdateUserValue(req));
@@ -250,7 +259,7 @@ function getSchoolName(school) {
   return school.mincode + ' - ' + school.schoolName;
 }
 
-function getAssessmentSpecialCases(req, res) {  
+function getAssessmentSpecialCases(req, res) {
   try {
     const codes = cacheService.getAllAssessmentSpecialCases();
     return res.status(HttpStatus.OK).json(Object.fromEntries(codes));

backend/src/validations/assessments.js

@@ -1,17 +1,17 @@
 const { object, string, boolean, number, array } = require('yup');
 const { baseRequestSchema } = require('./base');
 
+
 const putStudentAssessmentSchema = object({
   body: object({
     assessmentStudentID: string().nonNullable(),
     sessionID:string().nonNullable(),
     schoolOfRecordSchoolID: string().nonNullable(),
-    assessmentCenterID: string().nonNullable(),
     assessmentID:string().nonNullable(),
     assessmentTypeCode: string().nonNullable(),
     studentID: string().nonNullable(),
     pen: string().max(9).nonNullable(),
-    localID: string().max(12).nonNullable(),
+    localID: string().max(12).nullable().optional(),
     givenName: string().max(25).nonNullable(),
     surname: string().max(25).nonNullable(),
     localCourseID: string().max(20).nullable().optional(),
@@ -20,6 +20,14 @@ const putStudentAssessmentSchema = object({
     provincialSpecialCaseCode: string().max(1).nullable().optional(),
     courseStatusCode: string().max(1).nullable().optional(),
     numberOfAttempts: number().nullable().optional(),
+    schoolAtWriteSchoolID: string().nullable().optional(),
+    assessmentCenterSchoolID: string().nullable().optional(),
+    assessmentFormID: string().nullable().optional(),
+    adaptedAssessmentCode: string().nullable().optional(),
+    irtScore: number().nullable().optional(),
+    localAssessmentID: string().nullable().optional(),
+    markingSession: string().nullable().optional(),
+    downloadDate: string().nullable().optional(),
     courseMonth: number().optional(),
     courseYear: number().optional(),
     assessmentStudentValidationIssues: array().of(object({
@@ -42,18 +50,25 @@ const postAssessmentStudentSchema = object({
   body: object({
     sessionID:string().nonNullable(),
     schoolOfRecordSchoolID: string().nonNullable(),
-    assessmentCenterID: string().nonNullable(),
     assessmentID:string().nonNullable(),
     assessmentTypeCode: string().nonNullable(),
     studentID: string().nullable().optional(),
     assessmentStudentID: string().nullable().optional(),
     courseStatusCode: string().nullable().optional(),
     numberOfAttempts: string().nullable().optional(),
     pen: string().max(9).nonNullable(),
-    localID: string().max(12).nonNullable(),
+    localID: string().max(12).nullable().optional(),
     givenName: string().max(25).nonNullable(),
     surname: string().max(25).nonNullable(),
     isElectronicExam: boolean().nullable().optional(),
+    schoolAtWriteSchoolID: string().nullable().optional(),
+    assessmentCenterSchoolID: string().nullable().optional(),
+    assessmentFormID: string().nullable().optional(),
+    adaptedAssessmentCode: string().nullable().optional(),
+    irtScore: number().nullable().optional(),
+    localAssessmentID: string().nullable().optional(),
+    markingSession: string().nullable().optional(),
+    downloadDate: string().nullable().optional(),
     proficiencyScore: number().nullable().optional(),
     localCourseID: string().max(20).nullable().optional(),
     provincialSpecialCaseCode: string().max(1).nullable().optional(),

frontend/src/components/assessments/registrations/StudentRegistrations.vue

@@ -27,14 +27,14 @@
               text="Add Registration"
               prepend-icon="mdi-plus"
               class="mr-1 mb-1"
-              variant="outlined"
               @click="openCreateStudentRegDialog"
             />
             <v-btn
               id="removeStudentReg"
               color="#003366"
               text="Remove Registration"
-              prepend-icon="mdi-minus"
+              variant="outlined"
+              prepend-icon="mdi-trash-can-outline"
               class="mr-1 mb-1"
               :disabled="selectedAssessmentStudents.length <= 0"
               @click="removeStudents"
@@ -244,7 +244,7 @@ export default {
       }
     },
     getAssessmentStudents() {
-      this.loading = true;
+      this.isLoading = true;
       let sort = {assessmentStudentID: 'ASC',};
       let assessmentSearchParams = cloneDeep(this.filterSearchParams);
       if (! this.sessionID) {
@@ -279,7 +279,7 @@ export default {
       if (!confirmation) {
         return;
       }
-      this.loading = true;
+      this.isLoading = true;
       let payload = this.selectedAssessmentStudents.map(sas => sas.assessmentStudentID);
       ApiService.apiAxios.post(`${ApiRoutes.assessments.ASSESSMENT_REGISTRATIONS}/${this.userInfo.activeInstituteType.toLowerCase()}/students/remove`, payload)
         .then(() => {
@@ -290,7 +290,7 @@ export default {
           console.error(error);
           setFailureAlert(error?.response?.data?.message ? error?.response?.data?.message : 'An error occurred while trying to remove the registrations. Please try again later.');
         }).finally(() => {
-          this.loading = false;
+          this.isLoading = false;
         });
     },
     applyFilters($event) {

frontend/src/components/assessments/registrations/StudentRegistrationsCustomTable.vue

@@ -68,6 +68,7 @@
               {{ props.item['surname'] }}, {{ props.item['givenName'] }}
             </span>
             <span v-else-if="props.item[column.key]">{{ props.item[column.key] }}</span>
+            <span v-else-if="column.key === 'select'"></span>
             <span v-else>-</span>
           </td>
         </tr>

frontend/src/components/assessments/registrations/forms/AddStudentRegistration.vue

@@ -61,7 +61,6 @@
                     variant="underlined"
                     :maxlength="25"
                     density="compact"
-                    :rules="[rules.required(), rules.number()]"
                   />
                 </v-col>
               </v-row>
@@ -137,7 +136,7 @@
                 <v-col>
                   <v-autocomplete
                     id="AssessmentCenter"
-                    v-model="newStudentDetail.assessmentCenterID"
+                    v-model="newStudentDetail.assessmentCenterSchoolID"
                     variant="underlined"
                     :items="assessmentCenterSearchNames"
                     label="Assessment Center"
@@ -279,7 +278,7 @@ export default {
       newStudentDetail: {
         assessmentID: null,
         schoolOfRecordSchoolID: null,
-        assessmentCenterID: null,
+        assessmentCenterSchoolID: null,
         givenName: null,
         surname: null,
         pen: null,

frontend/src/components/assessments/registrations/forms/EditStudentRegistration.vue

@@ -105,7 +105,7 @@
               />
               <v-autocomplete
                 id="AssessmentCenter"
-                v-model="assessmentStudentDetail.assessmentCenterID"
+                v-model="assessmentStudentDetail.assessmentCenterSchoolID"
                 variant="underlined"
                 :items="assessmentCenterSearchNames"
                 label="Assessment Center"

frontend/src/components/assessments/reports/AssessmentReports.vue

@@ -215,7 +215,22 @@
           style="border: 1px solid black;border-radius: 10px;"
         >
           <v-card-title style="font-size: medium;">
-            Distribution of Assessment Results (DOAR)
+            <v-row>
+              <v-col class="d-flex justify-start">
+                Distribution of Assessment Results (DOAR)
+              </v-col>
+              <v-col class="d-flex justify-end mt-1">
+                <v-icon
+                  aria-hidden="false"
+                  color="rgb(0, 51, 102)"
+                  style="cursor: pointer;"
+                  size="24"
+                  @click="openDOARSummaryHelp"
+                >
+                  mdi-help-circle-outline
+                </v-icon>
+              </v-col>
+            </v-row>
           </v-card-title>
           <v-row class="pl-3 pb-3">
             <v-col 
@@ -348,6 +363,10 @@ export default {
       });
       this.schoolSearchNames = sortBy(this.schoolSearchNames, ['schoolCodeName']);
     },
+    openDOARSummaryHelp() {
+      const routeData = this.$router.resolve({name: 'doar-summary'});
+      window.open(routeData.href, '_blank');
+    },
     searchStudentForGivenPEN() {
       this.isSearchingStudent = true;
 

frontend/src/components/assessments/static/DoarSummary.vue

@@ -0,0 +1,116 @@
+
+<template>
+  <div class="assessment-report">
+    <h2 class="justify-center text-center">Distribution of Assessment Results (DOAR) Summary - Report Description</h2>
+    <h1>Description</h1>
+    <p>
+      This report lists the distribution of graduation assessment results for an assessment session for BC and Yukon.
+      Specifically, the proportion of students achieving various assessment scores, and the number of participating students are listed.
+    </p>
+
+    <h1>Included</h1>
+    <ul>
+      <li>The selected assessment session</li>
+      <li>Provincial totals – all BC schools (both public and independent) and all Yukon public schools, except for Non-Independent First Nations schools.</li>
+      <li>All Public totals – all public BC and Yukon schools, except for Non-Independent First Nations schools.</li>
+      <li>District totals – public schools only. Within the District, except for Non-Independent First Nations schools.</li>
+    </ul>
+
+    <h1>Excluded</h1>
+    <ul>
+      <li>Results for Aegrotats and Disqualifications</li>
+      <li>Results where the student has exceeded the number of allowable writes for the assessment.</li>
+    </ul>
+
+    <h1>Definitions</h1>
+    <h1 style="font-size: 1.0em" class="mb-n1 mt-2">Proficiency Scores</h1>
+    <ul>
+      <li><strong>"1" = Emerging</strong></li>
+      <li><strong>"2" = Developing</strong></li>
+      <li><strong>"3" = Proficient</strong></li>
+      <li><strong>"4" = Extending</strong></li>
+      <li><strong>"NC" = Student did not complete enough of the assessment</strong></li>
+    </ul>
+
+    <h1>School Types</h1>
+    <p>
+      <strong>Public School</strong> – A body of students, teachers, other staff, and facilities organized as a unit for educational purposes
+      under the supervision of an administrative officer and administered by a district school board. This includes Online Learning Schools.
+    </p>
+    <p>
+      <strong>Independent School</strong> – A school that is maintained and operated in British Columbia by an authority that provides an
+      educational program to 10 or more school-aged students as outlined in the Independent School Act.
+    </p>
+
+    <h1>Assessment Status</h1>
+    <p>
+      <strong>Aegrotat Standing</strong> - means the student has been excused from writing a Provincial Graduation Assessment due to
+      unpredictable circumstances that render the student unable to write an assessment, even at a future session.
+    </p>
+    <p>
+      <strong>Disqualification</strong> – an assessment is disqualified when the assessment rules are breached. No mark is given for the assessment.
+    </p>
+
+    <h1>Notes</h1>
+    <ul>
+      <li>The numbers in this report may differ from previous reports for a particular session, due to updates of the data.</li>
+      <li>If the report is for public use, a line of N/S means that less than 10 students were counted, or 100% of the students achieved the same assessment score.</li>
+    </ul>
+
+    <h1>Explanations</h1>
+    <ul>
+      <li>All assessment results relate ONLY to the specific session shown at the top of the report</li>
+      <li>These results do not include Aegrotats or Disqualifications.</li>
+      <li>The Provincial results include all schools in BC and Yukon (both public and independent), except Non-Independent First Nations schools.</li>
+    </ul>
+  </div>
+</template>
+
+<script>
+export default {
+  name: 'DoarSummary',
+  data() {
+    return {
+      // Component data can be added here if needed
+    };
+  }
+};
+</script>
+
+<style scoped>
+.assessment-report {
+  max-width: 80em;
+  margin: 0 auto;
+  padding: 1.25em;
+  font-family: Arial, sans-serif;
+  line-height: 1.6;
+}
+
+h2{
+  color: #34495e;
+}
+
+h3 {
+  color: #34495e;
+  margin-top: 1.25em;
+  margin-bottom: 0.625em;
+}
+
+ul {
+  margin: 0.625em 0;
+  padding-left: 1.25em;
+}
+
+li {
+  margin: 0.3125em 0;
+}
+
+p {
+  margin: 0.625em 0;
+  text-align: justify;
+}
+
+strong {
+  color: #2c3e50;
+}
+</style>