Tool Search: Ed-Fi
This entity represents any program designed to work in conjunction with, or as a supplement to, the main academic program. Programs may provide instruction, training, services or benefits through federal, state or local agencies. Programs may also include organized extracurricular activities for students.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Trigger |
---|---|
Post | When Flag is created and is mapped to an Ed-FI Program Type Descriptor and a resync is completed
|
Post | Post Homeless when a student is given a Homeless record. |
Delete | Programs will not be deleted once they are created |
School Exclude, Calendar Exclude, Resource Toggle and Resync Logic
This table describes the School Exclude, Calendar Exclude, Resource Toggle and Resync logic of this object.
Action | Trigger |
---|---|
None | If a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send. |
Resync | If a record is in the Ed-Fi Identity Mapping table and not in the ODS, it will be deleted from the Ed-Fi Identity Mapping table. |
Resync | If a record is in the ODS and it does not have a matching record in Campus or the Ed-Fi Identity Mapping table, it will be deleted from the ODS. |
Resync | If a mapping is changed in Resource Preferences, a resync will need to be done to reflect the changes. |
Natural Key Changes, Cascading Updates, and Deletes Logic
This table describes the Natural Key Changes/Cascading Updates and Deletes logic of this object.
Action | Trigger |
---|---|
Post/Delete | Natural Key change:
|
Delete | Cascading Deletes: If the Natural Key changes, the following resources will be deleted/reposted.
|
Scope Year Logic
This table describes scope year logic of this object.
Logic |
---|
The record will send to the scope year for the school year the program record is associated with. |
Data will only send for the years that have valid configuration. |
Resource Preferences
This table describes the Resource Preferences of this object.
Data Element Label | Mapping Needed |
---|---|
Program Type Descriptors | Programs |
Program Type Descriptors - Flags | Flags |
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
campusObjectType | Object Key Data Source |
---|---|
Program | programID |
Plan | 'sped' |
Event Queue Detail
This table describes the Event Queue Detail of this object.
Campus Table | Ed-Fi Action | Fields |
---|---|---|
programs | Post | The primary table used for sending data for this resource |
programparticipation | Post | The primary table used for sending data for this resource |
title1 | Post | The primary table used for sending data for this resource |
lep | Post | The primary table used for sending data for this resource |
migrant | Post | The primary table used for sending data for this resource |
homeless | Post | The primary table used for sending data for this resource |
POSEligiblity | Post | The primary table used for sending data for this resource |
Error Log
Error | Possible Causes/How to Fix |
---|---|
409: Failed to delete programs resource. [message:The resource (or a subordinate entity of the resource) cannot be deleted because it is a dependency of the 'generalStudentProgramAssociation' entity.] | There are dependent resources in the Ed-Fi ODS so the Program record cannot be deleted. Use the delete tool to remove any dependent data before the course can be removed. |
Object Data Elements
This table describes data elements sent within the Programs resource.
Data Element Label | Business Requirement | Business Rules | M, C or O | Data Source GUI Path | Database Field |
---|---|---|---|---|---|
id | The unique identifier of the resource. | M | |||
programName | The formal name of the program of instruction, training, services or benefits available through federal, state, or local agencies. | Reports 'Homeless' | M | N/A | N/A |
programTypeDescriptor | The formal name of the program of instruction, training, services or benefits available through federal, state or local agencies. | Reports 'Homeless'. | M | N/A | N/A |
educationOrganizationReference | A reference to the related EducationOrganization resource. |
| M | System Administration> Resources> District Information> State District Number | district.number |
characteristics | Reflects important characteristics of the Program, such as categories or particular indications. | O | |||
learningObjectives | References the LearningObjective(s) with which the Program is associated. | O | |||
learningStandards | LearningStandard followed by this program. | O | |||
programId | A unique number or alphanumeric code assigned to a program by a school, school system, a state, or other agency or entity. |
| O | Program Admin> Flags | program.programId |
services | Defines the services this program provides to students. | O | |||
sponsors | Ultimate and intermediate providers of funds for a particular educational or service program or activity, or for an individual’s participation in the program or activity (e.g., Federal, State, ESC, District, School, Private Organization). | O | |||
etag | O |
Type/Descriptor
This table describes the Ed-Fi Value mapped and reported for ProgramType Descriptor: