[Feature_F1_E1]- Toggle indicator to compare student group to state data

[shwndea]

Feature ID: [E1_F1]
Epic: Personalized CA Dashboard

flowchart TD
    %% Epic Node
    Epic["Epic: Personalized CA Dashboard(E1)"]

    %% Feature Nodes
    F1["Feature: Toggle indicator to compare group to state data(F1)"]
    F2["Feature: Provides Pre-intervention Warnings(F2)"]
 

    %% Connections
    Epic --> F1
    Epic --> F2


    %% Styling (Optional)
    style Epic fill:#f96,stroke:#333,stroke-width:2px
    style F1 fill:#6f9,stroke:#333,stroke-width:2px
    style F2 fill:#6f9,stroke:#333,stroke-width:2px

Loading

Definitions

• student_groups: The group of students are students present for the district/schools the user has access to. They are further categorized by racial/ethnic groups, low income-yes/low-income-no, English learners-yes/English learners-no, homeless-yes/homeless-no, foster youth-yes/foster youth-no, and students with disabilities-yes/students with disabilities-no.
• state_measure: Six state measures allow for comparisons of how schools and districts are servicing student_group:
  • Academic Performance
  • Chronic Absenteeism
  • College/Career Readiness
  • English Learner Progress
  • High School Graduation Rate
  • Suspension Rate
• _[Indicator]default_Indicator: the average of one of the six state measures that schools/districts are compared to. This represents the most current results of the state has reported out for that year.
• _[Indicator]default_indicator_category: For the 2023 Dashboard, schools and districts receive one of five performance levels for each eligible state measure except for College/Career Readiness. The performance levels are determined using current year and prior year data and are represented by a color ranging from Red to Blue. current year and prior year data and are represented by a color ranging from Red to Blue. Schools and districts with high school graduates will receive a Status Level (as shown in the image below), ranging from Very Low to Very High, for College/Career Readiness, which is reflective of what students achieved in high school up until the 2022–23 school year and does not compare against prior year data.
• _[Indicator]student_group_indicator : one of the six state measures that school are compared to. This represents the most current results fromthe students that user is associated with.
• _[Indicator]student_group_indicator_category: see [Indicator]default_indicator_category

Description:
When clicking on an indicator an event changes the barometer shown from group data ( group of students user has access to) to the state data.

• User Stories:
  • User Story 1: - Chief Of Staff to School Superintendent
  • User Story 2 - Brief description of the user story related to this feature.
  • User Story 3 - Brief description of the user story related to this feature.

Goals:

• [Goal 1: Store State Data already in Frontends Database]- Frontend Coding

  • Description: This goal involves ensuring that:

    • The _[Indicator]default_Indicator and _[Indicator]default_indicator_category data is properly stored and managed within the frontend application’s database.
    • The user's is associated with the right _[Indicator]student_group_indicator and _[Indicator]student_group_indicator_category
    • User can view the right _[Indicator]student_group_indicator and _[Indicator]student_group_indicator_category
    • User can Click a "View More Details" button to see the students that make up this result (see F2_E1).
    • Related Documents:
      • [Document 1:] Getting to Know the California School Dashboard
      • [Document 2:] How Colors are Determined
      • [Document 3] How to View Performance for a School or District on the 2023 Dashboard

  • Tasks:

    • T1_F1_E1-Implement a way to store what _[Indicator]default_Indicator has which _[Indicator]default_indicator_category.
    • T2_F1_E1-Tell admin the last time _[Indicator]default_Indicator and _[Indicator]default_indicator_category data was entered into the frontends database.
    • T3_F1_E1-Implement a way to track when the user makes an event to request to view _[Indicator]student_group_indicator and _[Indicator]student_group_indicator_category Key/Field
    • T4_F1_E1-Implement a way to check that the request to view _[Indicator]student_group_indicator and _[Indicator]student_group_indicator_category is from an authorized user
    • T5_F1_E1-Implement a way to retrieve data do display to authorize user
    • T6_F1_E1-Make Request from backend to ensure data consistency between frontend stored _[Indicator]default_Indicator and _[Indicator]default_indicator_category and backend _[Indicator]default_Indicator and _[Indicator]default_indicator_category.
    • T7_F1_E1-Keep a library of authorized users and there levels of access

  • Assumptions:

    • [Assumption 1]: Frontend & Backed knows what group_assocation the user has
    • [Assumption 2]: The Frontend & Backend can authorize users access
    • [Assumption 3]: The Frontend & Backend have most up to date information

  • Risks:

    • [Risk 1]: State Data not updated
      • [solution to R1_F1]: Validation Method
    • [Risk 2]: Unauthorized users access
      • [solution to R2_F1]: Validation Method
    • [Risk 3]: Wrong group_assocation
      • [solution to R3_F1]: Validation Method

  • Developer Team:

    • [Person 1: Role and Responsibilities]
    • [Person 2: Role and Responsibilities]
    • [Person 3: Role and Responsibilities]

  • React Components Involved:

    • Component 1: Brief description of the component.
    • Component 2: Brief description of the component.
    • Component 3: Brief description of the component.

  • React Dependencies:

    • [Dependency 1: Description and impact]
    • [Dependency 2: Description and impact]
    • [Dependency 3: Description and impact]

• [Goal 2: Request sent to Database_of_Truth] - Backend Coding

  • Description: This goal focuses on storing raw score data( local_data and state_data) and organizing it in a way that requests can be made to retrieve an authorized user local_data and state_data.
    • Tasks:

      • T8_F1_E1-Create a model class/a schema/ crud and routers to store the raw data it takes to calculate default_Indicator /default_indicator_category and [Indicator]student_group_indicator/[Indicator]student_group_indicator_category

      • T9_F1_E1-Create an API request that allows user to create update or delete default_Indicator /default_indicator_category and [Indicator]student_group_indicator/[Indicator]student_group_indicator_category via:

        • DB Initialization
        • CSV upload
        • JSON upload

      • T10_F1_E1-Create an API request that allows user to export [Indicator]default_Indicator /[Indicator]default_category and __[Indicator]student_group_indicator/_[Indicator]student_group_indicator_category via:

        • logging
        • CSV upload
        • JSON upload

      • T11_F1_E1-Tracks what IP addresses made the request using Celery & Redis

      • T12_F1_E1-Keep a library of authorized users and there levels of access

• Assumptions:

  • [Assumption 1]: User is aware to update the default_Indicator /default_indicator_category every year
  • [Assumption 2]: User has access to raw data fields to generate [Indicator]student_group_indicator/[Indicator]student_group_indicator_category values

• Risks:

  • [Risk 3]: default_Indicator /default_indicator_category outdated
    • [solution to R3_F1]: Validation Method
  • [Risk 4]: raw data fields to generate [Indicator]student_group_indicator/[Indicator]student_group_indicator_category values not available
    • [solution to R4_F1]: Validation Method

• Developer Team:

  • [Person 1: Role and Responsibilities]
  • [Person 2: Role and Responsibilities]
  • [Person 3: Role and Responsibilities]

• ** FastAPI Requests Involved:**

  • FastAPI Request1: Brief description of the component.
  • FastAPI Request2: Brief description of the component.
  • FastAPI Request3: Brief description of the component.

• Redis Requests Involved:

  • [Dependency 1: Description and impact]
  • [Dependency 2: Description and impact]
  • [Dependency 3: Description and impact]

• Celery Requests Involved:

  • [Dependency 1: Description and impact]
  • [Dependency 2: Description and impact]
  • [Dependency 3: Description and impact]

Created by: Shawn Dean
Date Created: [7/25/2024]

Last Updated by: [Your Name]
Date Last Updated: [Date]