Tool Search Term: 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 a Program when a student is assigned to a program record in the following areas. The record must overlap the configured year and have a Student School Association record to report.
All students will reference the same program once the first one is created. |
| Delete | If a mapping is removed from Resource Preferences. Programs will only be deleted when a mapping is removed after a resync is completed and 'All Schools' is checked on resync. Programs are at the district level and students in another school may have a Student Program Association record that references the Program. All Student Program Association records must be deleted before a Program can be deleted. |
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. |
| Resync | Programs are only updated/deleted if a mapping is changed after a resync is completed and 'All Schools' is checked on resync. Programs are at the district level and students in another school may have a Student Program Association record that references the Program. |
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
| Logic |
|---|
| The record sends to the scope year for the school year with which the program record is associated. |
| Data only sends for the years that have valid configuration. |
Resource Preferences
| Data Element Label | Mapping Needed |
|---|---|
| Program Type Descriptors | Programs |
| Program Type Descriptors - Flags | Flags |
Identity Mapping Object Key
| campusObjectType | Object Key Data Source |
|---|---|
| Program | programID |
| Plan | 'sped' |
Event Queue Detail
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 Labels in bold are part of the Natural Key and are required data elements for Data to send to Ed-Fi.
| Data Element Label | Business Requirement | Business Rules | M, C or O | Location |
|---|---|---|---|---|
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. |
| M | |
| programTypeDescriptor | The formal name of the program of instruction, training, services or benefits available through federal, state or local agencies. |
| M | |
| educationOrganization Reference | A reference to the related Education Organization resource. | Reports the District Number based on the Local Education Agency resource logic | M | School & District Settings > District > 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 | Student Information > Program Admin > Flags Setup 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 |
