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. Ed-Fi entities such as EducationOrganizations, Students, and Sections are mapped to Edlink objects like District, Person, and Class through a standardized transformation process.

Data Mapping

EntityEdlink Model
Districts and SchoolsDistrict, School
StudentsPerson with the Student role
StaffPerson with the Staff role
ParentsAgent with relationship flags such as LivesWith and EmergencyContact
CoursesCourse
SectionsClass
EnrollmentsEnrollment linking students and staff to classes
SessionsSession
PeriodsPeriod for class scheduling
IncidentsIncident for behavior and disciplinary tracking
Facilities and RoomsFacility, Room for physical school environments

Key Considerations

  • Role Differentiation: Students, staff, and parents are uniquely identified and assigned appropriate roles within Edlink based on Ed-Fi data.
  • Law Enforcement Reporting: Ed-Fi's incident tracking supports law enforcement reporting, which is mapped directly to Edlink's Incident model for full visibility.
  • Timezones: Ed-Fi school and district timezones are automatically reflected within Edlink, ensuring alignment across entities.

Special Accounts 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.

Recommendations for Common Issues

These are some tips for resolving possible issues during setup and ongoing maintenance.

Missing Data (Students/Courses)

  • Verify that the Ed-Fi API user has appropriate permissions to access entities such as students, sections, and courses.
  • Confirm that the API client has read access at both the district and school levels.

Incomplete Enrollment Data

  • Missing session data may lead to incomplete enrollments. Ensure that session sync is enabled and configured correctly.
  • Verify that section enrollments have corresponding course offerings linked to active sessions.

Attendance Discrepancies

  • Attendance data sync may not align if Ed-Fi codes are missing. Ensure all attendance states (Present, Absent, Tardy) are configured properly.
  • Confirm that attendance sync includes section-level and daily meeting-level attendance.

For further assistance, contact Edlink support or your Customer Success Manager.