This guide illustrates how to use the Metric Configuration Tool to add new metrics to the metric metadata. The exercise walks through adding a new High School Transportation metric as an example. This is a precursor step to writing metric calculation code (which is covered in detail in the ETL Developers' Guide - Coding section).
It is recommended that the latest Dashboard Types CSV files get imported before editing. The metric configuration tool assumes the file versioning is managed via source control and checked in after every edit.
A high-level overview of the steps is as follows:
Each step is described in detail, below.
Start by importing (i.e., uploading) the existing Dashboard Type CSV files. Worth noting is that all files must be imported as there are interdependencies between files, and the file names must match the original file names in the as-shipped code.
Now we'll add a new granular metric as a child of the Transportation Method Rate we just created.
At this point, you should have a new "To and From School Transportation Method" metric. You'll see a screen that looks something like this:
An optional step is to add prior year metrics. When added, prior year metrics allow the dashboard to show/hide the value recorded as part of Creating a Year-End Snapshot for the previous year. Because this is a special type of metric that follows a convention, the tool configures this when created via the UI.
Exporting the updated files is easy:
Replace the Dashboard Types files under theEd-Fi/Etl/src/EdFi.Runtime/Reading/Queries/3.1/DashboardTypes/. The updated files should be picked up on the next ETL run and the dashboard should reflect the new transportation metrics (though without calculations at this point).