Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Partner Current year income application question #3615

Closed
27 tasks done
Joshua-Lakusta opened this issue Aug 7, 2024 · 2 comments
Closed
27 tasks done

Partner Current year income application question #3615

Joshua-Lakusta opened this issue Aug 7, 2024 · 2 comments
Assignees
Labels
Student Student Features User Story

Comments

@Joshua-Lakusta
Copy link
Collaborator

Joshua-Lakusta commented Aug 7, 2024

As a student I want to be able to submit my application with my partners current year income through an exception path question. The question needs to be post the BCSC question but modify the outcomes as sub question. This is important so that students can receive their correct assessment.

This is linked to the change request built in ticket #3620

Acceptance Criteria

Application Changes

New partner BCSC question process

  • Add a sub question after partner BCSC question on the partner tab. This question will always be asked regardless of the answer to yes or no for BCSC. It should always appear anytime the partner tab appears and the two questions together will determine what happens next for the application logic(see image below of branching paths)
  • Question can be embedded under the current question for BCSC as per this image

image.png

  • Content for new question

Do you want to declare your spouse/common-law partner's estimated current year income? (If your spouse/common-law partner has had, or anticipates having a significant decrease in income for "YEAR", you may request to be assessed using your spouse/common-law partners estimated income.)

  • Replace "YEAR" with dynamic calculation YEAR = first year in program year (2023-2024 would be 2023)

  • 2 radio option outcomes for this question as yes or no

  • If the answer is no then follow previous processes partner portal banner if they selected yes to BCSC or self declare path if the stated no to BCSC

  • If they answer "yes" to the new question it should take them to a new self declare path that has the estimated current year income question replacing the normal income field question.

  • Answering yes will hide the tax return income input

  • The banners attached to the BCSC question must be delayed until both questions have been completed and the path forward is decided.

See image for baseline logic for pathing not for use in work flows just showing the logic
image.png

