#5016 - Institution restrictions - ECert validations #5573

dheepak-aot · 2026-01-02T23:52:41Z

Institution restrictions - ECert validations

ECert validations

Updated the query to get eligible disbursements to include active institution restrictions and also the program and location of the offering.
Added a new property institutionRestrictions to EligibleECertDisbursement to receive all active institution restrictions.
Added a method getEffectiveInstitutionRestrictions to return the effective institution restrictions that are as of now effective for program and location of the offering.
Added a new ECertFailedValidation type HasStopDisbursementInstitutionRestriction for institution having an effective stop disbursement restriction.
Both the full-time and part-time validate step updated to check for effective institution restrictions.

UI - Warning banners

Updated the warning banner during accepting assessment.

Waring banner when disbursement is blocked.

E2E Tests

Queue consumers E2E Tests

Scheduler queue processor for part-time-e-cert-integration.
    √ Should block the disbursement and log the information when the institution has an effective institution restriction for the application location and program with action type Stop part time disbursement. (2534 ms)                                                                                                                                                                                                                        
    √ Should create the e-Cert and log the information when the institution does not have an effective institution restriction for the application location and program with action type Stop part time disbursement. (1705 ms)

Scheduler queue processor for full-time-e-cert-integration.
    √ Should block the disbursement and log the information when the institution has an effective institution restriction for the application location and program with action type Stop full time disbursement. (1715 ms)

API E2E Tests

ApplicationStudentsController(e2e)-getCompletedApplicationDetails
    √ Should get application details with ecert failed validations array having stop disbursement institution restriction when there are is an effective restriction on institution account for the application location and program and the offering intensity is part-time. (1968 ms)

ApplicationStudentsController(e2e)-getApplicationWarnings
    √ Should return a failed ecert validations array with stop disbursement institution restriction when there are is an effective restriction on institution account for the application location and program and the offering intensity is part-time. (1530 ms)

FormIO

As new program year setup was done for PY 2026-27 updated the SFAA forms with latest logic.

Copilot

Pull request overview

This PR implements institution restriction validations for ECert processing, preventing disbursements when an institution has active "StopFullTimeDisbursement" or "StopPartTimeDisbursement" restrictions for specific programs and locations. The implementation adds backend validation logic, updates the UI with appropriate warning banners, and includes comprehensive e2e test coverage.

Key Changes

Added new InstitutionActiveRestriction model and validation logic to check institution-level restrictions during ECert processing
Introduced HasStopDisbursementInstitutionRestriction validation type that blocks disbursements when effective institution restrictions exist
Updated UI components and FormIO forms to display warning banners when programs are restricted by StudentAid BC

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`disbursement-schedule.models.ts`	Added `InstitutionActiveRestriction` interface, updated `EligibleECertDisbursement` class to handle institution restrictions, added mapping function for institution restrictions
`e-cert-generation.service.ts`	Extended query to include institution restrictions with program/location joins, added logic to group and pass institution restrictions to disbursements
`validate-disbursement-full-time-step.ts`	Added validation to check for effective institution restrictions with `StopFullTimeDisbursement` action
`validate-disbursement-part-time-step.ts`	Added validation to check for effective institution restrictions with `StopPartTimeDisbursement` action, added return type to CSLP validation method
`e-cert-steps-utils.ts`	Added `getInstitutionRestrictionsByActionType` function and refactored common restriction filtering logic into `hasEffectiveRestrictionAction`
`e-cert-pre-validation-service-models.ts`	Added new institution restriction validation to the list of blocking validations
`NoticeOfAssessment.vue`	Added handling for institution restriction validation to show appropriate warning message to students
`ECertFailedValidation.ts`	Added new enum value for institution restriction validation
`ecert-constants.ts`	Added user-facing message for institution restriction failed validation
`sfaa2026-27-pt.json`	Added warning banner for restricted programs and hidden fields to track institution restrictions
`sfaa2026-27-ft.json`	Added warning banner for restricted programs and hidden fields to track institution restrictions
`ecert-part-time-process-integration.scheduler.e2e-spec.ts`	Added e2e tests for institution restrictions blocking disbursements, updated MSFAA creation to specify offering intensity, improved function return type
`ecert-full-time-process-integration.scheduler.e2e-spec.ts`	Added e2e test for institution restrictions blocking full-time disbursements, updated MSFAA creation to specify offering intensity
`application.students.controller.getCompletedApplicationDetails.e2e-spec.ts`	Added e2e test verifying institution restriction appears in application details
`application.students.controller.getApplicationWarnings.e2e-spec.ts`	Added e2e test verifying institution restriction appears in application warnings

Copilot · 2026-01-05T21:07:12Z

