Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

This section describes how to set up the Ed-Fi ODS / API v7.0 in single/multi tenant mode. Before you proceed, make sure you have installed the prerequisites listed in Getting Started - Binary Installation.

Step 1. Download the Ed-Fi ODS / API Installer Packages

The Ed-Fi ODS / API installation packages can be downloaded from the following links:

The required release packages to install the Ed-Fi ODS / API can be found at the links below. We recommend you stay current with the latest patch update that has been promoted to release.

For each of the downloads, right-click and select "Properties." Update the file extension (from .nupkg to .zip). Remove the version number (optional). Check the box next to Unblock (this will prevent PowerShell from asking for permission to load every module in the installer) and click OK.

You may need to configure TLS while running the installation scripts described in steps below.
[Net.ServicePointManager]::SecurityProtocol += [Net.SecurityProtocolType]::Tls12

Step 2. Install the Ed-Fi Databases

Extract the contents of the EdFi.Suite3.RestApi.Databases package. The paths in these instructions assume that the package was extracted to a folder with the name of the package (e.g., C:\temp\EdFi.Suite3.RestApi.Databases).

Edit the configuration.json File

There are several settings in the configuration file that are left empty as they depend on whether you are opting of SQL Server or PostgreSQL backend. Update the settings by consulting the samples provided below.

 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"
  },
  "InstallType": "SingleTenant",
  "ApiSettings": {
   "Engine": "SQLServer",
   ...
   "MinimalTemplateScript": "TPDMCoreMinimalTemplate",
   "PopulatedTemplateScript": "TPDMCorePopulatedTemplate"
  }
 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"
  },
  "InstallType": "SingleTenant",
  "ApiSettings": {
   "Engine": "PostgreSQL",
   ...
   "MinimalTemplateScript": "TPDMCorePostgreSqlMinimalTemplate",
   "PopulatedTemplateScript": "TPDMCorePostgreSqlPopulatedTemplate"
  }
 SQL Server (MultiTenant)
"InstallType": "MultiTenant",  
"ApiSettings": { 
   "Engine": "SQLServer",
   "OdsTokens": "Tenant1ODS;Tenant2ODS"
   "Features": [
     ...
     {
        "IsEnabled": true,
        "Name": "MultiTenancy"
     },
     ...
   ]
},
"Tenants" : {
  "Tenant1": {
      "ConnectionStrings": {
        "EdFi_Security":  "server=(local);trusted_connection=True;database=EdFi_Security_Tenant1;persist security info=True;application name=EdFi.Ods.WebApi;encrypt=False",
        "EdFi_Admin":  "server=(local);trusted_connection=True;database=EdFi_Admin_Tenant1;application name=EdFi.Ods.WebApi;encrypt=False"
      }
    },
  "Tenant2": {
      "ConnectionStrings": {
        "EdFi_Security":  "server=(local);trusted_connection=True;database=EdFi_Security_Tenant2;persist security info=True;application name=EdFi.Ods.WebApi;encrypt=False",
        "EdFi_Admin":  "server=(local);trusted_connection=True;database=EdFi_Admin_Tenant2;application name=EdFi.Ods.WebApi;encrypt=False"
      }
    }
}
 PostgreSQL (MultiTenant)
"InstallType": "MultiTenant",  
"ApiSettings": { 
   "Engine": "PostgreSQL",
   "OdsTokens": "Tenant1ODS;Tenant2ODS"
   "Features": [
     ...
     {
        "IsEnabled": true,
        "Name": "MultiTenancy"
     },
     ...
   ]
},
"Tenants" : {
  "Tenant1": {
      "ConnectionStrings": {
        "EdFi_Security":  "host=localhost;port=5432;username=postgres;database=EdFi_Security_Tenant1;application name=EdFi.Ods.WebApi;encrypt=False",
        "EdFi_Admin":  "host=localhost;port=5432;username=postgres;database=EdFi_Admin_Tenant1;application name=EdFi.Ods.WebApi;encrypt=False"
      }
    },
  "Tenant2": {
      "ConnectionStrings": {
        "EdFi_Security":  "host=localhost;port=5432;username=postgres;database=EdFi_Security_Tenant2;application name=EdFi.Ods.WebApi;encrypt=False",
        "EdFi_Admin":  "host=localhost;port=5432;username=postgres;database=EdFi_Admin_Tenant2;application name=EdFi.Ods.WebApi;encrypt=False"
      }
    }
}

Use OdsTokens to deploy year specific ODS databases

Run Installation Script

Open a PowerShell window in Administrator mode and navigate to the EdFi.Suite3.RestApi.Databases package folder.

Run the following PowerShell command to load modules for installation:

Import-Module .\Deployment.psm1

Next, execute the following command in PowerShell:

Initialize-DeploymentEnvironment

Step 3. Install WebApi

Extract the contents of the EdFi.Suite3.Installer.WebApi package. The paths in these instructions assume that the package was extracted to a folder with the name of the package (e.g., C:\temp\EdFi.Suite3.Installer.WebApi).