Modified self declare path

  • Answering yes to the new question opens a modified self declare path that will add the new additional estimated partner current year income exception field and support fields (this will mirror the question from the change request version in ticket Change Request - Partner Current Year Income (financial information) option #3620)
  • Do not show "i have been authorized" check box and content when Yes is selected for the new question

image.png

  • New path will be an exception path question and will trigger new exception
  • Please make these changes to both FT and PT. For full time we will just be creating the new current year income path and it will mirror the PT version. Additional work will be completed in another ticket to flesh out the content for full time.
  • Change content at point Lets use common phrasing #1 in image below to (Change this for both the new path and the normal self declare path)

Partner financial information

  • Change the content for point 2 to the following

image.png

  • The following income should be above the current year income field connected to the new data form

Add your spouse/common-law partner's actual income from the beginning of YEAR up to the date their income change, along with the estimated income for the remainder of the year, to calculate their total estimate income for the current year.

  • Replace "YEAR" with dynamic calculation YEAR = first year in program year (2023-2024 would be 2023)

  • Add income entry field that will represent a new value to be created and named by dev doing the ticket (partnerestimatedincome)

  • Income field should follow the same rules as the estimated student income version

  • Heading above the income entry field should state: point Add missing compliance audit file #4

My spouse/common-law partner's estimated current year income is:

image.png

  • There needs to be a section for the reasons for change in estimated income with five options and only one can be selected

Content:

Select the reason for your spouse/common-law partners significant decrease in income.

  • Medical illness or injury
  • Family emergency (e.g., death or injury)
  • Natural Disaster
  • Layoff, strike, lockout or other reduction in earnings beyond the family's control
  • Other
  • Add content for uploader content for documentation for uploader:

Upload supporting documents for spouse/common-law partners "dynamic year (app program year - 1 (2024-2025 would be 2024))" estimated income.
Please provide supporting documentation for your request to use current year estimated income for your spouse/common law partner.
Provide the following:

A letter explaining the circumstances that meet one or more of the Criteria (see above)
Provide at least one of the following:

All relevant supporting documentation of the circumstance(s) (medical records, letter from the physician, record of employment, layoff or strike, invoices from damages, etc.).
The more recent CRA Income Tax Return and income information for the year matching the student financial assistance application number (with relevant supporting documentation to show the decrease in income), if available.
All relevant supporting documentation of estimated total income for the year matching the student financial assistance application number, if applicable (pay stubs, invoices, bank statements, Employment Insurance benefit statements, Record of Employment, etc.).


Calculation Updates

  • The new question will replace the base partner income question on this current year estimated income path
  • This new income will be set above all other incomes in the priority list (same as student estimated current year income) and will require a new variable to reflect this amount in Camunda. (similar to process completed for student estimated current year income)
    Update calculations

Current

if
  partner1CRAReportedIncome = null
then
  calculatedDataPartner1TotalIncome
else
  partner1CRAReportedIncome

if 
  studentdatacurrentyearpartnerincome = null  (This is a suggested name for the value)
then
    if
        partner1CRAReportedIncome = null
    then
        calculatedDataPartner1TotalIncome
    else
  partner1CRAReportedIncome
else
   studentdatacurrentyearpartnerincome
  • This field will need to be updated based on the changes from the change request ticket as well as making sure we update the priority list to include the new value whatever it is named

image.png

Ministry exception update

  • Add "Partner current year income" to the list {data.exceptionNames.length} and show to ministry user when this exception is pending ministry action.

image.png

Technical

  • Adjust assessment-gateway to prevent supporting user creation, as shown in the below image. Adjust the label to reflect the most recent logic.

image.png

- [x] Exception creation is handled dynamically. Ask for help if you have never done it before. - [x] No `fulltime-assessment-*` workflow changes are expected now. - [x] Workflow E2E tests.
@Joshua-Lakusta Joshua-Lakusta added Business Items under Business Consideration Student Student Features User Story labels Aug 7, 2024
@ninosamson ninosamson changed the title Partner Current year income application question [NEEDS ATTENTION] Partner Current year income application question Aug 27, 2024
@Joshua-Lakusta Joshua-Lakusta changed the title [NEEDS ATTENTION] Partner Current year income application question Partner Current year income application question Oct 8, 2024
@JerPearson JerPearson added Dev & Architecture Development and Architecture and removed Business Items under Business Consideration labels Oct 15, 2024
@andrewsignori-aot andrewsignori-aot removed the Dev & Architecture Development and Architecture label Oct 17, 2024
@Joshua-Lakusta
Copy link
Collaborator Author

Updated AC's around the UI after discussion with Dheepak

github-merge-queue bot pushed a commit that referenced this issue Nov 13, 2024
# Student Application - Partner current year income

## Student application form update

- [x] The form input `IsYourPartnerAbleToReport` which was coming from
BCSC question is now converted to a form.io calculated variable which
returns `true | false` instead of `"yes" | "no"`.

- [x] Added a question to enable the current year partner income
submission in the partner information panel. The question blurb consists
of the `dynamic current year`


![image](https://github.com/user-attachments/assets/7e1c74f4-1958-4e8f-8381-1146e2a63e3d)

- [x] The info and warning banners are delayed until both BCSC and
Current year income questions are answered.


![image](https://github.com/user-attachments/assets/9b5a30da-ea26-467d-ac17-38df278785d2)

- [x] When the question for current year income is answered as `Yes`
show the current year income question with options and file upload
instead of current tax return income.


![image](https://github.com/user-attachments/assets/8d178cfb-f1a3-46b4-8684-d77615599448)

- [x] When student enters the current year income for the partner
instead of the current tax return income, then choose the self
declaration path with exception instead of supporting user input even if
the partner is eligible for BC Services Card.


![image](https://github.com/user-attachments/assets/9d8f3636-dc94-4681-9186-79e0081d5a99)


![image](https://github.com/user-attachments/assets/c1a9f449-0013-4311-9cee-891ffa19ac1b)


![image](https://github.com/user-attachments/assets/cc08d1fa-c073-4ddb-987e-df7fc23d066d)


![image](https://github.com/user-attachments/assets/f1f688f2-b541-4c1b-a4ae-ed72d7001e4c)


![image](https://github.com/user-attachments/assets/67711182-4e3c-43d2-ad8a-463eff5df067)


## Content Updates

- [x] The content (header and the blurb) updated for the previously
called `Partner Income` section.

![image](https://github.com/user-attachments/assets/7ac2bc9d-30b4-4b98-8bb6-d7d1599927c8)

## Assessment gateway updates

- [x] Minor update to `assessment-gateway` and `fulltime-assessment-*`
to use the input `IsYourPartnerAbleToReport` to evaluate `true | false`
instead of `"yes" | "no"`

## Workflow E2E test updates
- [x] Changed the data type of `studentDataIsYourPartnerAbleToReport` to
boolean from YesNo.

## Upcoming PR

- `part-time-assessment-*` changes
- Workflow E2E tests.
github-merge-queue bot pushed a commit that referenced this issue Nov 14, 2024
…ts (#3934)

## Partner current year income - Assessment workflow

- [x] Updated the `load-assessment-consolidated-data` to return
`studentDataCurrentYearPartnerIncome` based on the student input from
formio.
- [x] In `parttime-assessment-*.bpmn` updated the application data path
of `partner information and income` to set
`calculatedDataCurrentYearPartnerIncome` based on student input from
formio.


![image](https://github.com/user-attachments/assets/ad9156e0-186f-4263-a742-0f106c3147ad)

## E2E Tests

- [x] Added E2E tests for following scenarios.
1. Partner reporting their tax return income and no current year income
was reported.
2. Student reporting partner's current year income through the new self
reporting path.
3. Student reporting partner's tax return income through the existing
self reporting path.


![image](https://github.com/user-attachments/assets/29e520f4-93aa-40cc-83fa-998b2f816545)

## New Test Suite

- New test suite is added to the `costs` section in the
`parttime-assessment` of E2E tests. This was done considering that the
tests under `costs` are expected to validate the costs/expenses/other
inputs like income which are the major inputs towards the awards
calculation. Please suggest if the test suite doesn't fit under `costs`.


![image](https://github.com/user-attachments/assets/da1217f7-5cc3-40ca-b617-b50481158f5f)
github-merge-queue bot pushed a commit that referenced this issue Nov 14, 2024
@dheepak-aot
Copy link
Collaborator

@Joshua-Lakusta as discussed, if a FT application is submitted with student having a partner and student reporting partner's current year income, then this specific scenario breaks the fulltime-assessment workflow as fulltime assessment workflow is not updated to choose current year income over the tax return income.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Student Student Features User Story
Projects
None yet
Development

No branches or pull requests

7 participants