Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

This documentation provides a step-by-step guide to generating default reports using the starter kit base image.

When you log in to the VM, you should see a Reports folder on the desktop. Inside that folder are five pre-generated Excel report files covering 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 generated using the student data available in the EdFi_Ods_2022 database. The stored procedures shown below are used to insert data into report tables in the database.

  1. reporting.LoadStudentFallMembership - inserts data into reporting.StudentFallMembership table.
  2. 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. Using Windows Authentication, 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. Expand the EdFi_Ods_2022 database to find the reporting tables under reporting schema.

Step 5. Run the stored procedures, also found under reporting schema, to populate the reporting tables. 

Generate Reports

Now that the reporting tables have been populated using the above stored procedures you can use the provided SQL scripts to generate each report.  These SQL scripts can be found under C:\Ed-Fi-Starter-Kit\ReportGenerationScripts folder.

Whenever there is an update in the student data, updated reports can be generated by running the PowerShell script report.ps1 located in the same folder. The script performs all the tasks required to generate these reports from executing the stored procedures to insert data into the reporting tables as well as executing all the SQL scripts found in C:\Ed-Fi-Starter-Kit\ReportGenerationScripts folder. Additionally, it updates the XLSX files inside Reports folder on the desktop. Follow the steps below to run the PowerShell script.

Step 1. Open Windows PowerShell as Administrator using Windows search box with "powershell" keyword.

Step 2. Run the command below in PowerShell to navigate to the ReportGenerationScripts folder

cd C:\Ed-Fi-Starter-Kit\ReportGenerationScripts

Step 3. Then run the following command in PowerShell to generate the updated reports

.\report.ps1



  • No labels