Ed-Fi Data Standard Extension Framework Best Practices

Owned by Mustafa Yilmaz
Last updated: Dec 13, 2024 by Stephen Fuqua


Outline

Introduction 

This knowledge base article attempts to provide an overview and best practices for the Ed-Fi Data Standard Extension Framework. 

This article assumes prerequisite knowledge from: 

If you have not already completed these courses, we recommend doing so before attempting to digest the information presented in this article. 

Overview of the Ed-Fi Data Standard Extension Framework 

What is the Extension Framework?   

Ed-Fi Data Standard Extension Framework is the new entities, attributes and/or associations Ed-Fi Alliance Community members can include in their local Ed-Fi Technology Suite implementation (as an addition to those already included in the Ed-Fi Data Standard Core Model) according to the guidance provided by the Ed-Fi Alliance. 

Why are Extensions necessary?  

Extensions serve a pivotal role in the evolution of the Ed-Fi Data Standard, reflecting the Ed-Fi Alliance’s commitment to an adaptive, user-driven framework. By allowing for the organic growth of the standard through real-world use cases, extensions become a dynamic tool for addressing the diverse and evolving needs of the community. Far from being mere stop-gap solutions, extensions embody our proactive approach to expanding standardization and ensuring that the Ed-Fi Data Standard remains an organically growing, responsive entity that accommodates the complexities and nuances of educational data. 

Extensions become imperative when the Ed-Fi Data Standard core offering falls short of meeting specific requirements for a given implementation in a given time frame. In such cases, extensions serve as a deliberate and strategic response to bridge the gap between the standard and the unique or specific needs of individual Ed-Fi states and collaboratives. 

What type of Extensions are supported? 

The framework allows adding new entities, extending existing entities, or subclassing existing entities. See the Supported Extensions Tech Docs page for more specific guidelines. 

When to Extend the Ed-Fi Data Standard 

Deciding whether an extension is necessary involves a thoughtful assessment of your specific data requirements within the Ed-Fi Data Standard framework. Follow the steps below to make this determination: 

  1. Start your data mapping. Begin by conducting a comprehensive data mapping exercise. Evaluate your organization's data needs against the existing Ed-Fi Data Standard. Identify any gaps or instances where the standard does not adequately address your specific use cases. As you identify gaps, work with the appropriate business owners to see if their process can be modified to align with the standard instead of defaulting to the other way around.  
  2. Engage the Ed-Fi Data Standard team. If your data mapping reveals a gap in the Ed-Fi Data Standard that cannot be resolved through modification of an internal business process, don't hesitate to engage with the Ed-Fi Data Standard team. Seek their expertise and guidance to understand whether your identified gaps are intentional design choices or if they represent areas that may benefit from extension.
  3. Collaborate with the Ed-Fi Community. Leverage the collaborative nature of the Ed-Fi community. Discuss your findings and potential requirements with other stakeholders who may have faced similar challenges. Community insights can provide valuable perspectives on whether an extension is a shared need or a more isolated requirement. This also includes the vendors that are sources of the data to confirm the impact on their integration effort. 

How to Extend the Ed-Fi Data Standard 

Implementing an extension involves using the MetaEd Integrated Development Environment (IDE). The MetaEd IDE is a powerful tool designed to simplify the process of creating, managing, and deploying extensions. Here's a high-level overview of the steps involved: 

  1. Understand the MetaEd IDE. Start by familiarizing yourself with the MetaEd IDE. This tool serves as the central hub for extension development within the Ed-Fi ecosystem. For an in-depth understanding, refer to the MetaEd Tech Docs Page.
  2. Define and build the extension. See the How To: Extend the Ed-Fi ODS / API - Student Transportation Example for step-by-step guide using the Student Transportation extension as an example.
  3. Create an Extension Plugin. See the How To: Create an Extension page. 
  4. Deploy an Extension Plugin. See the How To: Deploy an Extension page. 

Best Practices 

Below is a list of best practices to consider when working with the Extensions Framework. 

  • If possible, avoid extensions. Carefully assess your need to extend the core Ed-Fi Data Model and justify the assessment result by comparing it with the previous work and conversation of the Ed-Fi Community. 
  • Get help with data mapping. The Ed-Fi Data Standard team is here to assist with your data mapping questions and guide you with the extension modeling. You can connect with them by going to https://success.ed-fi.org     
  • Refrain from making unsupported modifications. Do not extend the Ed-Fi Data Model in ways that are not supported. See the Supported Extensions Tech Docs page for more specific guidelines. 
  • Be cautious about aggregate data. The idea of using extensions to hold aggregate data elements comes up often in data mapping exercises. In general, the Ed-Fi Alliance recommends avoiding aggregates in favor of the underlying discrete data used to compute them.  
  • Assess the impact and long-term viability of an extension. Consider the potential impact of introducing an extension on your system and data ecosystem (including your vendors). Evaluate whether the extension aligns with your long-term goals and whether it is a sustainable solution for addressing your unique data needs. 
  • Evaluate future standard updates. As mentioned earlier, Ed-Fi extensions play a key role in ensuring the Ed-Fi Data Standard continues to stay relevant as new data collection sources come online.  Stay informed about upcoming releases and updates to the Ed-Fi Data Standard. Some of your identified gaps may be addressed in future versions. Assess whether waiting for an upcoming release is a viable option for your organization. Also, develop a plan to share your extension with the Ed-Fi Alliance Community members for a larger adoption if you go that route. 

    If you are a state education agency or a regional agency, connect with your community peers to understand if they created an extension for a similar use case and how they have done it.  The Ed-Fi Alliance’s governance workgroups (SEA Working Group and Collaborative Working Group) can facilitate these discussions, you can email them at governance@ed-fi.org.   

Useful Links 

Here are a few other useful links to continue your learning: