Tool Search: Ed-Fi
This educational entity represents the organization of subject matter and related learning experiences provided for the instruction of students on a regular or systematic basis.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
Action | Trigger |
---|---|
Post | When a Flag is created and it is mapped to an Ed-Fi Program Type and the record overlaps the configured year. |
Put | When the student is given an End Date on a reported Flag. |
Delete/Post | When part of the records Natural Key changes:
|
Delete | When a Flag is deleted or when the record no longer overlaps the configured year. |
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 changes:
|
Delete | Cascading Deletes: N/A no resources exists under this resource. |
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 association record is associated with. |
Data will only send for the years that have valid configuration. |
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
campusObjectType | Object Key Data Source |
---|---|
ProgramParticipation | participationID |
Event Queue Detail
This table describes the Event Queue Detail of this object.
Campus Table | Ed-Fi Action | Fields |
---|---|---|
programs | Put | The primary table used for sending data for this resource. |
programparticipation | Put | The primary table used for sending data for this resource. |
Object Data Elements
This table describes data elements sent within the Student Program Association 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 |
|
|
education Organization Reference | A reference to the related EducationOrganization resource. | Reports the District State Number. | M |
| |
programReference | A reference to the related Program resource. | Reports Program reference. | M |
| |
studentReference | A reference to the related Student resource. | Reports the Student Reference. | M |
|
|
beginDate | The month, day, and year on which the Student first received services. | Report the Start Date when reporting from Flags. | M | Student Information> General> Flags> Start Date | programparticipation. startdate |
endDate | The month, day, and year on which the Student exited the Program or stopped receiving services. | Report the End Date when reporting from Flags. | O | Student Information> General> Flags> End Date | programparticipation. enddate |
reasonExitedDescriptor | A unique identifier used as Primary Key, not derived from business logic, when acting as Foreign Key, references the parent table. | Optional, do not report. | O |
|
|
servedOutsideOf RegularSession | Indicates whether the student received services during the summer session or between sessions. | Optional, do not report. | O |
|
|
enrollmentStatus |
| Optional, do not report. | O |
|
|
services | An unordered collection of studentProgramAssociationServices. Indicates the services being provided to the student by the program. | Optional, do not report. | O |
|
|