Skip to end of metadata
Go to start of metadata

Ensure that the following software is installed and configured:

Installation details and configuration procedures are described below.

Java Runtime Environment

The Profiles feature of the Ed-Fi ODS / API ships with integration tests that generate a version of the Ed-Fi ODS / API SDK. This generation step requires Java Runtime Environment version 8 or higher.

Install the latest version: Java Runtime Environment.

Microsoft SQL Server 2014

Microsoft SQL Server 2014 is used to store all the data for the Ed-Fi ODS / API. Local installation of Standard, Developer, or Enterprise Editions with Service Pack 2 or higher are supported. Using a remote instance of Microsoft SQL Server is not currently supported.

Install Microsoft SQL Server 2014:

  1. When prompted, select the following features:
  2. Use the default instance named MSSQLSERVER.
  3. Select either Windows Authentication Mode or Mixed Mode.

    Mixed Mode may be preferred if you also intend to install the Ed-Fi Dashboards. Mixed Mode can be enabled later by following the Change Server Authentication Mode instructions.

  4. In Specify SQL Server administrator, click Add Current User.

Visual Studio 2015

The ODS/API v2.x code base has been developed and tested using Visual Studio 2015 Professional Edition, so this is the recommended environment. If you want to use Visual Studio 2017, see ODS-2478 for details on a known issue with VS 2017 and a suggested work around.

Install Visual Studio 2015:

1. Select the following features:


2. Install the Modeling SDK for Microsoft Visual Studio.

  • Web Developer Tools is used by some of our user interface projects within the Ed-Fi ODS / API.
  • Extensibility Tools is Visual Studio 2015 SDK and is required for the Modeling SDK.
  • Modeling SDK is used in later steps by our build script to set up the development environment.

After installing, check the Visual Studio Start Page and Windows Update for Visual Studio updates.


Getting Started Documentation Contents

Find out more about how to begin using the Ed-Fi ODS / API:

  • No labels