This document describes how to install TPDM as a dynamic plugin in your local development environment as well as how to install TPDM in your production deployment environment.

The steps can be summarized as:

Each step is outlined in detail, below. 

Install TPDM in Development Environment

Assuming that the Ed-Fi ODS / API has been successfully downloaded and is running in a local development environment per the instructions in the Getting Started documentation, TPDM is now ready to be installed in your development environment.

First you need to override appsettings to load TPDM plugin. In a PowerShell session navigate to <source directory>\Ed-Fi-ODS-Implementation\Application\EdFi.Ods.WebApi and use user-secret CLI to setup the override. See Configuration Details - Secret Manager for more details. 

PS C:\OSS-Workspace\Ed-Fi-ODS-Implementation\Application\EdFi.Ods.WebApi\> dotnet user-secrets set "Plugin:Folder"  "../../Plugin"
Successfully saved Plugin:Folder = ../../Plugin to the secret store.
PS C:\OSS-Workspace\Ed-Fi-ODS-Implementation\Application\EdFi.Ods.WebApi\> dotnet user-secrets set "Plugin:Scripts:0"  "tpdm"
Successfully saved Plugin:Scripts:0 = tpdm to the secret store.

To do so, simply open PowerShell and navigate to "<source directory>\Ed-Fi-ODS-Implementation" folder and run:

.\Initialize-PowershellForDevelopment.ps1
Initdev

This will execute configured script from secret.json to download TPDM plugin and deploy the plugin artifacts to local database. 

After the successful execution of initdev, you will find the TPDM extension in <source directory>\Ed-Fi-ODS-Implementation\Plugin folder. 

Run the "Ed-Fi-Ods.sln" solution from Visual Studio and verify that the TPDM data models are listed in your API landing page.

You can also verify the TPDM API endpoints in the Swagger UI documentation:

Install TPDM in an Existing Production Environment 

Deploy TPDM Database Artifacts

Step 1. Download EdFi.Suite3.RestApi.Databases

• Download the EdFi.Suite3.RestApi.Databases from Binary Releases.
• Change package extension from nupkg to zip.
• Right-click the zip file, click unblock and unzip the package.

Step 2. Update configuration.json

• Update configuration.json, for plugin settings as shown below:

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

Step 3. Run Deployment.psm1 with Dynamic Plugins

• From PowerShell, navigate to the download directory and run the following command to install TPDM on your existing ODS database:

  Import-Module .\Deployment.psm1
  Initialize-DeploymentEnvironment

  

  
• After the successful execution, you will find TPDM schema tables in the deployed ODS database. 
  

Deploy TPDM Binaries to Web Server

Step 4. Download EdFi.Suite3.Ods.Extensions.TPDM.1.0.0

• Download the EdFi.Suite3.Ods.Extensions.TPDM.1.0.0 package from Binary Releases.
• Change extension from nupkg to zip.
• Right-click the zip, click unblock, and unzip the package.

• Copy the extracted folder and paste it in C:\inetpub\Ed-Fi\WebApi\Plugin in your WebAPI directory. 

  Note: If you installed your API using EdFi.Suite3.Ods.WebApi package, TPDM plugin is already packaged in the plugin folder. 

  

• Update appsettings.json, for plugin settings as shown below:

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

• Restart your IIS instance.
  
  

Step 5. Verify API Landing Page in Browser

• Browse to the API landing page and verify that TPDM data models are listed. 

• You can also verify the TPDM API endpoints in the Swagger UI documentation.