This version of the Ed-Fi Dashboards is no longer supported. See the Ed-Fi Technology Version Index for a link to the latest version.
Configurable List Metadata for Ed-Fi Dashboards
- Kistel Hazel
- Chris Moffatt (Deactivated)
Overview
Ed-Fi Dashboards v1.3.1 included an update that moves the definitions of the Metadata List Ids (a set of application specific integer constants) from the code (MetadataListIdResolver class) into the database (Metric.MetadataList table which is accessed by the DatabaseListMetadataProvider class). Each Metadata List Id identifies a specific set of entities (such as Students, Teachers, or Staff) and metric columns (like Grade Level, Absences, or Failing Grades) used to make up a particular List (e.g., General Overview, Subject Specific, Student Demographic) that is displayed in the Ed-Fi Dashboard UI.
A snippet of the database is shown below:
The List Metadata Provider uses this Metadata List Id to retrieve a description of the columns to be displayed by the List, and that description is used by the calling service to build and return the actual List.
This change allows new list types to be configured simply by adding records to the metric.MetadataList, metric.MetadataListColumnGroup, and metric.MetadataListColumn tables.
As an example of how this appears on the dashboard UI, the following screen capture shows StudentDrilldownHighShool dashboard view powered by the metadata:
Database scripts
Scripts used the add the tables to the Ed-Fi Operational Data Store can be found:
Dashboard DB: 0009-Create Metadata List Tables.sql