How-To Guides
This section contains How-To Guides and other instructional material useful to developers in implementing the Ed-Fi ODS / API.
How To: Add API Composites to the Ed-Fi ODS / API Solution
The Ed-Fi Alliance is phasing out support for Composite and recommends against implementing any new composites in 2026 or beyond.
How To: Add Profiles to the Ed-Fi ODS / API
This example outlines the steps necessary to integrate and activate Ed-Fi
How To: Clear expired client access tokens with a database job
Currently, the API handles clearing expired client access tokens with a
How To: Configure Claim Sets
The API claim sets for the Ed-Fi ODS / API are stored in EdFi_Security
How To: Configure Key / Secret
API keys and secrets can be administered by the Admin App or Sandbox Admin App,
How To: Create a Custom Populated Template
The Ed-Fi ODS / API ships with a sample dataset containing approximately 1000
How To: Create an Extension Plugin
In this example, we will create an extension plugin and publish it to NuGet
How To: Create and Manage API Security Metadata using Declarative Security Policies
Introduction
How To: Deploy an Extension Plugin
In this example, you will learn how to install a pre-published extension plugin
How To: Enable logging API request and response content
This example will show how the content of the requests and responses for the web
How To: Extend the Ed-Fi ODS / API - Student Transcript Example
In this example, we will create a new domain entity called Student Transcript.
How To: Extend the Ed-Fi ODS / API - Student Transportation Example
In this example, we will create a new domain entity called Student
How To: Load the ODS with Sample XML Data using Bulk Load Client Utility
This article uses the core sample data released with Ed-Fi Data Standard v4.0.
How To: Load the TPDM Sample XML Data using Bulk Load Client Utility
This article describes the steps needed to populate an Ed-Fi ODS with sample
How To: Use an External Cache Provider for the Ed-Fi API
By default, the Ed-Fi ODS / API uses an internal memory cache in order to increase the performance when mapping URIs for descriptors, and UniqueIds for staff, students and parents to their ODS-specific surrogate id values. Ed-Fi ODS / API also provides an optional feature to use an External or Distributed Cache option such as Redis, a distributed memory cache which, in a multi-server environment, can prevent cached data on multiple servers from getting out of sync and be more cost effective. For information on getting started with Redis Cache check out//redis.io/docs/getting-started/
How To: View Security Configuration Details
The [Security Visualization