Tech Docs

The technical materials below provide conceptual information for parties interested in learning more about the Ed-Fi Data Standard and technology components offered by the Ed-Fi Alliance. The materials also provide reference information for parties implementing technology components in their own environment or as part of products and services provided to others. The materials are intended for a technical audience that is familiar with XML, REST API and database development.

Remember, in order to download source code and work with Ed-Fi Technology Components, you need to license Ed-Fi technology, and have access to the Ed-Fi repository in GitHub.

Ed-Fi Operational Data Store and Ed-Fi ODS API

The Ed-Fi Operational Data Store (ODS) provides a place to store information that integrates and catalogs secure real-time data from other systems within your agency, regardless of the source ans supports transactional data. The Ed-Fi ODS API provides the ability to selectively create, read, and update information stored in an Ed-Fi powered ODS, maximizing developer productivity and success.

Title Component Version Description
Technical Preview Presentation (Video) v2.0 – Technical Preview Link to the pre-recorded video presentation for the technical preview of the Ed-Fi ODS 2.0 and Ed-Fi ODS API 2.0.
Technical Preview Presentation (PDF) v2.0 – Technical Preview Link to the PDF presentation for the technical preview of the Ed-Fi ODS 2.0 and Ed-Fi ODS API 2.0.
Getting Started Guide (PDF) v2.0 – Technical Preview A detailed, step-by-step Getting Started Guide for community licensees. In order to view the code, you must be an Ed-Fi licenesee, with access to GitHub.

Ed-Fi Dashboards

Ed-Fi Dashboards provide a starting point for developing student performance dashboards that puts real-time, actionable information at the fingertips of educators. It includes a user interface with metrics that educators identified as critical to improving student achievement

Title Component Version Description
What’s New (HTML)   v1.3  Find what’s new in Ed-Fi Dashboards v1.3.
Student Performance Dashboard Metrics (HTML)   v1.3 Explains the educational metrics that elementary and secondary teachers have identified as critical to understanding students’ strengths and areas for improvement. It also includes the metrics that school and district leaders have identified as critical to performing their responsibilities.

Ed-Fi Data Standard

The Ed-Fi Data Standard is the widely-adopted, CEDS-aligned, open-source data standard developed by the educational community for the betterment of the community. The Ed-Fi Data Standard serves as the foundation for enabling interoperability among secure data systems and contains a Unifying Data Model designed to capture the meaning and inherent structure in the most important information in the K–12 education enterprise.

Title Data Standard Version  Description
Unifying Data Model (PDF)   v1.2 Illustrates the Ed-Fi reference model in Unified Modeling Language (UML) class diagrams.
CEDS 3.0 Alignment Approach for Ed-Fi v1.2 (PDF)   v1.2 Provides a detailed, initial comparison of CEDS 3.0 and Ed-Fi v1.1.1 and describes the Ed-Fi Alliance’s approach for addressing alignment in Ed-Fi v1.2.
Technical Concepts (PDF)   v1.2 Outlines the design concepts, principles, patterns and conventions used for the Ed-Fi unifying data model and its associated XML core schema.
Ed-Fi REST API Design Guidelines (PDF) Revision 2 – Draft 1 Defines a set of design guidelines that should be adhered to when implementing an Ed-Fi REST API over an Ed-Fi application or data store.
Ed-Fi Core XML Schema (ZIP)   v1.2 The central XML schema definition (XSD) that defines a base set of data elements, attributes, types and structures that are intended for use across the rest of the Ed-Fi components. The core schema serves the majority of schools’ educational needs and provides the building blocks for additional schema, such as the interchange and extension schema.
Data Handbook for the Core XML Schema (HTML)   v1.2 Describes all of the core schema elements and their properties using non-technical language.
XML Data Dictionary for Core XSD (XSLX)   v1.2 Describes all of the core schema complex and simple types.
Standard Interchange Schemas Overview (PDF)   v1.2 Introduces a set of 19 Standard Interchange Schemas that represent field-tested schema based on the unmodified, non-extended Ed-Fi Core to handle common data exchange use-cases
Standard Interchange Schema Briefs (ZIP)   v1.2 Provides detailed information about each of the Standard Ed-Fi Interchange Schemas.
Ed-Fi Standard Interchange Schemas with Sample Data (ZIP)   v1.2 Examples of how to write interchange schema to define relationships between elements that are re-used from the core schema, along with newly defined elements. Sample Descriptor values for Ed-Fi vocabularies and CEDS option sets are also included in this package.
Extension Framework Guide (PDF)   v1.2 Explains how to safely customize Ed-Fi data types by creating Ed-Fi extension schema.
Extension Schema Example – Custom Student Transcript (ZIP)   v1.2 Example of an extension schema to load a student transcript generated by a high school for a post-secondary institution.
Logical Database Model (PDF)   v1.2 Graphical guide to Ed-Fi Logical Database Model, based on a relational database schema that is aligned with the reference Ed-Fi Unifying Data Model.

Ed-Fi Tools

Ed-Fi Tools aid developers implementing Ed-Fi technical components.

Title Tool Version Description
Validation Tool Getting Started Guide (PDF)   v1.1 Introduces the Ed-Fi Validation Tool and provides a step-by-step guide for how to create and run validation tests.
Data Mapping Template (XSLX)   N/A Data mapping template.

Download Instructions

In order to download source code and work with Ed-Fi Technology Components, you need to be a licensee of Ed-Fi technology, with access to the Ed-Fi repository on GitHub. Licensing information is available here. If you or your organization are an Ed-Fi licensee and need to get access to the Ed-Fi repository, please send an email that includes your name, organization and GitHub username to info@ed-fi.org.

Looking for Older Versions?