Tool Search: Ed-Fi
This entity represents any type of list of designated students for tracking, analysis, or intervention.
Object Triggering Logic
This table describes logic for triggering syncing of this object.
| Action | Trigger |
|---|---|
| Post | When an Instruction Mode record is added to a student with Instruction Mode = 01, 02, or 03 and Start Date within Scope 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. |
| Delete | If a resource is toggled to 'OFF" after data has sent and an action is performed that would trigger a delete, that data will remain in the ODS until a resync is done. |
| Resync | If a Calendar Event 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 Calendar Event 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: N/A - program ID cannot change. |
| Delete | 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.
|
Resource Preferences
This table describes the Resource Preferences of this object.
| Data Element Label | Mapping Needed |
|---|---|
| Program Category | cohortScopeDescriptor |
| Programs | cohortTypeDescriptor |
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
| campusObjectType | Object Key Data Source |
|---|---|
| Program | programID |
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. |
Object Data Elements
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 | Data Source GUI Path | Database Field |
|---|---|---|---|---|---|
id | The unique identifier of the resource. |
| M |
| |
| cohortIdentifier | The name or ID for the cohort. | Report the name of the cohort.
| M | Program Admin > Programs > Program > Program Name | program. programName |
| educationOrganizationReference | A reference to the related Education Organization resource. | Report the the State District Number. | M | System Administration > Resources > District Information > State District Number | district.number |
| academicSubjectDescriptor | The subject for an academic intervention (e.g., science, mathematics). | This field is optional, does not report. | O | ||
| cohortDescription | The description of the cohort and its purpose. |
| O | Program Admin > Programs > Programs > Description | program. description |
| cohortScopeDescriptor | The scope of cohort (e.g., campus, district, classroom). |
| O | Program Admin > Programs > Programs > Category | program. program Category |
| cohortTypeDescriptor | The type of the cohort (academic intervention, attendance intervention, discipline intervention, breakout session, etc.). |
Namespace: "uri://ed-fi.org/CohortType Descriptor" | M | ||
| programs | An unordered collection of cohortPrograms. The optional program associated with this cohort (e.g., Special Education). | This field is optional, does not report.. | O | ||
| etag | O |
