-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOC-152] Add Exchange Technology Part B (#127)
- Loading branch information
1 parent
e3a0e22
commit 4bab7a9
Showing
15 changed files
with
465 additions
and
0 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
...arted/edfi-exchange/technology/otised-imart-ed-fi-data-warehouse-starter-kit.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # OtisEd iMart Ed-Fi Data Warehouse Starter Kit | ||
|
|
||
|  | ||
|
|
||
| ## Description | ||
|
|
||
| The OtisEd iMart Data Management solution for data warehousing is a layer of applications which are built on Microsoft SQL Server. The full solution allows for extension and customization of the data model to fit each client's business needs. The Starter kit provided here is a packaged version of the output from the full solution. It can be used as a starting point to build your own customized warehouse. | ||
|
|
||
| This package uses the iMart/Ed-Fi Data Warehouse-Synergyz (1.0) model which specifies 28 tables (both dimensions and facts). Included in this package are the 28 procedures (one per table) that transforms data stored in the Ed-Fi ODS version 3.1 structure to the conform table structures required for loading the data warehouse. These 28 procedures will be referred to as the "Ed-Fi ODS 3.1 Connector". Additional scripts are included to create the database and load the transformed data into the corresponding transactional and analytical data models. | ||
|
|
||
| ## Download | ||
|
|
||
| * **Code:** [https://github.com/Ed-Fi-Exchange-OSS/Ed-Fi-X-OtisEd-iMart](https://github.com/Ed-Fi-Exchange-OSS/Ed-Fi-X-OtisEd-iMart) | ||
| * **Documentation:** [OtisEd - iMart Ed-Fi Data Warehouse Starter Kit.pdf](https://edfi.atlassian.net/wiki/download/attachments/22487677/OtisEd%20iMart%20Ed-Fi%20Data%20Warehouse%20Starter%20Kit.pdf?version=1&modificationDate=1572964568703&cacheVersion=1&api=v2) | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** [OtisEd](https://www.otised.com) | ||
| * **License terms:** Apache 2.0 | ||
| * **Released:** May 20, 2019 | ||
|
|
||
| ## **At a Glance** | ||
|
|
||
| **Generation:** Tech Suite 3 | ||
| **For:** ODS/API v3.1 |
51 changes: 51 additions & 0 deletions
51
docs/getting-started/edfi-exchange/technology/performance-testing-framework.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Performance Testing Framework | ||
|
|
||
|  | ||
|
|
||
| ## Description | ||
|
|
||
| This test suite provides two suites of performance tests for the ODS/API version 5.1, 5.2, and 5.3: GET paging, and SIS Certification tests. | ||
|
|
||
| ### GET Paging | ||
|
|
||
| These tests execute GET requests across all selected resources, paging through all available data. This functionality therefore supports running before/after comparison testing on GET requests, which can help identify missing indexes, assess performance changes in the .NET code, or validate the effects of infrastructure changes (such as adding webserver load balancing or upsizing a virtual machine). | ||
|
|
||
| There are two ways to run these Paging Volume Tests: | ||
|
|
||
| * Directly run the [edfi-paging-test](https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing/blob/main/src/edfi-paging-test) package against an ODS/API 5.1, 5.2, or 5.3 instance, running in any environment and with any database. | ||
| * See the [README](https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing/blob/main/src/edfi-paging-test/README.md) for details on how to run this tool. | ||
| * Or, call `run-tests.ps1` to capture additional Windows Server metrics and logging when running the ODS/API in IIS on Windows with SQL Server on the backend. | ||
| * See the [User Guide](https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing/blob/main/docs/user-guide.md) for a full description of requirements and run instructions. | ||
|
|
||
| ### SIS Certification Tests | ||
|
|
||
| This test suite runs POST, PUT, and DELETE tests on the API resources used in the SIS Certification tests. They can be run in several different modes: | ||
|
|
||
| * Pipeclean - a fast test to ensure all of the endpoints are working | ||
| * Volume - runs many (configurable) clients in parallel for 30 minutes, thus simulating a large volume of simultaneous requests | ||
| * Load - volume testing with a larger client count | ||
| * Soak - longer-term volume testing with a mid-range client count | ||
| * Change Queries - runs through all of the change queries endpoints | ||
|
|
||
| There are two ways to run these tests: | ||
|
|
||
| * Directly run the [edfi-performance-test](https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing/tree/main/src/edfi-performance-test) package against an ODS/API 5.1, 5.2, or 5.3 instance in any environment and with any database. | ||
| * See the [README](https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing/tree/main/src/edfi-performance-test) for details on how to run this tool. | ||
| * Or, call `run-tests.ps1` to capture additional Windows Server metrics and logging when running the ODS/API in IIS on Windows with SQL Server on the backend. | ||
| * See the [User Guide](https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing/blob/main/docs/user-guide.md) for a full description of requirements and run instructions. | ||
|
|
||
| ## Download | ||
|
|
||
| * **Code:** [https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing](https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing) | ||
| * **Documentation:** [README.md](https://github.com/Ed-Fi-Exchange-OSS/Suite-3-Performance-Testing/blob/main/README.md) | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** [Ed-Fi Alliance](https://exchange.ed-fi.org) | ||
| * **License terms:** Apache-2.0 | ||
| * **Released: 17 Aug 2022** | ||
|
|
||
| ## **At a Glance** | ||
|
|
||
| **Generation:** Tech Suite 3 | ||
| **For:** ODS/API v5.1+ |
22 changes: 22 additions & 0 deletions
22
...gy/quick-deploy-of-ed-fi-ods-api-development-server-using-on-premises-server.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Quick Deploy of Ed-Fi ODS / API Development Server Using On Premises Server | ||
|
|
||
|  | ||
|
|
||
| ## Description | ||
|
|
||
| This Powershell script installs the Ed-Fi ODS / API and Admin App binaries for v2.6, v3,2, v3.3, and v3.4 released on MyGet on a Windows machine. | ||
|
|
||
| ## Download | ||
|
|
||
| * ****Code and Documentation:**** [https://github.com/Ed-Fi-Exchange-OSS/Ed-Fi-BinariesPowerShellInstaller](https://github.com/Ed-Fi-Exchange-OSS/Ed-Fi-BinariesPowerShellInstaller) | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** [Michael and Susan Dell Foundation](https://www.msdf.org) | ||
| * ****License terms:**** Apache 2.0 | ||
| * **Released:** April 22nd, 2020 | ||
|
|
||
| ## At a Glance | ||
|
|
||
| **Version:** Tech Suite 2 & 3 | ||
| **For:** ODS/API v2.x, v3.2, v3.3, 3.4 |
27 changes: 27 additions & 0 deletions
27
docs/getting-started/edfi-exchange/technology/response-to-intervention-app.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Response to Intervention App | ||
|
|
||
| ## Description | ||
|
|
||
| The Response to Intervention (RTI) web application was developed and allows district users (teachers, etc.) to input student's assessment scores as well as student interventions. This web application supports the following functionality: | ||
|
|
||
| * Assessment metadata creation/management | ||
| * Intervention metadata creation/management | ||
| * Student assessment score entry | ||
| * Student intervention recording | ||
| * Analytics on assessment scores | ||
| * Analytics on intervention effectiveness | ||
|
|
||
| ## Download | ||
|
|
||
| * ****Code & Documentation:**** [https://github.com/Ed-Fi-Exchange-OSS/Response-to-Intervention](https://github.com/Ed-Fi-Exchange-OSS/Response-to-Intervention) | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** [Center Grove Community School](https://www.centergrove.k12.in.us/CGHS) & [Edwire](https://www.linkedin.com/company/edwire/about/) | ||
| * ****License terms:**** Apache 2.0 | ||
| * **Released:** September 2020 | ||
|
|
||
| ## **At a Glance** | ||
|
|
||
| **Generation:** Tech Suite 3 | ||
| **For:** ODS / API v3.2 |
22 changes: 22 additions & 0 deletions
22
docs/getting-started/edfi-exchange/technology/resultant-techdocs-chatbot.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Resultant TechDocs Chatbot | ||
|
|
||
| <img src="https://edfidocs.blob.core.windows.net/$web/img/edfi-exchange/technology/resultant.png" width="250" /> | ||
|
|
||
| ## Description | ||
|
|
||
| A Resultant developed AI chatbot, using Replicate and the Llama 3 LLM, to make navigating the Ed-Fi Technical documentation a breeze. Instead of digging through pages of information, you can now ask straightforward questions and get clear, concise answers. Plus, if you're a developer, the chatbot can provide code examples for working with the Ed-Fi ODS/API, saving you time and effort. | ||
|
|
||
| ## Download | ||
|
|
||
| * **Code & Documentation: [https://github.com/Resultant-Software-Engineering/edfi-chatbot-nextjs](https://github.com/Resultant-Software-Engineering/edfi-chatbot-nextjs)** | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** Resultant | ||
| * **License Terms:** Apache 2.0 License | ||
| * **Released:** July 2024 | ||
|
|
||
| ## **At a Glance** | ||
|
|
||
| **Generation:** Tech Suite 3 | ||
| **For:** All Ed-Fi Solutions |
25 changes: 25 additions & 0 deletions
25
docs/getting-started/edfi-exchange/technology/sample-data-equity-analysis.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Sample Data Equity Analysis | ||
|
|
||
|  | ||
|
|
||
| ## Description | ||
|
|
||
| The Ed-Fi Alliance's sample data sets have realistic but fictional names, attached to realistic but fictional schools and local education agencies. Do these data sets unduly perpetuate any demographic biases or demographic skew with respect to key student performance indicators? | ||
|
|
||
| To this end, we have developed a [Jupyter Notebook](https://jupyter.org/) for performing rigorous statistical analysis on an ODS database: [Ed-Fi Sample Data Equity Analysis](https://github.com/Ed-Fi-Exchange-OSS/Sample-Data-Equity-Analysis/blob/main/Equity-Analysis.ipynb) | ||
|
|
||
| ## Download | ||
|
|
||
| * **Code:** [https://github.com/Ed-Fi-Exchange-OSS/Sample-Data-Equity-Analysis](https://github.com/Ed-Fi-Exchange-OSS/Sample-Data-Equity-Analysis) | ||
| * **Documentation:** see code repository | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** [Ed-Fi Alliance](https://exchange.ed-fi.org) | ||
| * **License terms:** Apache-2.0 | ||
| * **Released: 11 Nov 2022** | ||
|
|
||
| ## **At a Glance** | ||
|
|
||
| **Generation:** Tech Suite 3 | ||
| **For:** Any version of the ODS/API with Analytics Middle Tier installed. |
24 changes: 24 additions & 0 deletions
24
docs/getting-started/edfi-exchange/technology/sdcoe-universal-transcript.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # SDCOE Universal Transcript | ||
|
|
||
|  | ||
|
|
||
| ## Description | ||
|
|
||
| The transcript prototype is an exploration into the potential of digital learner records. Our concept was to build a working prototype transcript technology around the ODS, essentially around the idea of reading data from multiple ODS’s using Ed-Fi Composites, assembling student transcript data into an electronic document (JSON file), leveraging blockchain technology for validating a transcript and identify document tampering, and generating printable transcripts. | ||
|
|
||
| The scope of this project defines a primary goal of producing an digital printable student transcript (PDF) with data drawn from one or more ODS’s in an electronic form that can be validated using blockchain technology. | ||
|
|
||
| ## Documentation & Code | ||
|
|
||
| * **[View it on GitHub](https://github.com/Ed-Fi-Exchange-OSS/SDCOE-Universal-Transcript)** | ||
| * [SDCOE Transcript - Design Details](./sdcoe-universal-transcript.md) | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** [San Diego County Office of Education](https://www.sdcoe.net/) | ||
| * ****License terms:**** Apache 2.0 | ||
| * **Released:** 09 Sep 2021 | ||
|
|
||
| ## **At a Glance** | ||
|
|
||
| Compatible with Ed-Fi Tech Suite 3 |
29 changes: 29 additions & 0 deletions
29
...change/technology/sfusd-finance-extension-model-for-local-education-agencies.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # SFUSD Finance Extension Model for Local Education Agencies | ||
|
|
||
| [ | ||
|
|
||
| [SFUSD](https://www.sfusd.edu/) | ||
|
|
||
| ## Description | ||
|
|
||
| San Francisco Unified School District (SFUSD) additions to the Ed-Fi X Finance extension model that includes a Chart Of Accounts and account dimension tables for use at the LEA-level. Files will include a detailed document of the use cases and proposed model modifications, the MetaEd files used for the extension model, UML diagrams, and sample ETL code used to load the finance data from SFUSD's source system. | ||
|
|
||
| ## Download | ||
|
|
||
| * **Code:** [https://github.com/Ed-Fi-Exchange-OSS/Finance-Model-LEA-Extensions](https://github.com/Ed-Fi-Exchange-OSS/Finance-Model-LEA-Extensions) | ||
| * **Documentation:** | ||
| * [Readme](https://github.com/Ed-Fi-Exchange-OSS/Finance-Model-LEA-Extensions) | ||
| * [SFUSD Finance Model - Use Cases Summary.docx](https://github.com/Ed-Fi-Exchange-OSS/Finance-Model-LEA-Extensions/blob/main/Documentation/SFUSD%20Finance%20Model%20-%20Use%20Cases%20Summary.docx) | ||
| * [SFUSD Finance Model - Ed-Fi Glossary.xlsx](https://github.com/Ed-Fi-Exchange-OSS/Finance-Model-LEA-Extensions/blob/main/Documentation/SFUSD%20Finance%20Model%20-%20Ed-Fi%20Glossary.xlsx) | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** San Francisco Unified School District | ||
| * ****License terms:**** Apache 2.0 | ||
| * **Released:** July 2020 | ||
| * **Updated**: March 2021 | ||
|
|
||
| ## **At a Glance** | ||
|
|
||
| **Generation:** Tech Suite 3 | ||
| **For:** ODS/API 3.4.1 and Data Standard 3.2.0-b (forward compatible to Data Standard 3.3.x with small changes) |
26 changes: 26 additions & 0 deletions
26
docs/getting-started/edfi-exchange/technology/student-engagement-management.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # Student Engagement Management | ||
|
|
||
|  | ||
|
|
||
| ## Description | ||
|
|
||
| This project aims to create an Ed-Fi Technical Suite 3-powered Student Engagement Management application that provides executives, district and campus administrators, and teachers with a set of dashboards and custom reports to help raise warning signs of disengaged students. | ||
|
|
||
| ## Download | ||
|
|
||
| * **Code :** [https://github.com/Ed-Fi-Exchange-OSS/Student-Engagement-Management](https://github.com/Ed-Fi-Exchange-OSS/Student-Engagement-Management) | ||
| * **Documentation:** [https://github.com/Ed-Fi-Exchange-OSS/Student-Engagement-Management/blob/main/Installation README.md](https://github.com/Ed-Fi-Exchange-OSS/Student-Engagement-Management/blob/main/Installation%20README.md) | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** [Blue Learning](https://bluelearning.com/), under a grant from the Michael & Susan Dell Foundation | ||
| * **License Terms:** Apache 2.0 License | ||
| * **Released:** December 2023 | ||
|
|
||
| ## At a Glance | ||
|
|
||
| **Generation:** 3 | ||
|
|
||
| **For:** ODS/API 5.3 | ||
|
|
||
| _Likely compatible with ODS/API 6.1 ,and ODS/API 7.1 when using Data Standard 4.0_. |
17 changes: 17 additions & 0 deletions
17
docs/getting-started/edfi-exchange/technology/student-engagement-tracking.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Student Engagement Tracking | ||
|
|
||
|  | ||
|
|
||
| ## Description | ||
|
|
||
| This tools enable enables student engagement tracking and reports for remote learning. Tracking of learning events is enabled though a Chrome plugin. The reports cover some basic measures to track student engagement during COVID-19 and Remote Learning. | ||
|
|
||
| ## Download | ||
|
|
||
| * ****Code & Documentation:**** [https://github.com/Ed-Fi-Exchange-OSS/Ed-Fi-X-StudentEngagement](https://github.com/Ed-Fi-Exchange-OSS/Ed-Fi-X-StudentEngagement) | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** [Michael and Susan Dell Foundation](https://www.msdf.org) | ||
| * ****License terms:**** Apache 2.0 | ||
| * **Released:** August 2020 |
38 changes: 38 additions & 0 deletions
38
...tting-started/edfi-exchange/technology/student-survey-dashboard-for-teachers.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Student Survey Dashboard for Teachers | ||
|
|
||
|  | ||
|
|
||
| ## Description | ||
|
|
||
| Project Buzz is a mobile tool that puts roster, contact information, and student survey results into the hands of teachers. | ||
|
|
||
| The tool provides an educator with three views into their student’s data: | ||
|
|
||
| 1. **Rostering.** This shows teachers all their students along with contact information like school email, primary guardian contact information, and contact notes, and can be filtered by class or student name. | ||
| 2. **Student Detail.** This view contains an expanded contact section containing siblings and other guardians. The student detail view also shows teachers how their students answered each survey. | ||
| 3. **Survey Results.** This allows teachers to look into a survey and see how their students responded. The survey viewer provides a quick summary of the results and an easy navigation to the individual student’s responses. | ||
|
|
||
| Project Buzz also provides a way for teachers to add notes/feedback on their students. This functionality provides an important way for teachers to include commentary and updates in conjunction with the contact information and student responses they are already working with. | ||
|
|
||
| > [!INFO] | ||
| > View a 3 minute overview of the Buzz tool [here](https://vimeo.com/edfialliance/review/476016090/458295ac13). | ||
| ## Demonstration | ||
|
|
||
| You can try out Project Buzz by visiting [buzz-demo.ed-fi.org](http://buzz-demo.ed-fi.org). | ||
|
|
||
| **Log-In:** You can log in to the demonstration account by using any valid google account. Buzz Demo will log you in as a sample teacher with sample data. | ||
|
|
||
| ## Download | ||
|
|
||
| * **Code & Documentation:** [https://github.com/Ed-Fi-Exchange-OSS/EdFi-Project-Buzz](https://github.com/Ed-Fi-Exchange-OSS/EdFi-Project-Buzz) | ||
|
|
||
| ## Details | ||
|
|
||
| * **By:** [Ed-Fi Alliance](https://www.ed-fi.org) | ||
| * ****License terms:**** Apache 2.0 | ||
| * **Released:** July 2020 | ||
|
|
||
| ## **At a Glance** | ||
|
|
||
| Compatible with Ed-Fi Tech Suite 2 & 3 |
Oops, something went wrong.