Getting Started - Project Templates Installation

Updated

Note that the project templates have been updated for v5.0.0 release. Developers using previous versions should uninstall the previous version and install the latest.

The Ed-Fi Alliance provides a Visual Studio extension that contains project templates for creating Composites, Ed-Fi Extensions, and Profiles. The Visual Studio extension is supported by Visual Studio 2017. Installing the VS extension is useful for many customization needs.

This section describes how to install the Project Templates. It assumes you have Visual Studio installed, and have successfully installed the ODS / API on a development machine per the instructions in the Getting Started - Installation Steps section of this documentation.

The installation steps can be summarized as:

Detail on each step follows.

Step 1. Uninstall Any Previous Versions

Verify that there are no previous versions of the templates installed under Tools > Extensions and Updates > Templates. "Uninstall" previous versions of "Ed-Fi Alliance Project Templates"

Step 2. Download the Ed-Fi Visual Studio Extension

Download the Ed-Fi Visual Studio Extension from the download panel on the right.

Step 3. Close Visual Studio

Close Visual Studio. Ensure you close all instances.

Step 4. Install the Templates

Double-click the downloaded EdFi.ProjectTemplates.Installer.vsix file and install the templates.

Step 5. Verify Install

Verify that the extension installed under Tools > Extensions and Updates > Templates.

Verify that the templates are available under File > New > Project.

Next Steps

Now that you've installed the templates, you can find information on how to use them in the following articles:

Downloads

The following link contains the Visual Studio Extension:

EdFi.ProjectTemplates.Installer.vsix

(Please note a known issue and work around reported in ODS-4652 - Getting issue details... STATUS )

Ed-Fi ODS / API for Suite 3 v5.0.0