Versions Compared

Key

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

The ODS / API provides multiple deployment options for segregating data in the ODS. When setting up Ed-Fi ODS / API environment intended for production data collection, implementers have the option to configure the API to run on Shared Instance, Year Specific, District Specific or Instance-Year Specific modes. See the Extensibility & Customization section for details. While none of the modes prevent multi-year data being stored in the ODS, some of the modes (e.g.  Year Specific) are more aligned with single year data capture with year based ODS naming convention and separate year specific API URL, others (e.g. Shared Instance, District Specific) do not provide clear indication of whether data in the ODS spans across multiple years. This article provides essential information for education agencies and other platform hosts to understand limitations of storing multiple years of data in a single ODS and provides guidance on how to solve for multi-year use cases. 

Table of Contents

Recommendation

The Ed-Fi Alliance recommends that implementers use ODS for single year data collection, regardless of deployment mode. 

...