This version of the Ed-Fi ODS / API is no longer supported. See the Ed-Fi Technology Version Index for a link to the latest version.
Step 2. Install and Configure Required Software
- Ian Christopher
- Chris Moffatt (Deactivated)
Install the following software components:
- Visual Studio 2013 (Professional or Premium Edition)
- Microsoft SQL Server 2012 – with Service Pack 2 or higher (Developer Edition, Standard Edition, or Enterprise Edition)
- Microsoft Message Queue (MSMQ) Server Core
- Windows Azure SDK, version 2.3
- Java JRE version 8 or higher
Installation details and configuration procedures for these software components are described below.
Visual Studio 2013
In addition to a base installation of Visual Studio 2013 (Professional or Premium Edition), the following components must be installed and configured:
- Install Visual Studio 2013 SDK, see http://www.microsoft.com/en-us/download/details.aspx?id=40758.
- Install Modeling SDK for Microsoft Visual Studio 2013, see http://www.microsoft.com/en-us/download/details.aspx?id=40754.
- Install Microsoft SQL Server 2012 Data-Tier Application Framework, see http://www.microsoft.com/en-us/download/details.aspx?id=39976.
- Check the Visual Studio start page for Visual Studio 2013 updates (should be Update 4 or higher).
- Check Windows Update for updates to VS 2013.
- Ensure that the following NuGet feeds are available and enabled as package sources (Visual Studio > Tools-NuGet Package Manager > Package Manager Settings > Package Sources):
- nuget.org, https://www.nuget.org/api/v2/.
- Ed-Fi Alliance NuGet Feed, https://www.myget.org/F/ed-fi/.
Microsoft SQL Server 2012
In addition to a base installation of Microsoft SQL Server 2012 (Developer Edition, Standard Edition, or Enterprise Edition), the following components must be installed and configured. In SQL Server 2012 setup:
- When prompted, select the following features:
- Database Engine Services (Replication/text search/data quality services are NOT required.)
- SQL Server Data Tools
- Management Tools – Complete
- Use the default instance named MSSQLSERVER.
- Select SQL Server and Windows Authentication Mode.
- In Specify SQL Server administrator, click Add Current User.
Several configuration settings must be changed in the solution if a local default instance of Microsoft SQL Server 2012 is not used. The steps required to changes these settings are described in Step 3, below.
Microsoft Message Queue Server Core
The MSMQ Server Core must be installed and configured. Using Windows 8:
- In Control Panel > Programs > Programs and Features select the Turn Windows features on or off menu.
- Select the Microsoft message Queue (MSMQ) Server Core option as shown below.
- Press OK to confirm installation of MSMQ.
Windows Azure SDK v2.3
The solution currently has dependencies on Azure SDK even if Azure is not used as a deployment option. Install the Windows Azure SDK, version 2.3 by following the directions at http://www.microsoft.com/en-us/download/details.aspx?id=42317. You will need to follow the manual instructions in the "Install Instructions" section on this page.
More information about Windows Azure and the Windows Azure SDK is provided in Appendix C of this documentation.
Java JRE version 8 or higher
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 the Java JRE version 8 or newer to be installed. You can install the latest version of the Java Runtime Engine from https://java.com/en/download/.
Once the Java Runtime Engine has been installed, verify that the windows PATH environment variable contains a path to find the jre bin directory (e.g. C:\Program Files (x86)\Java\jre1.8.0_91\bin), and add it if it is not present. (Note, if you manually add it this entry to the windows PATH environment variable, you will need to sign out and sign in to windows in order for this setting to take effect).