📢 Tech Docs is going to the cloud! Stay tuned for more as we migrate to Atlassian’s Cloud.
Data Standard & General Tools
MappingEDU
Latest Version: 1.0
Products: Ed-Fi Data Standard, Ed-Fi ODS / API, Ed-Fi Dashboards
Support For: Tech Suite Two & Tech Suite Three
MappingEDU is a web-based system designed to do one common, time-consuming data integration task well: map one data standard to another. The primary users are data analysts and technical staff who create mappings between data sources. MappingEDU also contains features to assist subject matter experts in reviewing data mappings.
MetaEd IDE
Latest Version: 2.0
Product: Ed-Fi Data Standard, Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
MetaEd is a technology framework that uses an Ed-Fi-aligned domain specific language (DSL) to auto-generate software, database, and data standard artifacts.
The internal Ed-Fi Alliance team uses MetaEd to define and produce core components such as the Ed-Fi Standard Interchange Schema (XSD files), the Ed-Fi ODS (SQL Scripts), and technical documentation from a single source definition written in the MetaEd DSL.
A version of MetaEd called the MetaEd IDE supports the generation of Ed-Fi Extensions and all related artifacts. The MetaEd IDE is freely available to licensees.
Sample Data Generator
Latest Version: 1.1
Products: Ed-Fi Data Standard, Ed-Fi Bulk Data Exchange for XML
Support For: Tech Suite Two & Tech Suite Three
The Sample Data Generator produces realistic, cohesive, and 100% fictional datasets for use in demonstrations and testing.
The SDG prefers statistically realistic patterns (e.g., a student with poor attendance generally tracks to poor grades, students are the appropriate age for their grade level, students who are English learners have home languages that track to their ethnicity, and so forth). The system is configurable, and can produce arbitrarily large datasets.
Validation Tool
Latest Version: 1.2
Products: Ed-Fi Bulk Data Exchange for XML
Support For: Tech Suite Two & Tech Suite Three
The Ed-Fi Validation Tool provides an easy and convenient way for developers to validate the XML data files produced by a system against any published version of the Ed-Fi schema.
ODS / API Applications & Tools
Admin App
Latest Version: N.N (New Release: 7/15/2019)
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
The Ed-Fi ODS / API Admin App v1.5 for Technical Suite Two and Technical Suite Three is a web-based administrative interface for the Ed-Fi ODS / API. The Admin App is available as a standalone application, and is also available for deployments on Azure.
Data Import
Latest Version: 1.0 Release Candidate 1
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
Data Import 1.0 is a tool to import CSV files to Technical Suite Two and Technical Suite Three using Ed-Fi ODS / API versions 2.5 and 3.1, and higher.
Latest Version: 3.2
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
The Ed-Fi Learning Standards Sync Utility is a tool for system administrators for synchronizing learning standards between the AB Connect API and a specified Ed-Fi ODS / API instance. Using the tool requires active credentials for both the target Ed-Fi ODS / API instance and the AB Connect API. The Sync Utility application provides a command-line interface (CLI) to set parameters and define options.
ODS / API Utilities
Code Generation Utility
Latest Version: 3.2
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
The Code Generation Utility is an external tool used for generating the required classes, and ORM mappings that are necessary to build the solution. Code generation is required when working on the solution, for the core objects, profiles and extensions.
Client-Side Bulk Load Utility
Latest Version: 3.2
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
The Client-Side Bulk Load Utility is designed to facilitate consistent and efficient loading of XML data files through the API. The primary feature of the tool is the ability to process only those data elements that have changed since the last run. This leads to substantial load time improvements on subsequent loads once an initial full import is completed. Other features include the option to effectively resume a load after stopping as well as the ability to load data using the full security model, including profiles.
Console Bulk Loader
Latest Version: 3.2
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
The Console Bulk Loader is a command-line tool that can be used by platform hosts to initially populate an ODS database with XML data conforming to the Ed-Fi Data Standard.
Migration Utility
Latest Version: 3.2
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
The Migration Utility is a command-line tool built to upgrade the schema of an ODS instance to the latest version. It also supports the execution of custom scripting for the upgrade of extensions.
Security Configuration Tool
Latest Version: 3.2
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
The Security Configuration Tool allows designated administrator users to manage vendor access and permission levels for a production instance of the Ed-Fi ODS / API. The linked documentation walks through the use and deployment of the Security Configuration Tool.
Security Visualization Tool
Latest Version: 3.2
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
Authorization schemes in an Ed-Fi ODS / API implementation are flexible and can be customized to serve a variety of security needs. However, the configuration metadata can be complex, which can make it difficult for administrators to understand exactly what permissions apply for a resource. The Ed-Fi ODS / API solution comes with a command-line Security Visualization Tool to help implementers visualize authorization configurations.
Smoke Test Utility
Latest Version: 3.2
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
The ODS / API Smoke Test Utility is a console application that will run each dynamically generated endpoint of the ODS / API. Its purpose is to verify an installation and operation of an ODS / API, and is useful as part of a continuous build or continuous deployment environment. Although it does not perform complex scenario tests, the Smoke Test tool does methodically perform operations in scenario-like orders.
XML Lookup Utility
Latest Version: 3.2
Product: Ed-Fi ODS / API
Support For: Tech Suite Two & Tech Suite Three
The Ed-Fi Data Standard allows two alternative values for reference types: lookup types and identity types. The Ed-Fi Bulk Load API and the Console Bulk Loader require that identity type references always be used. The XML Lookup Utility is a command-line application that resolves lookup references to identity references in Ed-Fi XML documents. The utility is suitable for interactive or scripted use as part of a larger data-ingestion process.