This section describes how to enable the Claim Set Editing tab in the configuration for Admin App. This feature is by default disabled with a new installation of the Admin App. However, the as-shipped configuration for the Admin App has a feature flag (disabl;ed by default) which can be enabled in order to access the Claim Set Editor tab within the ODS instance settings.

Overview

Admin App users may choose to enable the "Claim Sets" tab within the Admin App ODS Instance Settings. Year-Specific mode is supported and configuration instructions are below. For more information on enabling the claim set editing feature set for the Admin App, please see below:

...

Use this checklist and the details below to modify your Admin App configuration in order to enable the Claim Set Editor tab

•  Admin App: enable and configure year specific app settings yearSpecific:isEnabled and yearSpecific:year

Year-Specific Configuration

ODS Web API and SwaggerUI Config

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

Image Removed

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

• Update swagger.webApiMetadataUrl to contain a school year.

Image Removed

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

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

Image Removed

ODS Database Year-Specific Naming Convention

In Year-Specific mode, the database is identified with a "_{year}" suffix value in the database name. To enable, install the database as usual, either through the initdev process or through the Windows Installers for the Ed-Fi ODS / API Suite 3. Once installed, you can manually rename the database through SQL Server Management Studio by right clicking on the database name and selecting "Rename":

Image Removed

• IsClaimSetsTabEnabled.

Admin App Configuration

Admin App requires three a single configuration changes change in the Web.config file in order to enable connections to a Year Specific ODSthe Claim Set Editor Tab.

Step 1. Locate the Web.config file

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.

Step 2. Configure for

...

Claim Set Editor tab

In Web.config, make the following changes:Change 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:

Image Removed

Changes 2 & 3. To enable year-specific enable Claim Set Editing functionality inside Admin App, add the two items item shown below into the AppSettings node in Web.config, placing them below any items item that already existexists.

Image RemovedImage Added

Reporting Issues

...