Michigan Ed-Fi Data v3.1 - Cohorts

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.

ActionTrigger
PostWhen an Instruction Mode record is added to a student with Instruction Mode = 01, 02, or 03 and Start Date within Scope Year.
  • Only a single record is needed for each instruction mode (01, 02, 03). Check to see if record already exists before posting additional resources. There should be 3 total to use as references in StudentCohortAssociation.  

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.

ActionTrigger
NoneIf a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send.
DeleteIf 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.
ResyncIf 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.
ResyncIf 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.
ResyncIf 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.

ActionTrigger
Post/Delete

Natural Key change:  N/A - program ID cannot change.

Delete

The following resources will be deleted/reposted:

  • Student Cohort Associations & Staff Cohort Associations
  • If a mapping to the Ed-Fi Cohort Type Descriptor is removed or changed, a resync must be completed on 'All Schools' to delete/repost Student & Staff Cohort Associations. If only 1 school is selected, only Student & Staff Cohort Association records associated with that school will be updated and the Cohort will remain until a resync on 'All Schools' for Cohorts is completed.


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 years that have valid configuration.


Resource Preferences

This table describes the Resource Preferences of this object.

Data Element LabelMapping Needed
Program CategorycohortScopeDescriptor
ProgramscohortTypeDescriptor


Identity Mapping Object Key

This table describes the Identity Mapping Object Key of this object.

campusObjectTypeObject Key Data Source
ProgramprogramID


Event Queue Detail

This table describes the Event Queue Detail of this object.

Campus TableEd-Fi ActionFields
programsPostThe 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 LabelBusiness RequirementBusiness RulesM, 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.

  • If Instruction Mode = 01, report 'FULLY IN-PERSON'.
  • If Instruction Mode = 02, report 'HYBRID'.
  • If Instruction Mode = 03, report 'FULLY REMOTE'.
MProgram Admin > Programs > Program > Program Name


program. programName

educationOrganizationReference
 
A reference to the related Education Organization resource.

Report the the State District Number.

MSystem Administration > Resources > District Information > State District Numberdistrict.number
academicSubjectDescriptorThe subject for an academic intervention (e.g., science, mathematics).

This field is optional, does not report.

O  
cohortDescriptionThe description of the cohort and its purpose.
  1. Report text in the Description field.
  2. If blank, do not report.
OProgram Admin > Programs > Programs > Descriptionprogram.
description
cohortScopeDescriptor

The scope of cohort (e.g., campus, district, classroom).

  1. Report the mapped Ed-Fi Code from Resource Preferences.
  2. If a Category is not selected on the cohort or the Ed-Fi Code is NULL, do not report.
O Program Admin > Programs > Programs > Category program.
program Category
cohortTypeDescriptor

The type of the cohort (academic intervention, attendance intervention, discipline intervention, breakout session, etc.).

  1. Always reports as "Other"

Namespace:

"uri://ed-fi.org/CohortType Descriptor"

M

programsAn 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  

Type/Descriptor

Click here to expand...

Cohort Type Descriptor

Code ValueDescriptionNamespaceShort Description
Academic InterventionAcademic Interventionuri://ed-fi.org/CohortTypeDescriptorAcademic Intervention
Attendance InterventionAttendance Interventionuri://ed-fi.org/CohortTypeDescriptorAttendance Intervention
Classroom PulloutClassroom Pullouturi://ed-fi.org/CohortTypeDescriptorClassroom Pullout
Counselor ListCounselor Listuri://ed-fi.org/CohortTypeDescriptorCounselor List
Discipline InterventionDiscipline Interventionuri://ed-fi.org/CohortTypeDescriptorDiscipline Intervention
Extracurricular ActivityExtracurricular Activityuri://ed-fi.org/CohortTypeDescriptorExtracurricular Activity
Field TripField Tripuri://ed-fi.org/CohortTypeDescriptorField Trip
In-school SuspensionIn-school Suspensionuri://ed-fi.org/CohortTypeDescriptorIn-school Suspension
OtherOtheruri://ed-fi.org/CohortTypeDescriptorOther
Principal Watch ListPrincipal Watch Listuri://ed-fi.org/CohortTypeDescriptorPrincipal Watch List
Study HallStudy Halluri://ed-fi.org/CohortTypeDescriptorStudy Hall

Cohort Scope Descriptor

Code ValueDescriptionNamespaceShort Description
ClassroomClassroomuri://ed-fi.org/CohortScopeDescriptorClassroom
CounselorCounseloruri://ed-fi.org/CohortScopeDescriptorCounselor
DistrictDistricturi://ed-fi.org/CohortScopeDescriptorDistrict
NetworkNetworkuri://ed-fi.org/CohortScopeDescriptorNetwork
OtherOtheruri://ed-fi.org/CohortScopeDescriptorOther
PrincipalPrincipaluri://ed-fi.org/CohortScopeDescriptorPrincipal
SchoolSchooluri://ed-fi.org/CohortScopeDescriptorSchool
StatewideStatewideuri://ed-fi.org/CohortScopeDescriptorStatewide
TeacherTeacheruri://ed-fi.org/CohortScopeDescriptorTeacher