MDE-EdFi-Documentation

SCHEDULE NOTES

• This documentation now reflects the MDE Ed-Fi implementation for School Year 2024-25. Note that very little is changing from the 2023-24 school year, outside of some additional certification testing such as the Deleting Resources Certification Scenarios and Joint Powers Certification Scenarios. Overview documentation is available in this folder, including this Joint Powers diagram.
• NOTE: Several new elements remain delayed for future years. When found in this repository, those elements are marked as "Postponed until further notice".

This repository contains technical documentation for Minnesota's implementation of the Ed-Fi alliance standard. The Minnesota Department of Education (MDE) is implementing Ed-Fi to help improve the collection of required educational data from Minnesota school districts. Learn more at MDE's Ed-Fi web page and at the following links:

• Ed-Fi Technical Documentation
• Ed-Fi Standards
• Ed-Fi Products and Technology

The primary audience for this documentation is SIS vendors and State of Minnesota technical staff (from MDE and MNIT).

Markdown Documentation

MNIT supporting MDE composes each collection year's documentation in markdown and CSV files. While some documentation remains in Word and Excel within this repository, the markdown files at the top level of this repository represent an effort to store and maintain the documentation in markdown and CSV, in particular:

• SIS and Vendor Test Plan
• Sandbox Certification Scenarios
• Descriptor Tables

By serving documentation in multiple formats, our goal is to increase vendor access to the documentation as well as provide options for understanding and visualization changes over time.

New Data Collections

No new data collections are planned for school year 2024-2025. MDE anticipates piloting a solution for Joint Powers and Intermediate School Districts.

Certification Scenarios for Future Years

Several of the new data collections originally planned for prior school years are now Postponed until further notice. However, they are addressed in this documentation with either new or updated certification scenarios. A brief list of those scenarios is below.

• Language Academic Honors (see additional documentation below)
• Gender Identities and Preferred Pronouns
• Neglected Or Delinquent Program Association
• Online Learning
• Virtual School Status
• Title I Part A School Designation
• Student Preferred Name
• Displaced Students and Student Crisis Events

Migration of Custom Descriptor Tables

For school year 2023-24 the MDE MNIT team moved the custom descriptor tables folder to the top-level of this repository. Going forward, this folder will reflect the most recent information about desciptor tables, either planned for the coming year (spring) or in effect for the current year (summer through winter). The current state of the tables within the folder will be detailed in the About Descriptor Tables markdown file. Viewing the commit history of the folder will allow vendors to more easily visualize changes from year to year.

The folder will continue to contain a suite of CSV files that are exported from our Ed-Fi database(s), and should be used as the "source of truth" reference.

Additional Documentation

We will also use this repository to store additional documentation and links that may be useful to Districts and Vendors. See the following:

• Descriptors and Resources. This document contains additional information about specific descriptors and data resources that can prove useful in understanding MDE's Ed-Fi implementation.
• Transactional Update Procedures covers some of the core concepts of updating records with individual transactions in lieu of bulk uploads, including some examples from Ed-Fi to illustrate.
• Additional Documentation, particularly useful to districts/LEAs, is available on MDE's Ed-Fi Documentation page
• The Common Ed-Fi Errors page will attempt to provide additional documentation on the types of API errors that can arise for vendors and LEAs.

Language Academic Honor Documentation

Postponed until further notice. Language Academic Honor information was previously collected from districts via a Microsoft Word Form in aggregate. For more information about this collection, we encourage vendors to visit:

• The MDE web page about World Languages
• The Microsoft Word Form previously used to collect the information in aggregate.
• The MDE web page about the Minnesota Bilingual Seals Program
• The FAQ page for the Minnesota Bilingual Seals Program

Sample Data

JSON files of sample data can be found in the data directory. These files are intended to assist developers with understanding the Ed-Fi ODS API.

Issues List

As part of this documentation effort, we attempted using Github to manage technical issues. See the Issue List for examples. This effort has mostly been abandoned for lack of use. However, the MDE team is maintaining a list of known issues and bugs in order to keep LEAs informed.

Viewing Options

There are two ways to view this documentation:

1. in the Github repository where https://github.com/mn-mde-edfi/ is in the beginning of the URL in your browser. Raw markdown files are in the "code" section, with links to each other. Github renders this markdown as readable content.
2. in a "Web Version" in which Github attempts to automatically render the markdown files as HTML, and where https://mn-mde-edfi.github.io/ is in the beginning of the URL in your browser.

In general we recommend using the GitHub repository version, given the limitations of the web version:

1. the web version does not render markdown tables into HTML tables, so tables are best viewed directly in the Github repository.
2. Viewing markdown files directly within GitHub also allows you to use their table of contents functionality to navigate.

However, the web version is occasionally advantageous, such as when viewing PDFs. For example:

1. The Ed-Fi EE-MARSS Program Ambiguity Resolution for school year 2023-24.
2. The Joint Powers diagram for school year 2024-25.