This documentation provides you a step by step process of generating default reports using the starter kit base image.
Initially when you login to the VM, you can see Reports folder on the desktop. Inside the folder, there are five pre-generated excel report files for the following use cases:
1. SEA Starter Kit - Membership = Student Count in NE Use Case
- Membership By Grade, Race and Gender (MembershipCountByGradeRaceGenderReport.xlsx)
- County Membership by Grade (MembershipCountByGradeReport.xlsx)
2. SEA Starter Kit - Special Education Student Count Use Case
- Special Education Report By Age (SpecialEducationByAgeReport.xlsx)
- Special Education Report By Disability (SpecialEducationPrimaryDisabilityReport.xlsx)
- Special Education Report By Special Education Setting (SpecialEducationSettingReport.xlsx)
Database
The reports are basically generated using the student data available in the EdFi_Ods_2022 database. Below stored procedures are used to insert data to report tables in the database
- reporting.LoadStudentFallMembership - inserts data into reporting.StudentFallMembership table
- reporting.LoadSpedChildCount - inserts data into reporting.SpecialEducationChildCount table
You can find the database tables and stored procedures by following the below steps:
Step 1. Open Microsoft SQL Server Management Studio as Administrator using Windows search box with "ssms" keyword.
Step 2. With Windows Authentication selected, click Connect.
Step 3. After connection, you will see EdFi_Admin, EdFi_Security and EdFi_Ods database for school year 2021 in the Object explorer.
Step 4. Under EdFi_Ods_2022 database, you can find the report tables under reporting schema.
Step 5. You can also find the stored procedures under reporting schema.
Generate Reports
There are separate SQL scripts to generate each report once we have data in the reporting tables by running the above stored procedures mentioned. These SQL scripts can be found under C:\Ed-Fi-Starter-Kit\ReportGenerationScripts folder.
Whenever there is an update in the student data, we can generate updated reports by running the PowerShell script report.ps1 located under same folder. The script performs all the task to generate reports by executing the above stored procedures which inserts data into report tables, executes the SQL scripts present in C:\Ed-Fi-Starter-Kit\ReportGenerationScripts folder and updates the XLSX files inside Reports folder in desktop. You can follow below steps to run PowerShell script.
Step 1. Open Windows PowerShell as Administrator using Windows search box with "powershell" keyword.
Step 2. Run below command in powershell to navigate the ReportGenerationScripts folder
cd C:\Ed-Fi-Starter-Kit\ReportGenerationScripts
Step 3. Run below command in powershell to generate the updated reports
.\report.ps1