A newer version of the Ed-Fi ODS / API is available. See the Ed-Fi Technology Version Index for a link to the latest version.
How To: Remove Sample, TPDM, and Homograph Extensions
- Ian Christopher (Deactivated)
- Vinaya Mayya
- Miguel Kaminski
Owned by Ian Christopher (Deactivated)
The ODS / API ships with Sample and Homograph extensions that serve as examples and as test cases for different extension possibilities. TPDM is provided as optional extension. You can perform the following steps to remove them from your implementation:
- Remove EdFi.Ods.Extensions.TPDM, EdFi.Ods.Extensions.Sample, and EdFi.Ods.Extensions.Homograph Projects in Visual Studio. Right-click on the Project in the Solution Explorer, select Remove.
- Manually delete EdFi.Ods.Extensions.TPDM, EdFi.Ods.Extensions.Sample, and EdFi.Ods.Extensions.Homograph Extension Project files from disk. These will be in {{ Source Code Root }}\Ed-Fi-ODS-Implementation\Application\.
- Remove EdFi.Ods.Profiles.ExtensionsSample Profile Project in Visual Studio. Right-click on the Project in the Solution Explorer, select Remove.
- Manually delete EdFi.Ods.Profiles.ExtensionsSample Profile Project files from disk. These will be in {{ Source Code Root }}\Ed-Fi-ODS-Implementation\Application\.
- Remove references to the Extension Projects. These references will be in your OwinStartup classes (e.g. EdFi.Ods.WebApi\Startup\ApiStartup.cs, EdFi.Ods.Api.IntegrationTestHarness\Startup.cs). Remove the using statement and the AssemblyLoader call for each project.
- Save all modified files, close Ed-Fi-ODS.sln, and re-run the code generation steps outlined in the Getting Started Guide (i.e., from a PowerShell prompt run Initialize-PowershellForDevelopment.ps script, followed by the
initdev
command). Then, run the application and view the Ed-Fi ODS / API in the Swagger UI.
If you do not plan on having any extensions, you could turn off EdFi.Ods.Extensions.TPDM, EdFi.Ods.Extensions.Sample, and EdFi.Ods.Extensions.Homograph extensions without source code modifications by using the following configurations in EdFi.Ods.WebApi Web.config:
<add key="extensions:featureIsEnabled" value="false"/> <add key="ExcludedExtensionSources" value="Sample,TPDM,Homograph" />