Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


Info

In the Admin App v1.8 for ODS / API v3.4, the Claim Set Editor was promoted to a supported feature. The documentation for the feature can be found in the /wiki/spaces/ADMIN/pages/25238340 section of the Admin App User Guide. Version 1.7 of the Admin App contained a preview version. This is the documentation for the preview in v1.7.

This section describes how to enable the Claim Set Editing tab in the configuration for Admin App. This feature is a preview feature for v3.3 and disabled by default

...

with a new installation of the Admin App for v1.

...

7 of the Admin App.

Overview

Admin App users may choose to enable the "Claim Sets" tab found within the Admin App ODS Instance Settings

...

. For more information on enabling the claim set editing feature set for the Admin App, please see

...

Checklist

...

below

...

  •  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

...

:

  • 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

Admin App Configuration

Admin App requires

...

a single configuration

...

change in the Web.config file in order to enable

...

the 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.

Image Modified

Step 2. Configure for

...

Claim Set Editor tab

In Web.config,

...

to

...

Image Removed

...

enable Claim Set Editing functionality inside Admin App,

...

change the IsClaimSetsTabEnabled item to have a value of true as shown below

...

in the AppSettings node in Web.config

...

:

Image Added

Claim Sets Tab

After the above configuration change, the Claim Sets tab can be accessed within the Admin App ODS Instance Settings as seen below:
Image Added

Reporting Issues

If you encounter issues related to configuration of the Admin App, please create a ticket in the Ed-Fi Tracker system (in the EDFI project).