Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Customizations to the Ed-Fi data model – and concrete specifications such as the Ed-Fi data exchange XSD – are explicitly supported for implementation-specific or other purposes using the set of conformant extensions described in this section, known as the Ed-Fi Extension Framework. The Extension Framework documentation provides detail on extension patterns that are supported throughout Ed-Fi technology.

The Ed-Fi Alliance provides a free tool called the MetaEd IDE that automates the process of extending Ed-Fi technology, including the Ed-Fi data exchange XSDs. The documentation that follows covers the patterns that are created by the MetaEd IDE.

General Extension

Patterns

Pattern

Extensions are made in an extended core. This allows extensions to be defined once and reused across multiple interchange schemas, as well as supports automated code generation.

 

Options for extending the Ed-Fi Core

Extending the Schema

The

Ed-Fi

Extension Framework

defines

contains the

following set of conformant methods of customization:
  1. Customization by Using XML Complex Type Extension. This technique may be applied to domain or association complex types to:
    • Add attributes or associations
    • Replace attributes deleted by restriction
  2. Customization by Adding New Complex Types. This technique may be applied to add new domain or association complex types; it is often used to:
    • Extend data transfer into new education domains

Extending the Schema

The authoritative list of the types of extensions you can do, and the MetaEd IDE documentation contains everything you need to know about extending how to extend Ed-Fi XSD definitions. The documentation includes download and installation instructions, plus how-to articles covering the most common extension scenarios.

Include Page
_XSD Sidebar
_XSD Sidebar