Skip to main content
Ed-Fi.orgDocsCommunityAcademy

EPDM Community v1.1 — Getting Started

Legacy Content

This page documents EPDM Community v1.1, which was an extension of the Ed-Fi ODS/API. Starting with Data Standard v6 (November 2025), EPDM is integrated into the Ed-Fi core standard and no longer requires a separate extension. See the Migration Guide for transition guidance.

Overview​

The EPDM (Educator Preparation Data Model) technology solution is made up of the Ed-Fi ODS (Operational Data Store), a companion API (Application Programming Interface), with extensions for EPDM — collectively the Ed-Fi ODS/API with EPDM.

note

This version introduced the EPDM-Core / EPDM-Community split. If you are interested in the Educator Preparation Provider starter kits, EPDM-Core already comes pre-installed with ODS/API v6.1.

Tested Configurations​

  • Windows Server 2019, Windows 10
  • Microsoft SQL Server 2019 (Developer, Standard, or Enterprise Edition)1
  • PostgreSQL 13.x
  • Visual Studio 2022 (Community or higher)
  • Ed-Fi ODS/API Suite 3 v6.1

Installation​

To install Ed-Fi ODS/API Suite 3 v6.1 with EPDM-Community v1.1 on Windows:

Step 1. Download the Installer Packages​

Download the following release packages:

  • EdFi.Suite3.Installer.WebApi
  • EdFi.Suite3.Installer.SwaggerUI (Optional, not for production)
  • EdFi.Suite3.RestApi.Databases
  • EdFi.Suite3.Ods.Extensions.TPDM.Community.1.1.0

For each download, right-click → Properties → change extension from .nupkg to .zip, check Unblock, and click OK.

note

You may need to configure TLS in PowerShell before running installation scripts:

[Net.ServicePointManager]::SecurityProtocol += [Net.SecurityProtocolType]::Tls12

Step 2. Install the Ed-Fi Databases​

Extract EdFi.Suite3.RestApi.Databases and download the EPDM database deployment scripts (minimal and populated) for your database engine. Copy them to the Ed-Fi-ODS-Implementation\DatabaseTemplate\Scripts folder.

Edit configuration.json for your database engine:

SQL Server:

"ConnectionStrings": {
    "EdFi_Ods": "server=(local);trusted_connection=True;database=EdFi_{0};Application Name=EdFi.Ods.WebApi",
    "EdFi_Security": "server=(local);trusted_connection=True;database=EdFi_Security;persist security info=True;Application Name=EdFi.Ods.WebApi",
    "EdFi_Admin": "server=(local);trusted_connection=True;database=EdFi_Admin;Application Name=EdFi.Ods.WebApi",
    "EdFi_Master": "server=(local);trusted_connection=True;database=master;Application Name=EdFi.Ods.WebApi"
},
"ApiSettings": {
    "Mode": "SharedInstance",
    "Engine": "SQLServer",
    "MinimalTemplateScript": "TPDMCommunityMinimalTemplate",
    "PopulatedTemplateScript": "TPDMCommunityPopulatedTemplate"
},
"Plugin": {
    "Folder": "./Plugin",
    "Scripts": [ "tpdm" ]
}

PostgreSQL:

"ConnectionStrings": {
    "EdFi_Ods": "host=localhost;port=5432;username=postgres;database=EdFi_{0};Application Name=EdFi.Ods.WebApi",
    "EdFi_Security": "host=localhost;port=5432;username=postgres;database=EdFi_Security;Application Name=EdFi.Ods.WebApi",
    "EdFi_Admin": "host=localhost;port=5432;username=postgres;database=EdFi_Admin;Application Name=EdFi.Ods.WebApi",
    "EdFi_Master": "host=localhost;port=5432;username=postgres;database=postgres;Application Name=EdFi.Ods.WebApi"
},
"ApiSettings": {
    "Mode": "SharedInstance",
    "Engine": "PostgreSQL",
    "MinimalTemplateScript": "PostgreSqlTPDMCommunityMinimalTemplate",
    "PopulatedTemplateScript": "PostgreSqlTPDMCommunityPopulatedTemplate"
},
"Plugin": {
    "Folder": "./Plugin",
    "Scripts": [ "tpdm" ]
}

Extract the TPDM-Community package into the Ed-Fi-ODS-Implementation\Plugin folder. Then run:

Import-Module .\Deployment.psm1
Initialize-DeploymentEnvironment

Step 3. Install WebApi​

Import-Module .\Install-EdFiOdsWebApi.psm1

SQL Server parameters:

$parameters = @{
    PackageVersion = "6.1.901"
    DbConnectionInfo = @{
       Engine="SqlServer"
       Server="localhost"
       UseIntegratedSecurity=$true
    }
    InstallType = "SharedInstance"
}
Install-EdFiOdsWebApi @parameters

PostgreSQL parameters:

$parameters = @{
    PackageVersion = "6.1.901"
    DbConnectionInfo = @{
       Engine="PostgreSQL"
       Server="localhost"
       Username="postgres"
    }
    InstallType = "SharedInstance"
}
Install-EdFiOdsWebApi @parameters

After installation, copy the TPDM-Community plugin folder to C:\inetpub\Ed-Fi\WebApi\plugins. Update appsettings.json:

"Plugin": {
    "Folder": "./Plugin",
    "Scripts": [ "tpdm" ]
}

Step 4. Install Swagger (Optional)​

Import-Module .\Install-EdFiOdsSwaggerUI.psm1
$parameters = @{
    PackageVersion = "6.1.901"
    WebApiVersionUrl = "https://YOUR_SERVER/WebApi"
}
Install-EdFiOdsSwaggerUI @parameters

Step 5. Restart IIS​

iisreset

Footnotes​

  1. SQL Server Express Edition is not supported. ↩