...

Expand

title	Mermaid diagram

Code Block

sequenceDiagram
    actor Sys Admin

    rect rgb(191, 223, 255)
    note right of Sys Admin: One time setup.

        Sys Admin->>Config Service: POST /connect/register
        Config Service->>Identity Provider: Create credentials
        note right of Identity Provider: Created with config role
        
        Config Service-->>Sys Admin: clientCredentials
    end

    Sys Admin->>Config Service: POST /v2/vendors
    Config Service->>Config Database: INSERT dbo.Vendor

    Sys Admin->>Config Service: POST /v2/applications

    Config Service->>Identity Provider: Create credentials
    note right of Identity Provider: Created with dms role
    Identity Provider-->>Config Service: clientCredentials
    Config Service->>Config Database: INSERT dbo.Application
    Config Database -->>Config Service: applicationId
    Config Service->>Config Database: INSERT dbo.ApplicationEducationOrganization
    Config Service->>Config Database: INSERT dbo.ApiClient

    Config Service-->>Sys Admin: clientCredentials

...

Roadmap

Getting to a pilot-ready release candidate by Tech Congress was always going to be challenging. The team has been working hard, but we need to adjust the milestones and expectations for release candidate 1.

Goals for release candidate are broadly:

Deployable and fully functional in the basic CRUD operations on all Resources and Descriptors.
Proper error handling and edge case management.
Performance on par with the ODS/API.
Be useable for basic field testing and non-critical path use cases.

While we want to be looking ahead to supporting state agency use, at the 2024 Summit we agreed to prioritize service provider / LEA usage scenarios first. Given that,

...

Milestone

...

Functional Goals

...

Basic timeline

Tech Congress 2025 - release candidate with “basic” feature set useable for pilot testing typical data exchange scenarios.

Info

Focused primarily on LEA and vendor-to-vendor scenarios.

State scenarios are critical for this project. The Alliance will be designing for state usage scenarios before Tech Congress 2025, but not prioritizing delivery.

Summit 2025 - production-ready version 1.0

Info

Aiming for feature parity with the ODS/API from the perspective of API-based integrations, with one primary exception: no plan to support XML-based composites.

States should be able to pilot test at this point.

Feature List

Note

Reviewing the list below:

Which features listed “By Summit” should we prioritize to try to release sooner?
Are there any features we failed to list?

Data Standard and API Standard Compatibility

0.2

Status

colour	Green
title	DONE

📢 Milestone 0.2.0 has been reached!
.NET application with PostgreSQL storage
Level 0 and Level 1 document validation
Reference and descriptor validation
Error message like ODS/API 7.2
Docker and Kubernetes

0.3

Feature

ODS/API Platform

Data Management Service

By TC

By Summit

Resources API - core Ed-Fi Data Standard

Status

colour	Green
title	done

Compliant Discovery API, Descriptor API, and Resource API definition (except GET by query): able to run bulk upload, smoke test. Includes JSON validation based on API schema file. Fake OAuth (1).

Descriptor API - core Ed-Fi Data Standard

Status

colour	Green
title	done

Discovery API

Status

colour	Green
title	done

Data Standard version independence

Status

colour	Blue
title	MUST HAVE

MetaEd-based extensions

Status

colour	Blue
title	MUST HAVE

Dynamic Profiles

Status

colour	Blue
title	must have

Multiple data standards in same deployment

Status

colour	Yellow
title	Could Have

Note
Does anyone want this?

XML Composites

Status

colour	Red
title	WOn't Have

Data Integrity and Validation Features

Feature

ODS/API Platform

Data Management Service

By TC

By Summit

Level 0 and level 1 validation

Status

colour	Green
title	done

Descriptor validation

Status

colour	Green
title	done

Reference validation

Status

title
colour	Green

DONE

Streaming data out via Kafka

GET by query using OpenSearch

done

Cascading updates on

allowed key changes

Abandoned direct Kubernetes support as too costly

by 10/1 (Ed-Fi Summit)

0.4

key changes

Status

colour	Green
title	done

Concurrency management with ETags

Status

colour	Blue
title	MUST HAVE

Level 2 validation via SQL scripts

Status

colour	Blue
title	MUST HAVE

Once a compatibility layer is available, will be able to run the same SQL scripts used today for Level 2 validation

