#5588 - Student current year income appeal by CarlyCotton · Pull Request #5874 · bcgov/SIMS

CarlyCotton · 2026-03-10T17:04:17Z

Migrations

Added dynamic form configurations for studentcurrentyearincomeappeal, partnercurrentyearincomeappeal, exceptionalexpenseappeal
- Because applications have the isEligible... in the assessment, selecting appeals for an application were erroring without the configuration records.

Consolidated Data

Updated the consolidated data for Student Current Year Income to not bring in the other variables submitted in the form. Only keeping currentYearIncome.

Student Current Year Income Form

Select:

Submission:

…peal

Copilot

Pull request overview

Adds support for the “Student Current Year Income” appeal by introducing a new Form.io definition, wiring consolidated assessment data to only carry currentYearIncome, and seeding dynamic form configuration records needed for eligible-appeal selection/conversion flows.

Changes:

Added studentcurrentyearincomeappeal form definition JSON.
Updated assessment consolidated-data workflow mapping to only include currentYearIncome for the student current-year-income appeal.
Added DB migration + SQL scripts to insert/rollback dynamic form configuration records for several appeal form types.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
sources/packages/forms/src/form-definitions/studentcurrentyearincomeappeal.json	New Form.io definition for the student current-year-income appeal submission.
sources/packages/backend/workflow/src/workflow-definitions/load-assessment-consolidated-data.bpmn	Narrows consolidated appeal data mapping to only `currentYearIncome`.
sources/packages/backend/apps/db-migrations/src/sql/DynamicFormConfigurations/Insert-appeal-conversion-records.sql	Seeds dynamic form configuration records for appeal form types used during eligibility/selection.
sources/packages/backend/apps/db-migrations/src/sql/DynamicFormConfigurations/Rollback-Insert-appeal-conversion-records.sql	Rollback script to remove the inserted dynamic form configuration records.
sources/packages/backend/apps/db-migrations/src/migrations/1772752698502-AddAppealConversionRecords.ts	TypeORM migration to apply/rollback the new SQL scripts.

Copilot · 2026-03-11T03:42:22Z

...nd/apps/db-migrations/src/sql/DynamicFormConfigurations/Insert-appeal-conversion-records.sql

+        'Partner current year income',
+        'partnercurrentyearincomeappeal',
+        'Student appeal',
+        'Submit this appeal to provide your spouse/common-law partner\'' s current year income information IF they have experienced a significant CHANGE IN their financial circumstances since you submitted your Student Financial Aid Application.',


