Getting Started

This documentation outlines the steps necessary to download, configure, and deploy the Ed-Fi ODS (Operational Data Store) and companion API (Application Programming Interface), referred to collectively as the Ed-Fi ODS / API. The Ed-Fi ODS / API enables applications to read and write education data stored in an Ed-Fi ODS through a secure REST interface. The Ed-Fi ODS / API supports both transactional and bulk modes of operation.

For implementations that have no requirement to extend or customize the ODS / API, consider using the Ed-Fi Tech Suite Installer as an alternative to starting from source code. If you take this approach, then ignore the information on this page and follow the instructions provided with the installers.

Audience

This documentation is for technical professionals who work with educational data, including business analysts, database administrators, and software developers. The primary audience is developers and hosts of ODS / API platforms, but developers of client applications may find this information useful.

Prerequisites

The Ed-Fi ODS / API technology is open source and is licensed under the Apache License, Version 2.0.

Familiarity with the following technologies is required for installing and configuring the software components:

Microsoft Windows (installation and configuration)
PowerShell
.NET Core 3.1.301
Visual Studio 2019 (Community or higher)
Microsoft SQL Server 2016 or 2017¹
Optional PostgreSQL datastore:
- PostgreSQL 11.x. PostgreSQL can be used as the datastore for and Ed-Fi ODS / API instance instead of Microsoft SQL Server.

Tested Configurations

The Ed-Fi ODS / API configuration described in this documentation has been tested with the following software configurations:

Windows Server 2016, Windows 10
Microsoft SQL Server 2016 and 2017 (Developer Edition, Standard Edition, or Enterprise Edition)
Visual Studio 2019 (Community or higher)
JetBrains Rider 2019.1

¹ SQL Server Express Edition is not supported.