#1501 - Process ECE Response file part 2 (#1947)

Process ECE Response file part 2

Author: dheepak-aot

sources/packages/backend/apps/api/src/route-controllers/confirmation-of-enrollment/models/confirmation-of-enrollment.dto.ts

@@ -1,10 +1,8 @@
 import { Min, Max, IsNotEmpty, ValidateIf } from "class-validator";
 import { COEStatus, ProgramInfoStatus } from "@sims/sims-db";
 import { COEApprovalPeriodStatus } from "../../../services/disbursement-schedule/disbursement-schedule.models";
-import {
-  COE_DENIED_REASON_OTHER_ID,
-  MONEY_VALUE_FOR_UNKNOWN_MAX_VALUE,
-} from "../../../utilities";
+import { MONEY_VALUE_FOR_UNKNOWN_MAX_VALUE } from "../../../utilities";
+import { COE_DENIED_REASON_OTHER_ID } from "@sims/utilities";
 
 export class ApplicationDetailsForCOEAPIOutDTO {
   applicationProgramName: string;

sources/packages/backend/apps/api/src/utilities/application-utils.ts

@@ -1,5 +1,6 @@
 import { Application, DisbursementSchedule } from "@sims/sims-db";
-import { COE_DENIED_REASON_OTHER_ID, PIR_DENIED_REASON_OTHER_ID } from ".";
+import { PIR_DENIED_REASON_OTHER_ID } from ".";
+import { COE_DENIED_REASON_OTHER_ID } from "@sims/utilities";
 export const PIR_OR_DATE_OVERLAP_ERROR = "PIR_OR_DATE_OVERLAP_ERROR";
 export const PIR_OR_DATE_OVERLAP_ERROR_MESSAGE =
   "There is an existing application already with overlapping study period or a pending PIR.";

sources/packages/backend/apps/api/src/utilities/system-configurations-constants.ts

@@ -1,5 +1,4 @@
 export const PIR_DENIED_REASON_OTHER_ID = 1;
-export const COE_DENIED_REASON_OTHER_ID = 1;
 // Timeout to handle the worst-case scenario where the commit/rollback
 // was not executed due to a possible catastrophic failure.
 export const SUPPORTING_USERS_TRANSACTION_IDLE_TIMEOUT_SECONDS = 10;

sources/packages/backend/apps/queue-consumers/src/processors/index.ts

@@ -24,3 +24,4 @@ export * from "./schedulers/esdc-integration/msfaa-integration/msfaa-part-time-p
 export * from "./schedulers/sfas-integration/sfas-integration.scheduler";
 export * from "./schedulers/atbc-respone-integration/atbc-response-integration.scheduler";
 export * from "./schedulers/application/process-archive-application.scheduler";
+export * from "./schedulers/institution-integration/ece-response/ece-response-integration.scheduler";

sources/packages/backend/apps/queue-consumers/src/processors/schedulers/institution-integration/ece-response/ece-response-integration.scheduler.ts

@@ -0,0 +1,42 @@
+import { InjectQueue, Process, Processor } from "@nestjs/bull";
+import { QueueService } from "@sims/services/queue";
+import { QueueNames } from "@sims/utilities";
+import { InjectLogger, LoggerService } from "@sims/utilities/logger";
+import { Job, Queue } from "bull";
+import { QueueProcessSummaryResult } from "../../../models/processors.models";
+import { BaseScheduler } from "../../base-scheduler";
+import { ECEResponseProcessingService } from "@sims/integrations/institution-integration/ece-integration";
+
+@Processor(QueueNames.ECEProcessResponseIntegration)
+export class ECEResponseIntegrationScheduler extends BaseScheduler<void> {
+  constructor(
+    @InjectQueue(QueueNames.ECEProcessResponseIntegration)
+    schedulerQueue: Queue<void>,
+    private readonly eceResponseProcessingService: ECEResponseProcessingService,
+    queueService: QueueService,
+  ) {
+    super(schedulerQueue, queueService);
+  }
+
+  /**
+   * Process all the institution ECE responses and update the enrolment accordingly.
+   * @params job details.
+   * @returns Processing result log.
+   */
+  @Process()
+  async processECERequest(
+    job: Job<void>,
+  ): Promise<QueueProcessSummaryResult[]> {
+    this.logger.log(
+      `Processing ECE response integration job ${job.id} of type ${job.name}.`,
+    );
+    this.logger.log("Processing ECE response files ...");
+    const processingResult = await this.eceResponseProcessingService.process();
+    this.logger.log("Processing ECE response files completed.");
+    await this.cleanSchedulerQueueHistory();
+    return processingResult;
+  }
+
+  @InjectLogger()
+  logger: LoggerService;
+}

sources/packages/backend/apps/queue-consumers/src/queue-consumers.module.ts

@@ -23,6 +23,8 @@ import {
   SFASIntegrationScheduler,
   ATBCResponseIntegrationScheduler,
   ProcessArchiveApplicationsScheduler,
+  ECEProcessIntegrationScheduler,
+  ECEResponseIntegrationScheduler,
 } from "./processors";
 import {
   DisbursementScheduleSharedService,
@@ -53,7 +55,6 @@ import { StudentAssessmentService, ApplicationService } from "./services";
 import { SFASIntegrationModule } from "@sims/integrations/sfas-integration";
 import { ATBCIntegrationModule } from "@sims/integrations/atbc-integration";
 import { ECEIntegrationModule } from "@sims/integrations/institution-integration/ece-integration";
-import { ECEProcessIntegrationScheduler } from "./processors/schedulers/institution-integration/ece-request/ece-process-integration.scheduler";
 
 @Module({
   imports: [
@@ -107,6 +108,7 @@ import { ECEProcessIntegrationScheduler } from "./processors/schedulers/institut
     FullTimeMSFAAProcessResponseIntegrationScheduler,
     PartTimeMSFAAProcessResponseIntegrationScheduler,
     ProcessArchiveApplicationsScheduler,
+    ECEResponseIntegrationScheduler,
     SystemUsersService,
     ApplicationService,
     ConfirmationOfEnrollmentService,

sources/packages/backend/libs/integrations/src/constants/system-configurations-constants.ts

@@ -9,3 +9,9 @@ export const DISBURSEMENT_FILE_GENERATION_ANTICIPATION_DAYS = 5;
  * File name of the ECE response file sent by institutions.
  */
 export const ECE_RESPONSE_FILE_NAME = "CONR_008.TXT";
+
+/**
+ * Reason to be saved while declining an enrolment through ECE file integration.
+ */
+export const ECE_RESPONSE_COE_DECLINED_REASON =
+  "A reason was not provided by your institution. Please speak to your Financial Aid Officer at your institution for details.";

sources/packages/backend/libs/integrations/src/institution-integration/ece-integration/ece-files/ece-response-file-detail.ts

@@ -64,10 +64,10 @@ export class ECEResponseFileDetail extends ECEResponseFileRecord {
   getInvalidDataMessage(): string | undefined {
     const errors: string[] = [];
     if (isNaN(this.disbursementIdentifier)) {
-      errors.push("invalid unique index number for the disbursement record.");
+      errors.push("Invalid unique index number for the disbursement record.");
     }
-    if (!this.applicationNumber) {
-      errors.push("application number not found or invalid.");
+    if (!this.applicationNumber?.trim()) {
+      errors.push("Invalid application number.");
     }
     return errors.length ? errors.join(", ") : undefined;
   }

sources/packages/backend/libs/integrations/src/institution-integration/ece-integration/ece-integration.module.ts

@@ -3,10 +3,13 @@ import {
   RestrictionSharedService,
   StudentRestrictionSharedService,
   WorkflowClientService,
+  ConfirmationOfEnrollmentService,
+  SequenceControlService,
 } from "@sims/services";
 import { ConfigModule } from "@sims/utilities/config";
 import {
   DisbursementScheduleService,
+  InstitutionLocationService,
   SshService,
 } from "@sims/integrations/services";
 import { ECEProcessingService } from "./ece.processing.service";
@@ -27,6 +30,9 @@ import { ECEResponseProcessingService } from "./ece-response.processing.service"
     RestrictionSharedService,
     ECEResponseIntegrationService,
     ECEResponseProcessingService,
+    InstitutionLocationService,
+    ConfirmationOfEnrollmentService,
+    SequenceControlService,
   ],
   exports: [ECEProcessingService, ECEResponseProcessingService],
 })

sources/packages/backend/libs/integrations/src/institution-integration/ece-integration/ece-response.integration.service.ts

@@ -23,11 +23,23 @@ export class ECEResponseIntegrationService extends SFTPIntegrationBase<
   async downloadResponseFile(
     remoteFilePath: string,
   ): Promise<ECEResponseFileDetail[]> {
-    const fileLines = await this.downloadResponseFileLines(remoteFilePath);
+    const fileLines = await this.downloadResponseFileLines(remoteFilePath, {
+      checkIfFileExist: true,
+    });
+    // Check if the file exist in the remote server.
+    if (!fileLines) {
+      return [];
+    }
+    // The file is not expected to be empty without content.
+    if (!fileLines.length) {
+      const error = "The ECE response file is empty and cannot be processed.";
+      this.logger.error(error);
+      throw new Error(error);
+    }
     // Read the first line to check if the header record type is the expected one.
     const header = new ECEResponseFileHeader(fileLines.shift()); // Read and remove header.
     if (header.recordType !== RecordTypeCodes.ECEHeader) {
-      const error = `The ECE response file ${remoteFilePath} has an invalid record type on header: ${header.recordType}`;
+      const error = `The ECE response file has an invalid record type on header: ${header.recordType}`;
       this.logger.error(error);
       // If the header is not the expected one, throw an error.
       throw new Error(error);
@@ -42,14 +54,16 @@ export class ECEResponseIntegrationService extends SFTPIntegrationBase<
     }
     // The file is expected to have at least one detail record.
     if (!fileLines.length) {
-      const error = `The ECE response file ${remoteFilePath} does not have any detail records to process.`;
+      const error =
+        "The ECE response file does not have any detail records to process.";
       this.logger.error(error);
       throw new Error(error);
     }
     // The total count of detail records is mentioned in the footer record and it is expected to
     // match the actual count of total records.
     if (fileLines.length !== footer.totalDetailRecords) {
-      const error = `In ${remoteFilePath} the total count of detail records mentioned in the footer record does not match with the actual total details records count.`;
+      const error =
+        "In the total count of detail records mentioned in the footer record does not match with the actual total details records count.";
       this.logger.error(error);
       throw new Error(error);
     }