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

Bridge Expansion for SDPR API #4270

Open
58 tasks
CarlyCotton opened this issue Jan 21, 2025 · 3 comments
Open
58 tasks

Bridge Expansion for SDPR API #4270

CarlyCotton opened this issue Jan 21, 2025 · 3 comments
Assignees

Comments

@CarlyCotton
Copy link
Collaborator

CarlyCotton commented Jan 21, 2025

User Story
As a system, SIMS needs to be able to provide up to seven years of application data. This will include SFAS information and we need to include that in the current SFAS to SIMS bridge file.

Acceptance Criteria

  • SFAS to SIMS Bridge V2.3 DRAFT

  • New Record Types:

    • SFAS Applicant Dependant (302)
      • Unique Dependant Key
      • Unique Application Key
      • Dependent Name
      • Date of Birth
    • SFAS Disbursement Data (303)
      • Unique Disbursement Key
      • Unique Application Key
      • Funding type/Program code
      • Funding Amount
      • Funding Date
      • Date Issued
  • Additional Fields for Individual Records (200) at end of record

    • Initials
    • Address Line 1
    • Address Line 2
    • City
    • Province or State
    • Country
    • Phone Number
    • Postal or Zip Code
    • LMPT Award Amt
    • LMPU Award Amt
  • Additional Fields for Application Records (300) at end of record

    • Application No.
    • Living Arrangements
    • Marital Information
    • Date of Union
    • BC Residency flag
    • Permanent Residency flag
    • Gross Income for previous year
    • Institution Code
    • Status Code
    • Education Period Weeks
    • Course Load
    • Assessed Costs – Living Allowance
    • Assessed Costs – Extra Shelter
    • Assessed Costs – child care
    • Assessed Costs – Alimony
    • Assessed Costs – Local Trans
    • Assessed Costs – Return Trans
    • Assessed Costs – Tuition
    • Assessed Costs – Book/Supplies
    • Assessed Costs – Exceptional
    • Assessed Costs – other
    • Assessed Costs – discretionary
    • Withdrawal Date
    • Withdrawal Reason
    • Withdrawal Active Flag

Technical
Note: Currently for SFAS data import, every record type except header has a sims table where it is imported into.

  • The extension to the bridge must be implemented with backward compatibility. i.e. if none of the new records(record types) or new fields are missing in the sfas file, still the import must be happening in the same way as it happens today.
  • DB Migration to create new tables for record type 302 and 303. Table names could be sims.sfas_application_dependents(302) and sims.sfas_application_disbursements(303) and the related models.
  • DB migrations to add new columns to sims.sfas_individuals and sims.sfas_applications the related models. All the new fields must be nullable ensuring the backward compatibility.
  • Adapting the framework, create data-importers and related objects for new record types.
  • E2E Tests
    • E2E test for extended bridge.
    • Ensure the existing E2E tests are not breaking ensuring the backward compatibility.
@CarlyCotton CarlyCotton added Business Items under Business Consideration Integration labels Jan 21, 2025
@CarlyCotton CarlyCotton self-assigned this Jan 21, 2025
@CarlyCotton CarlyCotton added this to the Full-Time "Asset" milestone Jan 21, 2025
@dheepak-aot dheepak-aot self-assigned this Jan 22, 2025
@CarlyCotton
Copy link
Collaborator Author

@dheepak-aot Updated the file link and the ACs to show that SAIL app data records wont be changing and dependant data (302) / disbursement data (303) are now different.

@ninosamson ninosamson added Dev & Architecture Development and Architecture and removed Business Items under Business Consideration labels Jan 22, 2025
@dheepak-aot
Copy link
Collaborator

@CarlyCotton for the new record types, SFAS Applicant Dependant and SFAS Disbursement Data we must have it's own unique identifier to identify that particular record. image.png

@dheepak-aot dheepak-aot removed the Dev & Architecture Development and Architecture label Jan 23, 2025
@CarlyCotton
Copy link
Collaborator Author

@dheepak-aot Updated the ACs and attached the new V2.3 doc with unique keys.

github-merge-queue bot pushed a commit that referenced this issue Jan 29, 2025
# SFAS Bridge Data Expansion

## DB Migration
- [x] Added new table `sims.sfas_application_dependents` to import
Dependents data of SFAS applications.
- [x] Added new table `sims.sfas_application_disbursements` to import
Disbursements data of SFAS applications.
- [x] Added new columns `sims.sfas_individuals` to expand the existing
data.
- [x] Added new columns `sims.sfas_applications` to expand the existing
data.

## Following existing SFAS Tables
- [x] No foreign key constraints are enforced on the new tables
following existing SFAS tables.
- [x] Audit columns for new tables follow the same pattern as existing
SFAS tables.
- [x] In the new tables, except the primary key and `application_id` all
other fields are kept as nullable for the import to be more permissive
following the existing SFAS tables. This has been shared with business
as well.

## Rollback Evidence
- [x] SFAS Applications revert

![image](https://github.com/user-attachments/assets/3209831b-7a75-4408-a16d-00724b001b89)

- [x] SFAS Individuals Revert

![image](https://github.com/user-attachments/assets/04005e97-6983-4e5c-9d10-b501dfa46558)

- [x] SFAS Application disbursements Revert

![image](https://github.com/user-attachments/assets/f4f0c269-544b-42ab-bd17-84d7358b091a)

- [x] SFAS Application dependents Revert

![image](https://github.com/user-attachments/assets/dce566ea-ab9d-4a75-8615-9c4420c00a9a)
github-merge-queue bot pushed a commit that referenced this issue Feb 3, 2025
# Import of SFAS Application Dependants and SFAS Application
Disbursements

## Import

- [x] Added file record objects and import services for SFAS Application
Dependants and SFAS Application Disbursements.
- [x] Updated the existing logic to log process summary warning when the
record type is unknown instead of throwing error and aborting the
import(existing logic).

![image](https://github.com/user-attachments/assets/a193b6ac-f05d-4a35-b6ca-107a263df75e)


![image](https://github.com/user-attachments/assets/b0519feb-dc7c-41a6-8060-707f2b7b755a)


## E2E Tests
- [x] Added E2E tests for import of new record types.
- [x] Added E2E Test for logging process summary warning on unknown
record type in the file.


![image](https://github.com/user-attachments/assets/52775754-2f6a-4188-b924-5758c8ff7279)


## Launch File Update
- Launch file updated to include the directory as well in the pattern
while running current test file.
dheepak-aot added a commit that referenced this issue Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants