Skip to content

Latest commit

 

History

History
236 lines (204 loc) · 13.5 KB

CHANGELOG.md

File metadata and controls

236 lines (204 loc) · 13.5 KB

Unreleased

New features

Under the hood

Fixes

edu_wh v0.4.0

New features

  • Add array column cohort_year_array to dim_student, tracking student cohort designation, and add upstream bld_ef3__student_cohort_years
  • Add support for custom indicators on dim_course_section, and companion audit table for testing uniqueness of custom data sources
  • Add section_type descriptor column to dim_section (Ed-Fi Data Standard v5.0 addition)
  • Add preferred_first_name, preferred_last_name, and gender_identity columns to dim_staff (Ed-Fi Data Standard v5.0 additions)
  • Add preferred_first_name, preferred_last_name, and gender_identity columns to dim_parent (Ed-Fi Data Standard v5.0 additions)

Under the hood

  • Change the source of dim_parent to stg_ef3__contacts and fct_student_parent_association to stg_ef3__student_contact_associations due to the rename from parent to contact in Ed-Fi data standard v5.0.
  • Add additional foreign key declarations to fct_student_discipline_actions, fct_student_discipline_actions_summary, fct_student_discipline_incident_behaviors
  • Update package dependency dbt_utils to 1.3.0, including alignment to renamed generate_surrogate_key() macro. Note, this change now treats nulls and empty strings as distinct values in surrogate key generation.

Fixes

  • Fix model name in yaml documentation file for dim_graduation_plan
  • Fix unique key test for recently changed unique key fo fct_student_school_attendance_event

edu_wh v0.3.4

Fixes

  • Fix bld_ef3__wide_school_network_assoc to group across years, to correctly remove duplicates on k_school. Previously, incorrect duplicate records were created in dim_school in cases where multiple network types are configured in xwalk_network_association_types.

edu_wh v0.3.3

New features

  • Add fct_student_diploma and a companion test for monitoring deduplicated data - diploma_record_duplicates
  • Add dim_graduation_plan and reference via fct_student_school_association.k_graduation_plan
  • Add some notes to dbt docs for fct_student_special_education_program_association and fct_student_section_association
  • Add v_earned_additional_credits to fct_course_transcript

Fixes

  • Modify the join in bld_ef3__stu_race_ethnicity so that students with unknown race are included and {{ var("edu:stu_demos:race_unknown_code") }} is correctly applied

Under the hood

  • Rework and rename pivot macro to ea_pivot() to simplify usage
  • Add k_lea and k_school to dim_course. Note - downstream queries that reference k_lea or k_school without an explicit qualified column reference may break due to this change.
  • Add macro call that brings through extensions to all fct tables that directly reference a stg table. See here for example.
    • Note: this may break in certain edge cases, if your implementation has existing configured extensions whose names collide with column names that already exist in the related fct table. This should be rare.
  • Add extension columns (optional, if configured) to all fct tables. If no extensions configured, this code compiles to nothing.

edu_wh v0.3.2

New features

  • Add has_hispanic_latino_ethnicity to dim_student. Also include in this in fields that are "immutable" (consistent across years), assuming variable edu:stu_demos:make_demos_immutable is set to True.
  • Add configurable student language columns to dim_student.
  • Add configurable custom override for student grade level (some source other than student-school-assoc in Ed-Fi). Use variable edu:stu_demos:grade_level_override to configure a data source and column.
  • Add configurable logic for override of school_year in fct_student_assessment and fct_student_objective_assessment (e.g. if NULL, use thresholds to populate). By default, no override is done, but options were added to use a global variable edu:school_year:start_month, edu:school_year:start_day, or use a xwalk of date ranges xwalk_assessment_school_year_dates.
  • Make stu_display_name configurable (e.g. include suffix or preferred_name)

Under the hood

  • Correct dbt docs for unique key of fct_student_daily_attendance.
  • Add k_school to grain of qc model attendance_freshness.
    • Also restrict attendance_freshness model to current or past dates
    • And add column days_since_last_attendance_event to attednance_freshness_test

Fixes

  • Remove is_latest_record from auto-creation of subgroups for dim_subgroup and fct_student_subgroup.

edu_wh v0.3.1

New features

  • Add dim_staff.race_ethnicity, using rules analogous to dim_student.race_ethnicity

edu_wh v0.3.0

New features

  • Standardize ESC naming and add k_esc reference to dim_lea
  • Add integer grade level to dim_student and fct_student_school_association
  • Add k_student_xyear to fct_student_assessment, fct_course_transcripts, fct_student_academic_record, and fct_student_gpa.
  • Discipline updates:
    • Add ability to report all disciplines/behaviors for a single discipline action event and all disciplines/behaviors for a single discipline incident in new, separated models.
    • See more info in PR description #75
  • Add some comments for existing value tests
  • Add feature to conditionally remove xyear enrollments in fct_student_school_association

Under the hood

  • Make k_student null where not joinable to dim_student, for fct_student_assessment, fct_course_transcripts, fct_student_academic_record, and fct_student_gpa.

Fixes

  • Fix unique key of fct_student_school_attendance_event and fct_student_section_attendance_event to reflect unique key in Ed-Fi.
    • Note: The unique key of fct_student_daily_attendance remains the same (k_student, k_school, calendar_date). But the way we deduplicate to this point has changed to be more consistent
    • The scale of impact of this fix depends on how often duplicates are found on (k_student, k_school, calendar_date) in the underlying data. See new test analytics.prod_dbt_test__audit.attendance_event_duplicates for more information.

Migration

  • Update packages.yml version range for edu_wh to [ ">=0.3.0", "<0.4.0" ]
  • Configure xwalk_grade_levels. Can copy directly from project template here, but also check your implementation's grade level descriptors select * from analytics.prod_stage.int_ef3__deduped_descriptors where namespace ilike '%GradeLevelDescriptor%';. If this shows custom/local descriptors, make sure to add those to the xwalk.
    • After running the xwalk, you can also do a check for missing values with select * from analytics.prod_wh.dim_student where grade_level_integer is null;
  • (requires Snowflake sysadmin or transformer_prod permissions) Drop the following deprecated tables:
    • analytics.prod_wh.dim_education_service_center
    • analytics.prod_wh.dim_discipline_incidents
    • analytics.prod_wh.fct_student_discipline_incident_behaviors_actions

edu_wh v0.2.10

Fixes

  • Bugfix release

edu_wh v0.2.9

New features

  • Add ability to extend dim_course and dim_class_period with external data sources
  • Add an is_latest_record indicator to dim_student to identify the demographics from the most recent school year in which a student appeared

Under the hood

  • In dim_student, choose the grade level from the most recent school enrollment, rather than the longest duration. This better aligns with grade transition patterns seen in the wild.
  • Deprecate the rls schema in favor of extensions that cover this use-case

edu_wh v0.2.8

New features

  • Add dim_learning_standard and fct_student_learning_standard_grades
    • For Learning Standard based grading, and for future support of learning standards in other areas of the warehouse
  • Add dim_cohort and fct_student_cohort_association
    • Not widely in use, but intended to support more complex authorization models in the future

Under the hood

  • Allow overriding the source of daily attendance models, for more complex customizations of the daily attendance calculation

edu_wh v0.2.7

New features

  • Add incident_time to dim_discipline_incidents
  • Allow some student demographics to be 'immutable', in the sense that they are stable across time
  • Allow custom indicators on program memberships

Under the hood

  • Make it optional to exclude student-school enrollments where the student exited before the first day of school
  • Allow a rule where multiple calendar codes must be assigned to a date for it to be counted as a school day

edu_wh v0.2.6

New features

  • Add primary disability on student special education program associations
  • Documentation improvements

edu_wh v0.2.5

New features

  • Create wide indicators from course/section characteristics in dim_course_section

Under the hood

  • Add defaults for discipline non-offender codes
  • Minor tweaks to documentation, configuration
  • Allow assessment results to come through even if they don't match a xwalk entry
  • Add k_school to more models
  • Add configuration to customize the preferred email address for staff
  • Restrict the relationships between tenant and LEAs/schools

edu_wh v0.2.4

New features

  • New models covering the relationship between discipline incidents, actions, and behaviors
  • Extend documentation coverage

Under the hood

  • accordion_columns gains ability to coalesce null values with a default
  • Fill False instead of NULL in some student demographics

Migration

  • Configure non-offender codes. This allows for navigating the Ed-Fi deprecation of the old student discipline model. The new model separates offenders from non-offendors, and this config allows us to apply the same logic to the now-deprecated model. Any DisciplineIncidentParticipationCodeDescriptors in use in studentDisciplineIncidentAssociations that refer to non-offenders should be included in this list. See here
  • New crosswalk for ranking the severity of Behaviors (template here). This facilitates the analysis of incidents involving multiple behaviors.
  • fct_discipline_actions has been renamed to fct_student_discipline_actions. Any references to this model will need to be updated.

edu_wh v0.2.3

New features

  • Add models for education service centers
  • Add support for custom indicators on dim_school
  • More support for generic student programs

Under the hood

  • More robust creation of first/last day of school table for calendaring/enrollment logic
  • Generate foreign keys on optional school-network associations for BI tools

Fixes

  • Implement "first day school" rule for single-calendar schools in fct_student_school_association
  • Allow extension columns to correctly be pulled into the stacked fct_program_service table
  • Fix join between staff assignments and staff-school associations

edu_wh v0.2.2

Fixes

  • Bugfix release: package specification

edu_wh v0.2.1

New features

  • Add fact table for student GPAs
  • Add additional program-type fact tables
  • Add configurable program parsing to dim_student
  • Add combined program services table

Under the hood

  • Add minimum dbt version requirement
  • Switch to ranged version pin for edu_edfi_source

edu_wh v0.2.0

New features

  • Add optional domain disabling to all non-core models, using vars in dbt_project.yml.
  • Remove student_school_associations with invalid dates, such as withdraw dates before the first day of school, or before the entry date
  • Add audit table to capture all invalid school enrollments
  • Rework daily attendance model
    • Allow for fractional attendance by changing indicators from bools to floats
    • Roll attendance rates for exited students forward to the end of the year so that chronic absenteeism metrics can include exited students in daily calculations
    • Required Migration: Convert T/F values in xwalk_attendance_events to 1.0/0.0

Under the hood

  • Add a single model properties file under each subdirectory, as per DBT recommendation.

edu_wh v0.1.4

Under the hood

  • Change absenteeism metric boundaries to better match common business rules

Fixes

  • Improve whitespace handling and macro robustness for empty crosswalks

edu_wh v0.1.3

New features

  • Warehouse models for parents and student-parent linkage

Fixes

  • Bump edu_edfi_source version

edu_wh v0.1.2

Under the hood

  • Bump edu_edfi_source version

edu_wh v0.1.1

New features

  • Added parsing for studentEducationOrganizationAssociation.indicators in dim_student
    • Allows arbitrary student indicators to be mapped into dim_student columns via a xwalk in the project template
  • Fact and dimension tables for assessments
    • Preserves all score results and performance levels, while allowing a customizable set to be pulled out as columns
  • Added student ids to dim_student
  • Fixed typo regarding Chronic Absenteeism buckets
  • Add program services

Under the hood

  • Changed chronic absenteeism threshold to be inclusive to better align with common standards
  • Added more columns to attendance tables from source data
  • Improved handling of extensible column-sets, such that all are optional
    • Added macro accordion_columns to help with these cases

Fixes

  • Fixed chronic absenteeism labeling issue

edu_wh v0.1.0

Initial release