Realtime level 2 validations via streaming data

Status

colour	Yellow
title	Could Have

Note
Does anyone want this? Might be more of a demonstration than a core feature of the system

Database Technologies

Feature

ODS/API Platform

Data Management Service

By TC

By Summit

Core database storage in PostgreSQL

Status

colour

Blue

title
Green

in progressToken authorization

done

The database structure is very different than the ODS database

Core database storage in MSSQL

Status

colour

Green

title
Blue

DONEClient credentials management

	MUST HAVE

GET queries using search database

Status

title
colour	Green

DONENamespace authorization

done

Either OpenSearch or Elasticsearch

GET queries using relational database

Status

colour

Yellow

title
Blue

nextBONUS: Elasticsearch/Kibana instead of OpenSearch/OpenSearch Dashboard

MUST HAVE

Removes the requirement to run Kafka and OpenSearch or Elasticsearch

Reporting queries using ODS database schema

Status

colour

Green

title
Blue

DONE

0.5

Design spikes around ed-org authorization

MUST HAVE

Note

This will likely be a compatibility layer to ease the transition for those who have built reporting solutions on the ODS database structure.

Is this required for state-based pilot testing? Can it be finalized after the 1.0 release?

Core database storage in managed PostgreSQL-compatible databases (e.g. Aurora, Cosmos DB)

Status

colour	Purple
title	SHOULD Have

Conceptually this should work, but we may need community help for testing these scenarios while the development team focuses on code-level features.

Data Management Features

Feature

ODS/API Platform

Data Management Service

By TC

By Summit

Streaming data out via Kafka

Status

colour	Green
title	done

Change Queries API

Status

title
colour	Purple

DONEConcurrency management with eTags

	SHOULD Have

Required for API Publisher synchronization; if not implemented must provide alternative.

Security Features

Feature

ODS/API Platform

Data Management Service

By TC

By Summit

API-driven client credential management

(Admin API)

Status

colour

Red

title
Green

DEFER?Extensions

	done

OAuth token authentication

Status

colour

Red

title
Green

DEFER?Multiple data standards

	done

Integration with third party OAuth identity providers

Status

colour

Red

title
Blue

DEFER? (DS 5.2)

0.6

Dynamic profiles

	MUST HAVE

At minimum, will support Keycloak, with clear path for supporting other providers

API-driven claimset management

(Admin API)

Status

colour	Blue
title	MUST HAVE

Namespace authorization

Status

colour	Blue
title	MUST HAVE

Relationship authorization

Status

colour	Blue
title	MUST HAVE

Ownership authorization

Status

colour

Red

title
Blue

DEFER?Multitenancy and routing

MUST HAVE

Combined authorization

Status

colour

Red

title
Blue

DEFER?

0.7

Education organization authorization

	MUST HAVE

Extensible authorization filtering

(7.3)

Status

colour	Blue
title	MUST HAVE

Deployment Management

Feature

ODS/API Platform

Data Management Service

By TC

By Summit

Docker images

Status

colour

Purple

title
Green

Move upClaimset customization

	done

Multitenancy routing and instance management

Status

colour

Red

title
Blue

DEFER?

...

MUST HAVE

PowerShell installation scripts for Windows Server

Status

colour	Yellow
title	Could Have

Note
Does anyone want this?

Deployment orchestration via (Kubernetes, Terraform, Cloud Formation, ARM, etc.)

(though there are Exchange contributions)

Status

colour	Red
title	WOn't Have

Unless a community member contributes

Other Integrations

Feature

ODS/API Platform

Data Management Service

By TC

By Summit

SwaggerUI

Status

colour	Blue
title	must have

Admin Console

coming soon

Status

colour	Blue
title	must have

Design Questions

What plans are there for error detection (i.e. dropped records) and correction?

...

Version	Old Version 4	New Version 5
Changes made by	Stephen Fuqua	Stephen Fuqua
Saved on	Dec 04, 2024	Dec 04, 2024

Page Comparison

Versions Compared

Key

Roadmap

Basic timeline

Feature List

Data Standard and API Standard Compatibility

Data Integrity and Validation Features

Database Technologies

Data Management Features

Security Features

Deployment Management

Other Integrations

Design Questions

What plans are there for error detection (i.e. dropped records) and correction?