Prepare Installation script

Open a PowerShell window in Administrator mode and navigate to the EdFi.Suite3.Installer.WebApi package folder. Run the following PowerShell command to load modules for installation:

Import-Module .\Install-EdFiOdsWebApi.psm1

The WebApi installer can take a number of parameters to tailor the installation experience (more examples can be found in the Install-EdFiOdsWebApi.psm1 file). At a minimum, database connection info is required.

Copy and modify the following parameter code to fit your connection information:

 SQL Server
$parameters = @{
    PackageVersion = "6.1.901"
    DbConnectionInfo = @{
       Engine="SqlServer"
       Server="localhost"
       UseIntegratedSecurity=$true
    }
}
 PostgreSQL
$parameters = @{
    PackageVersion = "6.1.901"
    DbConnectionInfo = @{ 
       Engine="PostgreSQL" 
       Server="localhost" 
       Username="postgres"
    }
}
 SQL Server (MultiTenant)
$parameters = @{
    IsMultiTenant = $true
    PackageVersion = "6.1.901"
    DbConnectionInfo = @{
       Engine="SqlServer"
       Server="localhost"
       UseIntegratedSecurity=$true
    }
    Tenants = @{
    	Tenant1 = @{
        	AdminDatabaseName = "EdFi_Admin_Tenant1"
            SecurityDatabaseName = "EdFi_Security_Tenant1"
        }
        Tenant2 = @{
            AdminDatabaseName = "EdFi_Admin_Tenant2"
            SecurityDatabaseName = "EdFi_Security_Tenant2"
        }
    } 
}
 PostgreSQL (MultiTenant)
$parameters = @{
    IsMultiTenant = $true
    PackageVersion = "6.1.901"
    DbConnectionInfo = @{ 
       Engine="PostgreSQL" 
       Server="localhost" 
       Username="postgres"
    }
    Tenants = @{
    	Tenant1 = @{
        	AdminDatabaseName = "EdFi_Admin_Tenant1"
            SecurityDatabaseName = "EdFi_Security_Tenant1"
        }
        Tenant2 = @{
            AdminDatabaseName = "EdFi_Admin_Tenant2"
            SecurityDatabaseName = "EdFi_Security_Tenant2"
        }
    }   
}

Paste the modified parameter code into your PowerShell window and hit Enter.

To enable Year Specific ODS databases, set a valid value for OdsContextRouteTemplate parameter.

An example of a valid value is “{schoolYear:range(2020,2030)}”
Where schoolYear is the Route section, and the range will accept values between 2020 and 2030

Run the Installation Script

Run the following command in the PowerShell window:

Install-EdFiOdsWebApi @parameters

Step 4. Install Swagger

Extract the contents of the "EdFi.Suite3.Installer.SwaggerUI" package. The paths in these instructions assume that the package was extracted to a folder with the name of the package (e.g., C:\temp\EdFi.Suite3.Installer.SwaggerUI).

Prepare Installation Script

Open a PowerShell window in Administrator mode and navigate to the "EdFi.Suite3.Installer.SwaggerUI" folder. Run the following PowerShell command to load modules for installation:

Import-Module .\Install-EdFiOdsSwaggerUI.psm1

The Swagger UI installer can take a number of parameters to tailor the install experience (more examples can be found in the Install-EdFiOdsWebApi.psm1 file). At a minimum, WebAPI connection information is required.

Copy and modify the following parameter code to add your site name:

$parameters = @{
    PackageVersion = "6.1.901"
    WebApiVersionUrl = "https://YOUR_SITE_OR_SERVER_NAME_HERE/WebApi"
}

Paste the modified parameter into your PowerShell window and execute the code.

Run the Installation Script

Run the following command in the PowerShell window:

Install-EdFiOdsSwaggerUI @parameters

Step 5. Install Admin App 

The Admin App provides a graphical interface for platform hosts to administer and manage non-sandbox instances of the Ed-Fi ODS / API. Follow the installation steps here. Alternatively, API keys and secrets can be administered by database administrators via SQL queries as outlined in the article How To: Configure Key / Secret.

Step 6. Restart your Website

Just a few more tasks to complete your installation: 

  • Open IIS (Press the Windows key Windows logo on your keyboard, type IIS, select Internet Information Services (IIS), and press Enter.
  • Right-click on the server (alternatively, you can right-click the EdFi web site), and select Stop.

  • Right-click the server (or EdFi website) again and select Start.

You are now ready to use the Ed-Fi ODS / API. The following URLs are available:

WebsiteURL
Ed-Fi ODS / APIhttps://YOUR_SERVER_NAME_HERE/WebApi/
Ed-Fi Admin Apphttps://YOUR_SERVER_NAME_HERE/AdminApp/

Ed-Fi ODS / API Documentation
(Optional, not for production)

https://YOUR_SERVER_NAME_HERE/SwaggerUI

Contents

Find out more about how to begin using the Ed-Fi ODS / API:

  • No labels