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
This section outlines the steps necessary to integrate and activate the Ed-Fi Composite definitions for use in an Ed-Fi ODS / API. It is assumed that the Ed-Fi ODS / API has been successfully downloaded and is running in a local environment per the instructions in the Getting Started documentation.
📄️ How To: Add Profiles to the Ed-Fi ODS / API
This example outlines the steps necessary to integrate and activate Ed-Fi Profile definitions for use in an Ed-Fi ODS / API. To be able to update profile definitions at run-time without rebuild and redeployment, it is preferred to configure profile definitions in the EdFi_Admin database. Alternatively, you can define profile via embedded resource in a C# project as described in Appendix A.
📄️ 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 the EdFi_Security database. Out of the box, Ed-Fi ODS / API has a set of default claim sets pre-loaded:
📄️ How To: Configure Key / Secret
API keys and secrets can be administered by the Admin API or Sandbox Admin App, but some implementers may prefer to work directly with the data. The SQL queries on this page enable a database administrator to create keys and secrets. These queries run against the EdFi_Admin database.
📄 ️ How To: Configure ODS Instances
The Ed-Fi ODS / API expects that the ODS connection strings are configured in the EdFiAdmin database. After deploying your ODS(s), configure connections in the EdFiAdmin database by running these queries.
📄️ How To: Create a Custom Populated Template
The Ed-Fi ODS / API ships with a sample dataset containing approximately 1000 students. This sample is used to automatically populate test and sandbox environments.
📄️ How To: Create an Extension Plugin
In this example, we will create an extension plugin and publish it to a NuGet feed, which can then be placed in the plugin folder of a pre-deployed ODS / API to extend it.
📄️ 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 in your local development environment as well as in your production deployment environment. For details on how to create and publish extension plugin see How To: Create an 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 Identities API
The Ed-Fi Identities API provides an
📄️ How To: Extend the Ed-Fi ODS / API - Alternative Education Program Example
In this example, we will create a new program called Alternative Education
📄️ 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 Transportation. This entity will be exposed in Ed-Fi ODS / API through a new API resource called studentTransportations.
📄️ 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
📄️ 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
📄️ How To: Use the Northridge Populated Template
The Ed-Fi ODS / API ships with a sample dataset containing approximately 1000
📄️ How To: View Security Configuration Details
The [Security Visualization