Date: Fri, 29 Mar 2024 06:32:28 -0500 (CDT) Message-ID: <309036841.30336.1711711948153@PUBEDFIPRDWEB5.public.local> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_30335_1636075202.1711711948151" ------=_Part_30335_1636075202.1711711948151 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The Ed-Fi Dashboard Metrics are organized in a hierarchical structure ba= sed on Education Organization types (e.g., School, Local Education Agency).= The metrics can be managed via directly editing the Ed-Fi Co= re Dashboard Data Types Metric Metadata CSV files, but this can be= challenging and error-prone. The Metric Configuration Tool is a light= weight utility available to manage the logical hierarchy used by the Ed-Fi = Dashboards metrics. The tool can be used to review the core, as-shipped met= ric hierarchy and extend the core metrics by adding new metrics following t= he core extension principles.
Instructions for deploying this utility on a developer machine can be fo= und in the Metric Configuration Tool - Installation section of this docu= mentation.
The following concepts are useful to know before diving in:
With that out of the way, let's look at the tool itself.
The metric display in the Ed-Fi Dashboards are organized into a logical = hierarchy. This hierarchical organization is defined by metadata. The metad= ata is used to drive both the navigation menus and the metric content on th= e Dashboard pages. The dashboard interface is rendered by combining the das= hboard metric data calculated values with the hierarchal metadata into ASP.= NET MVC view model classes in the code.
The metric configuration tool handles three tasks: import, export, and e= dit of CSV files.
The import option allows user to upload their dashboard type CSV files. = The dashboard type files for a core dashboard implementation can be found i= n the Ed-Fi Dashboards repository.
The tool does not manage versioning or auditing of changes made to these= files but they have a profound impact on the system =E2=80=93 so we s= trongly recommended that these dashboard type files are checked in to sourc= e control before editing.
Once the files have been edited, we recommend you export the files, repl= ace the original files, and check the updated files into source control. Th= e ETL process will load the files into the metric metadata table and update= the UI rendering accordingly. For more details on this process, see the&nb= sp;Import Dashboard Types section of this documentation.<= /p>
The edit menu allows users to edit, add, and remove metrics. The section= s below describe the overall hierarchy and navigation options the tool offe= rs.
The as-shipped, core dashboards are based on a Local Education Agency &g= t; Schools > Student hierarchy. Depending on the role of the user, the l= anding page on the dashboards will be the Local Education Agency Overview (= for superintendents), the School Overview (for principals), or the School T= eacher View (for teachers). A Student Overview page is the most granular vi= ew.
The Local Education Agency, School, and Student metric types each contai= n a main metric category page. This view represents the tabs available in t= he dashboard for the hierarchy level you are in.
It is important to note that the available categories at the School leve= l might be different based on the school category. For example, the ca= tegory College and Career Readiness is available at the Local Education Age= ncy (District) level as shown in Figure 1, below. This category is also ava= ilable at the School High School category (Figure 2) =E2=80=93 but it = is not available at the School Elementary category (Figure 3) since metrics= in this category only apply to high school grade levels.
Each category of metric contains Aggregate, Container, and Granular metr= ics. In general, calculations are performed at the container and/or granula= r level. This is reflected in the metric configuration navigation.
Read more about the Metric Configuration Tool: