Program Year Setup - bcgov/SIMS GitHub Wiki
What is it?
Every year there is a need to enable Student Applications to be submitted to a new Ministry Program Year (August 1st, 2021 till July 31st, 2022). Below is the sequence of steps required to create the baseline for a new program year based on the previous program year. The example below will assume that the current program year is 2023-2024 and the new 2024-2025 will be enabled.
Duplicate BPMN files from the previous year and adjust them
- Copy
fulltime-assessment-2023-2024.bpmn
and rename it asfulltime-assessment-2024-2025.bpmn
. - Copy
parttime-assessment-2023-2024.bpmn
and rename it asparttime-assessment-2024-2025.bpmn
. - Ensure to update the internal variable names previously referencing the source year (
name
,processRef
, andid
) on the above BPMNs. Please see the example below.
Add new 2024-2025 Values in the DMN tables (copy existing 2023-2024 values)
- Open the file
fulltime-assessment-decisions.dmn
and for every program year-related condition entry a new one for the new program year. - Repeat the same for the
parttime-assessment-decisions.dmn
.
For instance, in the below DMN, the last two rows were duplicated from the previous year. The tool allows copy and paste the entire rows, no need to copy the values of the individual columns.
Copy and rename the below form.io definitions
sfaa2023-24.json
tosfaa2024-25.json
.supportingusersparent2022-2023.json
tosupportingusersparent2024-2025.json
.supportinguserspartner2022-2023.json
tosupportinguserspartner2024-2025.json
.- Update the name and path to reflect the new program year in the above forms, as shown below.
Create the new program year entry in DB
Create a migration to insert the new Program Year record in sims.program_years
.
- program_year: 2024-2025
- program_year_desc: Study starting between August 01, 2024 and July 31, 2025
- form_name: SFAA2024-25
- is_active: true
- start_date: 2024-08-01
- end_date: 2025-07-31
- parent_form_name: supportingusersparent2024-2025
- partner_form_name: supportinguserspartner2024-2025
- program_year_prefix: 2024
- max_lifetime_bc_loan_amount: 50000
Create a new suite of E2E tests for the new program year
- Duplicate the folder from sources\packages\backend\workflow\test\2023-2024 and rename it to 2024-2025.
- Update the const under sources\packages\backend\workflow\test\2024-2025\constants\program-year.constants.ts to 2024-2025
- Ensure that all tests are passing for the new program year.
- Ensure new student applications can be submitted selecting the new program year and has its NOA generated.
- Ensure supporting users can submit information for a new Student Application created for the new program year.