...egration/ecert-integration/_tests_/ecert-part-time-process-integration.scheduler.e2e-spec.ts


    /**
     * Helper function to get the uploaded file name.
     * @returns The uploaded file name


The return type annotation was added to this function. While this is an improvement, note that the JSDoc comment should also end with a period after "file name" for consistency with project standards.

Suggested change

* @returns The uploaded file name

* @returns The uploaded file name.

Copilot · 2026-01-05T21:07:13Z

...ntegrations/src/services/disbursement-schedule/e-cert-processing-steps/e-cert-steps-utils.ts

+ * Check active institution restrictions by its action type in an eligible disbursement.
+ * @param eCertDisbursement disbursement to check institution restrictions.
+ * @param actionType action type.
+ * @returns the all the effective restrictions of the requested action type.


The return description has a grammatical error. It should be "all the effective restrictions" rather than "the all the effective restrictions".

...llers/application/_tests_/application.students.controller.getApplicationWarnings.e2e-spec.ts

...plication/_tests_/application.students.controller.getCompletedApplicationDetails.e2e-spec.ts

...egration/ecert-integration/_tests_/ecert-full-time-process-integration.scheduler.e2e-spec.ts

...egration/ecert-integration/_tests_/ecert-part-time-process-integration.scheduler.e2e-spec.ts

...backend/libs/integrations/src/services/disbursement-schedule/disbursement-schedule.models.ts

...es/backend/libs/integrations/src/services/disbursement-schedule/e-cert-generation.service.ts

sources/packages/forms/src/form-definitions/sfaa2026-27-pt.json

...ntegrations/src/services/disbursement-schedule/e-cert-processing-steps/e-cert-steps-utils.ts

...rvices/disbursement-schedule/e-cert-processing-steps/validate-disbursement-full-time-step.ts

andrewsignori-aot

Nice work, please take a look at the comments.

andrewsignori-aot · 2026-01-06T17:15:46Z

...ons/src/services/disbursement-schedule/e-cert-processing-steps/validate-disbursement-base.ts

+        validationResults.push({
+          resultType: ECertFailedValidation.HasStopDisbursementRestriction,
+          additionalInfo: {
+            restrictionCodes: stopDisbursementRestrictions.map(


Will this student-specific additionalInfo potentially contain institution restriction codes?
Since we have specific result types, I believe each result type should list its restriction codes. Does it make sense?

andrewsignori-aot · 2026-01-06T17:25:54Z

...backend/libs/integrations/src/services/disbursement-schedule/disbursement-schedule.models.ts

+  /**
+   * Restriction is applied to a student.
+   */
+  restrictedParty: RestrictedParty.Institution;


This type of implementation does not seem suitable for an interface, and I would recommend switching to a class where restrictedParty can be a read-only property set at the constructor.
Defining a property with an enum value and later needing to assign it again supports the idea of moving it to a class.

andrewsignori-aot

Thanks for making the changes, please take a look at the most recent comments.

sonarqubecloud · 2026-01-06T22:15:34Z

Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
1.2% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2026-01-06T22:16:17Z

Backend Unit Tests Coverage Report

Totals
Statements:	20.3% ( 4323 / 21298 )
Methods:	9.66% ( 252 / 2609 )
Lines:	24.45% ( 3705 / 15155 )
Branches:	10.36% ( 366 / 3534 )

github-actions · 2026-01-06T22:16:41Z

E2E Workflow Workers Coverage Report

Totals
Statements:	75.41% ( 1055 / 1399 )
Methods:	79.31% ( 115 / 145 )
Lines:	78.79% ( 769 / 976 )
Branches:	61.51% ( 171 / 278 )

github-actions · 2026-01-06T22:19:33Z

E2E Queue Consumers Coverage Report

Totals
Statements:	85.68% ( 1616 / 1886 )
Methods:	85% ( 187 / 220 )
Lines:	88.64% ( 1287 / 1452 )
Branches:	66.36% ( 142 / 214 )

github-actions · 2026-01-06T22:20:37Z

E2E SIMS API Coverage Report

Totals
Statements:	75.57% ( 8582 / 11357 )
Methods:	75.59% ( 1028 / 1360 )
Lines:	79.64% ( 6235 / 7829 )
Branches:	60.84% ( 1319 / 2168 )

andrewsignori-aot

Thanks for making the changes and the extra effort for looking into the different ways to represents the ActiveRestriction abstraction to accommodate the students and instructions restrictions. It looks great 👍

sh16011993

Nice work @dheepak-aot 👍

dheepak-aot added 3 commits January 2, 2026 10:28

initial commit

58950b9

initial commit

bed82b0

Institution restrictions E-Cert validations

344bfc3

dheepak-aot self-assigned this Jan 2, 2026

dheepak-aot added 2 commits January 4, 2026 16:39

Added E2E Tests for the queue consumers.

759c9dd

Added NOA and ECert blocking messages.

040980d

dheepak-aot added Integration Queue Consumers labels Jan 5, 2026

dheepak-aot added 2 commits January 4, 2026 21:05

Merge branch 'main' into feature/#5016-institution-restriction-sus-ecert

046f95d

merging changes into new PY file

29013e7

dheepak-aot added E2E/Unit tests Web portal labels Jan 5, 2026

API E2E tests.

9017b37

dheepak-aot requested a review from Copilot January 5, 2026 21:04

Copilot started reviewing on behalf of dheepak-aot January 5, 2026 21:04 View session

Updated E2E test util.

fdc6d9a

dheepak-aot marked this pull request as ready for review January 5, 2026 21:06

Copilot AI reviewed Jan 5, 2026

View reviewed changes