Starter Kit Specific Reference

This page provides information on requirements and suggestions for completing a specific Starter Kit. 

Summary


Chronic Absenteeism Starter Kit


In addition to the general skills, technologies, and team members listed here, the following components are required in order to work with the Chronic Absenteeism Starter Kit:

Software Prerequisites

  • Database Server (Windows Server 2016-2019) with the following components installed:
    • PowerShell 5.0.
    • .NET Core 3.1 Runtime.
    • Microsoft SQL Server 2016 or 2017 Standard (or higher).
  • Web Server (Windows Server 2016-2019) with the following components installed:
    • .NET Core 3.1 Hosting Bundle. The .NET Core 3.1 Hosting Bundle is required for running the API on IIS.
    • Internet Information Services. IIS is the web server that will run the ODS / API.
  • Microsoft Power BI (Desktop and Service)
  • Ed-Fi Technology Suite 3

    • Ed-Fi ODS / API 5.2

    • Ed-Fi Admin App 2.2

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 RoleResponsibilities

System Administrator (IT department)

Person responsible for installing technology applications and setting up servers (web servers and database servers) for those applications.
SIS Administrator (IT department, typically)Person responsible for administering and configuring the district's Student Information System (and who can serve as the point of contact for technical support from the SIS vendor if needed).
District Administrator / Central Office CoordinatorPerson responsible for procedures, training, and data input/management for attendance taking in the district (often a lead registrar, or accountability/research/evaluation department staff member).
Campus AdministratorA campus principal or assistant principal, especially from a secondary school (middle or high school) would be a recommended team member for use of this chronic absenteeism starter kit. This could also involve a lead counselor from a middle or high school.



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

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 RoleResponsibilities

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 staffPerson 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:

  1. System Administrator
  2. SIS Administrator


  1. Person responsible for installing technology applications and setting up servers (web servers and database servers)
  2. Person responsible for administering and configuring the district's Student Information System (and who can serve as the point of contact for technical support from the SIS vendor if needed)

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.

EntityODS database fieldAPI 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:

EntityODS database fieldAPI 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

  • Parents (defined above)
  • Teachers (defined below)
  • Other Staff (this row)


Counselors

  • edfi.StudentCohortAssociation
  • edfi.StaffCohortAssociations
  • (Plus all defined in Staff below)

Program associations

  • edfi.StudentProgramAssociation
  • edfi.StaffProgramAssociations
  • (Plus all defined in Staff below)

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

   

SEA Modernization Starter Kit


In addition to the general skills, technologies, and team members listed here, the following components are required in order to work with the SEA Modernization Starter Kit:

Software Prerequisites

  • Database Server (Windows Server 2016-2019) with the following components installed:
    • PowerShell 5.0.
    • .NET Core 3.1 Runtime.
    • Microsoft SQL Server 2016 or 2017 Standard (or higher).
  • Web Server (Windows Server 2016-2019) with the following components installed:
    • .NET Core 3.1 Hosting Bundle. The .NET Core 3.1 Hosting Bundle is required for running the API on IIS.
    • Internet Information Services. IIS is the web server that will run the ODS / API.
  • Ed-Fi Technology Suite 3

    • Ed-Fi ODS / API 5.2

    • Ed-Fi Admin App 2.2

Suggested Team Member Involvement 

The deployment, configuration, and use of the SEA Modernization starter kit typically involves staff members in these roles in a state. We recommend involving staff members in at least these roles (or their equivalent in your state) 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 RoleResponsibilities
Business Office - Program/Data Leads and Business Analysts: People responsible for data use and reporting, often for assessment and accountability purposes

IT Department:

  1. System Administrator
  2. SIS Administrators
  3. Developer


  1. Person responsible for installing technology applications and setting up servers (web servers and database servers)
  2. People responsible for administering and configuring the LEA Student Information Systems (and who can serve as the point of contact for technical support from the SIS vendor if needed)
  3. People responsible for developing systems or applications.
Vendor Relationship ManagerPerson responsible for collaborating and communicating with vendors and to make sure the end-to-end integration testing happens.  


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