For Developers

Implementation Details

This document provides technical details on how the integration between Ed-Fi and Edlink operates, including data mapping, supported models, and important considerations for successful implementation.

How the Integration Works

Edlink's integration with Ed-Fi facilitates the synchronization of educational data, including districts, schools, students, staff, courses, enrollments, and sessions. The integration leverages Ed-Fi API endpoints to pull data and transform it into Edlink's internal models.

Data Mapping

EntityEdlink Model
localEducationAgenciesDistrict
SchoolsSchool
Students, StaffPerson
studentContactAssociationsAgent with relationship flags such as LivesWith and EmergencyContact
CoursesCourse
SectionsClass
studentSectionAssociationsEnrollment linking students and staff to classes
SessionsSession
classPeriodPeriod for class scheduling
IncidentsIncident for behavior and disciplinary tracking
FacilitiesFacility
academicSubjectDescriptorsSubject
locationReferenceRoom for physical school environments

Key Considerations

  • Special Accountshttps://health.aws.amazon.com/health/status and Roles
    • Role Mapping:
      • Students and staff are mapped as Person objects with specific roles (Student, Staff).
      • Parent or guardian accounts sync as Agent objects, preserving family and emergency contact relationships.
    • Observer Accounts: While Ed-Fi can track guardians, only individuals with established relationships to students are included in the sync.
  • Behavioral and disciplinary incidents from Ed-Fi are reflected within Edlink's Incident model.
    • Incident Details: Sync includes costs, descriptions, and incident identifiers.
    • Participants: Students or staff involved in incidents are linked through Ed-Fi associations, mapped to Edlink's Person model.
    • Law Enforcement Reporting: Ed-Fi flags for law enforcement involvement are captured in Edlink, ensuring comprehensive reporting.
  • Timezones: Ed-Fi school and district timezones are automatically reflected within Edlink, ensuring alignment across entities.

Attendance Management

Edlink translates Ed-Fi attendance records directly into Edlink's Attendance model.

  • Meeting Attendance: Attendance is tracked at the section or meeting level, reflecting Ed-Fi's granular attendance records.
  • Attendance States: Present, Absent, and other attendance flags are synced, providing real-time insight into student attendance patterns.

Facilities and Room Management

Ed-Fi location data syncs into Edlink's facility and room models.

  • Facilities: School buildings and physical locations are imported as Facility entities.
  • Rooms: Individual classrooms or spaces sync into Edlink's Room model, including seating capacities and identifiers.

Calendars and Periods

Edlink's integration with Ed-Fi ensures accurate scheduling through calendar and period synchronization.

  • Calendars: School calendars sync into Edlink's Calendar model, covering academic years and instructional days.
  • Periods: Class periods, start times, and end times are reflected in Edlink's Period model, supporting daily schedules.
  • Days: Instructional days are tracked within Edlink's Day model, maintaining alignment with school calendars.

Custom Field Mapping

The following fields can be custom-mapped in our dashboard UI:

  • agent relationships
  • gender identities
  • races
  • grade levels
  • languages
  • attendance states
  • attendance flags
  • disabilities