BETA TESTING DOCUMENTATION

DISCLAIMER: This documentation is intended solely for use by authorized Beta testers. The features and enhancements described herein are part of a pre-release version and are not yet publicly available. We anticipate general availability in Summer 2025. Content is subject to change without notice and should not be shared outside the Beta testing group.

Ed-Fi Code Mappings Tab


Data in the Aeries database consists of raw data and codes. The code values will need to be mapped to Ed-Fi descriptors or Ed-Fi types before they can be uploaded to the ODS. To assist with this process,  we have created the Ed-Fi Code Mappings tab. Aeries has supplied default mapping to give the user a starting place with their mappings. The user can clear them, manually map, and load the default mappings back as needed. See Aeries Code Sets for more information.


TABLE OF CONTENTS

Tables & Security


Table or AreaPermissionDescription
Ed-Fi Code MappingsReadView the Ed-Fi Code Mapping tab 
Read, AdministerView, Add, Update, and delete information on the Ed-Fi Code Mapping tab (i.e. full access to all functions on the page) 


Code Mappings

When opening the Ed-Fi Code Mappings tab, begin by selecting an Ed-Fi Configuration. If a configuration is already selected—typically the first one in your list—all associated code sets for that configuration will be displayed. The system now searches and displays all codes by default. However, users do have the option to filter the view to show only mapped codes if they prefer once in edit mode. 


At the top of the tab, a summary panel provides a snapshot of the current mapping status:

  • Total Descriptors: The number of Ed-Fi descriptors defined in the selected configuration.
  • Mapped Codes: The number of local codes that have been successfully mapped.
  • Unmapped Codes: The number of local codes to be mapped.

A search bar is available to help you quickly locate a specific code set, and an Update Local Codes button allows users to quickly navigate to the Update Local Code page within Aeries. 


For each code set, the following details are displayed:

  • Aeries Field
  • Ed-Fi Descriptor
  • Total Codes
  • Mapped Codes
  • Unmapped Codes

Users with the appropriate permissions can click on a code set to view or manage its mappings.

 


Aeries Code Sets

Aeries has supplied default code mappings for code sets. Information on specific Default Mappings, please see Ed-Fi Standard Default Mappings or TSDS Ed-Fi Default Mappings documentation for details.

The user, with Administrator permissions, will select a code set to edit. A user with read permission can view the code set, but cannot make any changes. 


Code Mappings

Mapping the Aeries codes to the Ed-Fi descriptors and types.

The Code Mapping interface in Ed-Fi allows users to align codes with standardized Ed-Fi Descriptors. This ensures that Ed-Fi-compliant systems accurately interpret data exported from Aeries.


The Code Mapping tab, once a code set is selected includes:

  • Aeries Field Name: The local code used in Aeries (e.g., A, B, C).
  • Description: A brief explanation of what the code represents (e.g., UNVERIFIED, Bereavement).
  • Ed-Fi Descriptor: The standardized Ed-Fi URI that corresponds to the Aeries code.

Filter the list by:

  • All Codes
  • Mapped Codes
  • Unmapped Codes


How to Use Code Mappings

Review Existing Codes

  • Browse the list to see which Aeries codes are already mapped and which are not.
  • Identify Unmapped Codes
  • Use the Unmapped Codes filter to quickly find codes that need attention.


Assign Ed-Fi Descriptors

For each unmapped code:

  • Click into the Ed-Fi Descriptor field and search for a descriptor within the dropdown.
  • Select or enter the appropriate Ed-Fi URI (e.g., uri://ed-fi.org/AttendanceEventCategoryDescriptor#ExcusedAbsence).
  • Save Changes
  • Ensure all mappings are saved before exiting the screen.


Functionalities:

Type to Search: Type to search for a specific Descriptor within the dropdown.

Load Default Mappings: If default mappings are available for a given code set, clicking the Load Default Mappings button will automatically apply those defaults to the corresponding codes. This feature streamlines the setup process by pre-populating mappings based on standard configurations.

Clear All: Mass clear all mappings.

Save: Any changes will be saved.

Cancel: Omit any changes.


Note: Ed-Fi descriptors can exist in multiple namespaces. So, Aeries always stores the Ed-Fi descriptors and their namespace together (as shown below).



When you are done with your mappings click the 'Save' button at the bottom of the page and your changes will be saved.

Remove Mapping

You can click the delete icon 

 to remove Aeries code mappings.

Add Mapping

If you wish to add a new Aeries code for mapping, you must first go to the Update Local Codes page.
(a link is available in the upper right corner of the Ed-Fi Code Mapping tab). Any custom mappings added from the 'Update Local Codes' page will automatically be applied to the code mapping. 






When complete, come back to the Ed-Fi Mappings page to see the Local Codes display within the list.

Now the user can map the codes to an associated Ed-Fi Type (or descriptor).



Note: Detailed Default Aeries Mappings can be found for Texas and California.