Starter Kit Specific Reference
- Chris Moffatt (Deactivated)
- Steven Arnold
- Ian Christopher (Deactivated)
Family Engagement Starter Kit
In addition to the general skills, technologies and team members listed here, the following components are required or installed in order to work with the Family Engagement Starter Kit:
Server Specifications
- A machine or virtual machine with internet access.
- 50GB free storage space.
- 4GB+ of available RAM.
- Windows Server 2019.
- Administrator access to physical machine or virtual machine.
Software Installed
Windows Components
- Microsoft IIS v10 (Internet Information Services web server platform, current version 10+ in Windows 2016-2019)
- URL-Rewite module for IIS
- SSL Certificate
- Auto install with self-signed and Let’sEncrypt for DNS
- Microsoft .NET 4.7+ and .NET Core 2+
Microsoft SQL Server
- SQL Server Express 2019 is auto-installed or choose your own edition v2017+
Optional: MS SQL Server Management Studio
Tools
- Chocolatey (Package Manager)
- Git for Windows (Solution Code Manager)
- Visual Studio 2019 Community Edition or higher (https://visualstudio.microsoft.com/downloads/)
- Modern browser (Microsoft Edge or Google Chrome)
Ed-Fi Technology Suite 3
- ODS / API Suite 3, version 5.1.0
- Ed-Fi Admin App 2.2.0
Suggested Team Member Involvement
The deployment, configuration, and use of the District-focused starter kits typically involves staff members in these roles in a school district. We recommend involving staff members in at least these roles (or their equivalent in your district) and for these types of responsibilities in order to create a solution team that can support a broad-based, shared understanding of what the solution is and how it works; as well as to position yourself to plan an effective production rollout to your key users.
| Team Member Role | Responsibilities |
|---|---|
Program and Data Leads: Central office departments like Accountability or Learning & Teaching | Person responsible for data use and reporting, often for assessment and accountability purposes |
| Communication Leads: Central Office communications staff | Person responsible for conveying information to parents, guardians, and caretakers of the students in the district |
Campus Leads | A campus principal or assistant principal, especially from a secondary school (middle or high school) |
IT Leads:
|
|
Family Engagement Portal Data Requirements and Data Loading Priorities
This section describes the minimum and full data requirements necessary to power the Family Engagement Portal.
It is important to follow the Ed-Fi Certification Scripts. These give the basic relational order in which the data must be loaded. See Ed-Fi Student Information Systems API for Suite 3 Certification for details.
At a high level, the following domains are required:
- Local Education Agency
- Schools
- Sessions
- Parents
- Staff
- Section
- Students
- Course Catalog
- Transcript
- Grades
- Assessments
Minimum Data Requirements for the Family Engagement Portal
Note that these minimum requirements enable parents to be able to login to the application and see basic information about their student, such as: Attendance, Discipline and GPA. They are based on the Ed-Fi Data Standard v3.2.
For more comprehensive information on students and teachers please look at the full data requirements section, below.
Additionally, the following resources work for v2.6.0 and v3.2.0 of the Ed-Fi standard.
| Entity | ODS database field | API end-point |
|---|---|---|
Local Education Agency | edfi.LocalEducationAgency edfi.EducationOrganization | ~/ed-fi/localEducationAgencies |
Schools | edfi.School edfi.EducationOrganization edfi.Session edfi.SchoolYearType | ~/ed-fi/schools ~/ed-fi/sessions ~/ed-fi/schoolYearTypes |
Parent | edfi.Parent edfi.ParentElectronicMail edfi.SexType | ~/ed-fi/parents ~/ed-fi/sexDescriptors |
Students | edfi.Student edfi.StudentParentAssociation edfi.StudentSchoolAssociation edfi.SexTypes Optional but highly recommended: edfi.GradeLevelDescriptor edfi.GradeLevelType | ~/ed-fi/students ~/ed-fi/studentParentAssociations ~/ed-fi/studentSchoolAssociations ~/ed-fi/gradeLevelDescriptors ~/ed-fi/gradeLevelDescriptors |
| Student Attendance | edfi.StudentSchoolAttendanceEvent edfi.AttendanceEventCategoryDescriptor edfi.AttendanceEventCategoryTypes | ~/ed-fi/studentSchoolAttendanceEvents ~/ed-fi/attendanceEventCategoryDescriptor |
Student Behavior | edfi.StudentDisciplineIncidentAssociation edfi.DisciplineIncident edfi.DisciplineActionDisciplineIncident edfi.DisciplineAction edfi.DisciplineActionDiscipline edfi.DisciplineDescriptor edfi.DisciplineType | ~/ed-fi/studentDisciplineIncidentAssociation ~/ed-fi/disciplineIncidents ~/ed-fi/disciplineActions ~/ed-fi/disciplineDescriptors |
Student GPA | edfi.StudentAcademicRecord edfi.TermDescriptor edfi.TermTypes | ~/ed-fi/studentAcademicRecords ~/ed-fi/termDescriptors |
Full Data Requirements for the Family Engagement Portal
To make full use of all available features in the Family Engagement Portal, the following data is required:
| Entity | ODS database field | API end-point |
|---|---|---|
Local Education Agency | edfi.LocalEducationAgency edfi.EducationOrganization | ~/ed-fi/localEducationAgencies |
Schools | edfi.School edfi.EducationOrganization edfi.Session edfi.SchoolYearType | ~/ed-fi/schools ~/ed-fi/sessions ~/ed-fi/schoolYearTypes |
Parents and Contact Information | edfi.Parent extension.ParentBiography edfi.SexType edfi.ParentElectronicMail edfi.ParentTelephones edfi.ParentAddresses | ~/ed-fi/parents ~/ed-fi/sexDescriptors |
Students | edfi.Student edfi.SexTypes edfi.StudentElectronicMails edfi.StudentTelephones edfi.StudentParentAssociation edfi.RelationType edfi.StudentSchoolAssociation edfi.GradeLevelDescriptor edfi.GradeLevelType edfi.StudentRaces edfi.RaceType | ~/ed-fi/students ~/ed-fi/studentParentAssociations ~/ed-fi/studentSchoolAssociations ~/ed-fi/sexDescriptors ~/ed-fi/gradeLevelDescriptors |
Student Programs | edfi.StudentProgramAssociation | ~/ed-fi/studentProgramAssociations ~/ed-fi/studentSpecialEducationProgramAssociations ~/ed-fi/studentTitleIPartAProgramAssociations ~/ed-fi/studentCTEProgramAssociations ~/ed-fi/studentHomelessProgramAssociations ~/ed-fi/studentLanguageInstructionProgramAssociations ~/ed-fi/studentMigrantEducationProgramAssociations ~/ed-fi/studentNeglectedOrDelinquentProgramAssociations |
Student Indicators | edfi.StudentIndicators | ~/ed-fi/studentEducationOrganizationAssociations |
Student Attendance | edfi.StudentSchoolAttendanceEvent edfi.AttendanceEventCategoryDescriptor edfi.AttendanceEventCategoryTypes | ~/ed-fi/studentSchoolAttendanceEvents |
Student Behavior | edfi.StudentDisciplineIncidentAssociation edfi.DisciplineIncident edfi.DisciplineActionDisciplineIncident edfi.DisciplineAction edfi.DisciplineActionDiscipline edfi.DisciplineDescriptor edfi.DisciplineType | |
Student Grades - GPA | edfi.StudentAcademicRecord edfi.TermDescriptor edfi.TermTypes | |
| Student Grades - Current Course Grades | edfi.Grade edfi.GradeType edfi.StaffSectionAssociations edfi.Staff edfi.Course edfi.CourseOffering | |
| Stuednt Grades - Transcript | edfi.CourseTranscript edfi.Course edfi.AcademicSubjectDescriptor edfi.AcademicSubjectType edfi.CourseAttemptResultType edfi.GradeLevelDescriptor edfi.GradeLevelType edfi.TermDescriptor edfi.TermType edfi.Sessions | |
Student Missing Assignments | edfi.GradebookEntry Note: We expect the GradingPeriodDescriptorId to be filled in so we know what type this entry is of. Numeric grade should be filled in with a ‘M’ for missing assignments. (Assumption made back in eSchoolPlus implementation) edfi.CourseOffering edfi.Courses edfi.SchoolYearTypes edfi.StudentGradebookEntry | |
Student Schedule | edfi.StudentSectionAssociation edfi.SchoolYearType edfi.BellScheduleMeetingTime edfi.CourseOffering edfi.Course | |
Student Assessments | edfi.StudentAssessment edfi.StudentAssessmentScoreResult edfi.Assessment edfi.StudentAssessmentPerformanceLevel edfi.PerformanceLevelDescriptor edfi.PerformanceBaseConversionType | |
Student Success Team
| Counselors
Program associations
| |
Teachers / Staff / Counselors | edfi.Staff edfi.SexType edfi.StaffElectronicMails edfi.StaffCredentials edfi.CredentialType edfi.LevelOfEducationDescriptor edfi.LevelOfEducationType edfi.StaffLanguages edfi.StaffEducationOrganizationAssignmentAssociation edfi.StaffSectionAssociation edfi.StudentSectionAssociation edfi.SchoolYearType extension.StaffBiography | |
Student on Track To Graduate | extension.StudentGraduationReadinesses |
Educator Preparation Starter Kits
The following system requirements cover both educator preparation starter kits:
- Clinical Experience and Performance
- Diversity and Persistence
Server Specifications
- A machine or virtual machine with internet access.
- 50GB free storage space.
- 4GB+ of available RAM.
- Windows Server 2019.
- Administrator access to physical machine or virtual machine.
Software Installed
Windows Components
- Microsoft IIS v10 (Internet Information Services web server platform, current version 10+ in Windows 2016-2019)
- URL-Rewite module for IIS
- SSL Certificate
- Auto install with self-signed and Let’sEncrypt for DNS
- Microsoft .NET Core 6.0
Microsoft SQL Server
- SQL Server 2019
Optional: MS SQL Server Management Studio
Tools
- Chocolatey (Package Manager)
- Git for Windows (Solution Code Manager)
- Modern browser (Microsoft Edge or Google Chrome)
Ed-Fi Technology Suite 3
- ODS / API Suite 3, version 6.1.0
- Analytics Middle Tier 4.0.0
- Ed-Fi Admin App 3.1.0
- Data Import 2.1.0