Overview

Admin App v2.0.0 supports the ability to administrate multiple instances within a single version of the applications. Admin App supports two roles for this, Super-Administrator who can view and register all ODS / API instances and its functions, and Administrator who is assigned particular ODS / API instances and its functions. It is important to note that Admin App will administrate existing instances of the ODS / API, not create ODS / API instances. They must exist prior to using them within Admin App. Shared instance mode is still supported within Admin App.

The ODS / API modes supported by multi-instance management within Admin App are:

1. District-Specific ODS Configuration
2. Year-Specific ODS Configuration

General Configuration

General

When multi-instance mode is enabled, user can navigate to ODS Instances list by clicking on “ODS Instances” from Home page.

If user is not having any registered instance, then will be directed to Register ODS Instance page for registering a new instance. Otherwise will be presented with available ODS instances.

ODS Instances

District-Specific Mode

  Clicking on District / EdOrg id link will take user to ODS instance specific settings page.

Year-Specific Mode

Clicking on the school year will take user to year-specific ODS instance settings page.

Registering New ODS Instance

Checklist

     Use this checklist and the details below for successful ODS instance registration:

•  Database should exist on the server

          With provided District/EdOrg id or school year, the system will generate valid instance name (Database name). 

          Ex: District/EdOrg id provided by user = 255901

                EdFi_Ods_Production database name on web.config = EdFi_{0}

                Then generated ODS instance name will be = EdFi_Ods_255901

                User has to make sure, the database (EdFi_Ods_255901) exists on the server.   

•  Generated ODS instance / database name length should be below 50 characters.

District-Specific Mode

For creating ODS instance, user needs to provide valid District/EdOrg id and description.

Year-Specific Mode

For creating ODS instance, user needs to provide valid school year and description.

Register Many Instances in Bulk:

User can register many instances in bulk, by providing list of District/EdOrg ids or school years, descriptions as in the form of csv file.

NumericSuffix,Description
255901,Sampledistrict1
255902,Sampledistrict2
255903,Sampledistrict3
255904,Sampledistrict4

NumericSuffix,Description
2019,Description1
2020,Description2
2021,Description3