The partner appeal description contains an escaped apostrophe sequence partner\'' s which will persist a literal backslash and an extra space in the description (rendering like partner\' s). In SQL for Postgres, apostrophes should be escaped as '' with no backslash, and the space before s should be removed so the text reads partner's.

Suggested change

'Submit this appeal to provide your spouse/common-law partner\'' s current year income information IF they have experienced a significant CHANGE IN their financial circumstances since you submitted your Student Financial Aid Application.',

'Submit this appeal to provide your spouse/common-law partner''s current year income information IF they have experienced a significant CHANGE IN their financial circumstances since you submitted your Student Financial Aid Application.',

Copilot · 2026-03-11T03:42:23Z

...nd/apps/db-migrations/src/sql/DynamicFormConfigurations/Insert-appeal-conversion-records.sql

+        'If you have had exceptional expenses that created financial hardship that affected your ability TO START
+        OR continue your studies these expenses may be considered AS part of your assessment.',


The exceptional expense form_description includes an embedded newline and inconsistent casing (e.g., TO START, OR, AS) which will likely show up verbatim in the UI. Consider rewriting this as a single, properly cased sentence (or explicit intended formatting) so the description is user-friendly and consistent with other form descriptions.

Suggested change

'If you have had exceptional expenses that created financial hardship that affected your ability TO START

OR continue your studies these expenses may be considered AS part of your assessment.',

'If you have had exceptional expenses that created financial hardship that affected your ability to start or continue your studies, these expenses may be considered as part of your assessment.',

Copilot · 2026-03-11T03:42:23Z

...b-migrations/src/sql/DynamicFormConfigurations/Rollback-Insert-appeal-conversion-records.sql

+-- Remove configurations for the student current year income appeal form from the dynamic_form_configurations table.
+DELETE FROM
+    sims.dynamic_form_configurations
+WHERE
+    form_type IN (
+        'Student current year income',
+        'Partner current year income',
+        'Exceptional expense'
+    );


This file comment says it removes configurations for only the student current year income appeal, but the DELETE covers three form_type values (Student/Partner current year income and Exceptional expense). Update the comment to match the actual rollback behavior to avoid confusion during future maintenance.

Copilot · 2026-03-11T03:42:23Z

sources/packages/forms/src/form-definitions/studentcurrentyearincomeappeal.json

+      "label": "Current Tax Year",
+      "persistent": false,
+      "type": "hidden",
+      "calculateValue": "// From the program year, get the calendar start year of the the program year.\r\n// e.g. program year  = 2022-2023, calendar start year is 2022. And Current tax year should be 2022.\r\nconst [startYear] = data.programYear ? data.programYear.split(\"-\"):[];\r\nvalue = startYear;",


The calculateValue inline comment has a duplicated word: get the calendar start year of the the program year. Fixing this improves readability and keeps form logic comments consistent across definitions.

Suggested change

"calculateValue": "// From the program year, get the calendar start year of the the program year.\r\n// e.g. program year = 2022-2023, calendar start year is 2022. And Current tax year should be 2022.\r\nconst [startYear] = data.programYear ? data.programYear.split(\"-\"):[];\r\nvalue = startYear;",

"calculateValue": "// From the program year, get the calendar start year of the program year.\r\n// e.g. program year = 2022-2023, calendar start year is 2022. And Current tax year should be 2022.\r\nconst [startYear] = data.programYear ? data.programYear.split(\"-\"):[];\r\nvalue = startYear;",

Copilot · 2026-03-11T03:42:23Z

sources/packages/forms/src/form-definitions/studentcurrentyearincomeappeal.json

+        {
+          "label": "Please explain your situation:",
+          "placeholder": "Type of expense, when expenses occurred and amount",
+          "autoExpand": false,
+          "tableView": true,
+          "validate": {
+            "required": true


The placeholder text for the "Other" reason (Type of expense, when expenses occurred and amount) appears to be copied from an expenses flow and does not match a current-year income decrease appeal. Update the placeholder (and, if needed, the panel title) to prompt for income-related details (e.g., reason for income decrease, dates, and estimated amounts) to avoid confusing applicants.

Copilot · 2026-03-11T03:42:24Z

...nd/apps/db-migrations/src/sql/DynamicFormConfigurations/Insert-appeal-conversion-records.sql

@@ -0,0 +1,36 @@
+-- Insert configurations for the student current year income appeal form into the dynamic_form_configurations table.


The header comment mentions only the student current year income appeal, but this script inserts three configurations (student current year income, partner current year income, and exceptional expense). Update the comment so it accurately describes what the script is doing.

Suggested change

-- Insert configurations for the student current year income appeal form into the dynamic_form_configurations table.

-- Insert configurations for the student current year income, partner current year income, and exceptional expense appeal forms into the dynamic_form_configurations table.

...nd/apps/db-migrations/src/sql/DynamicFormConfigurations/Insert-appeal-conversion-records.sql

andrewsignori-aot · 2026-03-11T18:05:27Z

...ckages/backend/apps/db-migrations/src/migrations/1772752698502-AddAppealConversionRecords.ts

+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      getSQLFileData(
+        "Rollback-Insert-appeal-conversion-records.sql",


Minor, the "I" would be lower case as in "Rollback-insert-appeal-conversion-records.sql".

andrewsignori-aot · 2026-03-11T18:11:26Z

...b-migrations/src/sql/DynamicFormConfigurations/Rollback-Insert-appeal-conversion-records.sql

@@ -0,0 +1,9 @@
+-- Remove configurations for the student current year income appeal form from the dynamic_form_configurations table.


Similar to https://github.com/bcgov/SIMS/pull/5874/changes#r2915675496

...es/packages/backend/workflow/src/workflow-definitions/load-assessment-consolidated-data.bpmn

andrewsignori-aot · 2026-03-11T18:15:29Z

...es/packages/backend/workflow/src/workflow-definitions/load-assessment-consolidated-data.bpmn

          <zeebe:header key="appealsRoomAndBoardCostsAppealData" value="appeals.roomandboardcostsappeal.submittedData" />
          <zeebe:header key="studentDataPartnerIsAbleToReport" value="data.partnerIsAbleToReport" />
-          <zeebe:header key="appealsStudentCurrentYearIncomeAppealData" value="appeals.studentcurrentyearincomeappeal.submittedData" />
+          <zeebe:header key="appealsStudentCurrentYearIncomeAppealData" value="appeals.studentcurrentyearincomeappeal.submittedData.{&#34;currentYearIncome&#34;: currentYearIncome}" />


The idea of mapping the submittedData instead of individual values for appeals was due to the fact that they could be extended and receive more properties, which, in the current way, would not require any change in the load consolidated data.
I would recommend keeping the existing pattern of assigning the submittedData and creating the variable inside the program year calculation.

Never mind, this is the approach to be followed.

andrewsignori-aot

Nice work, please take a look at the comments.

andrewsignori-aot

Great work, looks good 👍

…peal

sonarqubecloud · 2026-03-12T16:22:28Z

Quality Gate passed

Issues
0 New issues
1 Accepted issue

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

See analysis details on SonarQube Cloud

github-actions · 2026-03-12T16:22:39Z

Backend Unit Tests Coverage Report

Totals
Statements:	20.26% ( 4565 / 22529 )
Methods:	9.56% ( 262 / 2741 )
Lines:	24.58% ( 3917 / 15933 )
Branches:	10.01% ( 386 / 3855 )

github-actions · 2026-03-12T16:23:02Z

E2E Workflow Workers Coverage Report

Totals
Statements:	48.61% ( 2712 / 5579 )
Methods:	38.57% ( 285 / 739 )
Lines:	55.39% ( 2049 / 3699 )
Branches:	33.13% ( 378 / 1141 )

github-actions · 2026-03-12T16:26:04Z

E2E Queue Consumers Coverage Report

Totals
Statements:	79.6% ( 9155 / 11501 )
Methods:	78.79% ( 1181 / 1499 )
Lines:	82.83% ( 6881 / 8307 )
Branches:	64.48% ( 1093 / 1695 )

github-actions · 2026-03-12T16:27:58Z

E2E SIMS API Coverage Report

Totals
Statements:	64.42% ( 12611 / 19575 )
Methods:	60.52% ( 1464 / 2419 )
Lines:	68.18% ( 9208 / 13505 )
Branches:	53.11% ( 1939 / 3651 )

CarlyCotton and others added 3 commits March 10, 2026 09:33

Migration and form

9c57275

Merge branch 'main' into feature/#5588-student-current-year-income-ap…

4cf63cd

…peal

Migration update, assessment outcome and consolidated data change.

885383f

CarlyCotton self-assigned this Mar 11, 2026

CarlyCotton added DB DB migration involved Camunda Worflow Involves camunda workflow changes Form.io Form IO definitions changed. labels Mar 11, 2026

CarlyCotton marked this pull request as ready for review March 11, 2026 01:31

tiago-graf requested a review from Copilot March 11, 2026 03:37

Copilot started reviewing on behalf of tiago-graf March 11, 2026 03:37 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

andrewsignori-aot reviewed Mar 11, 2026

View reviewed changes

...es/packages/backend/workflow/src/workflow-definitions/load-assessment-consolidated-data.bpmn Show resolved Hide resolved

andrewsignori-aot reviewed Mar 11, 2026

View reviewed changes

tiago-graf self-requested a review March 11, 2026 19:46

andrewsignori-aot approved these changes Mar 11, 2026

View reviewed changes

CarlyCotton and others added 5 commits March 11, 2026 14:54

Fixing feedback

80df14f

Change so I can do the correct filename

6abfe01

Rollback sql filename change

7667965

Merge branch 'main' into feature/#5588-student-current-year-income-ap…

427fbf0

…peal

Updated wording for partner CY income description.

0ef426c

tiago-graf approved these changes Mar 12, 2026

View reviewed changes

CarlyCotton added this pull request to the merge queue Mar 12, 2026

Merged via the queue into main with commit 6a0fced Mar 12, 2026
22 checks passed

CarlyCotton deleted the feature/#5588-student-current-year-income-appeal branch March 12, 2026 16:29

CarlyCotton temporarily deployed to DEV March 12, 2026 16:34 — with GitHub Actions Inactive

CarlyCotton temporarily deployed to DEV March 12, 2026 16:37 — with GitHub Actions Inactive

	'Submit this appeal to provide your spouse/common-law partner\'' s current year income information IF they have experienced a significant CHANGE IN their financial circumstances since you submitted your Student Financial Aid Application.',
	'Submit this appeal to provide your spouse/common-law partner''s current year income information IF they have experienced a significant CHANGE IN their financial circumstances since you submitted your Student Financial Aid Application.',

		'If you have had exceptional expenses that created financial hardship that affected your ability TO START
		OR continue your studies these expenses may be considered AS part of your assessment.',

	"calculateValue": "// From the program year, get the calendar start year of the the program year.\r\n// e.g. program year = 2022-2023, calendar start year is 2022. And Current tax year should be 2022.\r\nconst [startYear] = data.programYear ? data.programYear.split(\"-\"):[];\r\nvalue = startYear;",
	"calculateValue": "// From the program year, get the calendar start year of the program year.\r\n// e.g. program year = 2022-2023, calendar start year is 2022. And Current tax year should be 2022.\r\nconst [startYear] = data.programYear ? data.programYear.split(\"-\"):[];\r\nvalue = startYear;",

		@@ -0,0 +1,36 @@
		-- Insert configurations for the student current year income appeal form into the dynamic_form_configurations table.

		@@ -0,0 +1,9 @@
		-- Remove configurations for the student current year income appeal form from the dynamic_form_configurations table.

Conversation

CarlyCotton commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Migrations

Consolidated Data

Student Current Year Income Form

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

andrewsignori-aot Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andrewsignori-aot Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot left a comment

Choose a reason for hiding this comment

Uh oh!

andrewsignori-aot left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Mar 12, 2026

Quality Gate passed

Uh oh!

github-actions bot commented Mar 12, 2026

Backend Unit Tests Coverage Report

Uh oh!

github-actions bot commented Mar 12, 2026

E2E Workflow Workers Coverage Report

Uh oh!

github-actions bot commented Mar 12, 2026

E2E Queue Consumers Coverage Report

Uh oh!

github-actions bot commented Mar 12, 2026

E2E SIMS API Coverage Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CarlyCotton commented Mar 10, 2026 •

edited

Loading