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

Version 1 Next »

Use this checklist and the details below to modify your ODS and Admin App to run in Year Specific mode

  • ODS API: configure the ODS API Web.config for YearSpecific startup
  • ODS SwaggerUI: configure the swagger.webApiMetadataUrl to contain the configured year. For example, http://localhost:54746/metadata/{year}/
  • ODS Database: Rename the EdFi_Ods database to EdFi_Ods_2019
  • Admin App: update database value in EdFi_Ods_Production connectionString
  • Admin App: enable and configure year specific app settings yearSpecific:isEnabled and yearSpecific:year

ODS Web API and SwaggerUI Config

The ODS API and SwaggerUI each require changes to configure them in Year Specific mode. If installed through exe installers you can locate the Web.config for each by using IIS. Right click "Explore" on the web application and then find the Web.config file.


In the SwaggerUI Web.config, make the following changes:

  1. Update swagger.webApiMetadataUrl to contain a school year

In the WebApi Web.config, make the following changes:

  1. Update the owin:appStartup app setting to have the value of "YearSpecific"

ODS Database Name

In Year Specific mode, the database has to be identified with a "_{year}" value at the end of the name. The easiest way to achieve this at the moment is to install the database as normal, either through the initdev process, or through the exe installers. Once installed, you can manually rename the database through Sql Sever Management Studio

Admin App Config

Admin App requires three configuration changes in the Web.config file in order to enable connections to a Year Specific ODS. To find the Web.config file, open IIS Manager and navigate to the AdminApp web application. Right click and select the "Explore" option. This will open the installation directory of Admin App where you will find Web.config.


In Web.config, make the following changes:

  1. Set the "EdFi_Ods_Production" connection string to contain the year specific database name created while setting up the ODS. The example below uses the "EdFi_Ods_2019" database and windows authentication

  2. To enable year specific functionality inside Admin App add the two items shown below into the AppSettings node in Web.config, placing them below any items that already exist.






  • No labels