Wisconsin Ed-Fi Data v3.3 - Sessions

Tool Search: Ed-Fi

This entity represents the prescribed span of time when an education institution is open, instruction is provided and students are under the direction and guidance of teachers and/or education institution administration. A session may be interrupted by one or more vacations.

Object Triggering Logic

This table describes logic for triggering syncing of this object.

ActionTrigger
Post

When a new Term is created and saved that is Mapped to a Term Type and a resync of Sessions is completed.

  • If the same Term Type is selected on multiple Terms, group the Terms together so only 1 record will report per Term Type.
  • If there are multiple Calendars or Schedule structures in a School with the same Term Types, only 1 record can report to Ed-Fi.  Report the earliest Term Start Date and latest Term End Date.
  • Do not send records if the Calendar Exclude check box is checked.

  • Do not send if  the School is marked as  Exclude.
  • Do not send records if the Calendar is marked Summer School.
  • If Ed-Fi Configuration Profile = Choice OR Choice + Private Opt In, do not send a record.
Post

When a Term Descriptor Override is selected on a Course or Section and saved and the course is mapped to a Term Descriptor Override and a resync of Sessions is completed.

  • The Session will report the start and end dates based on the mapping of the course section.
  • If the same Term Type is selected in the Terms tab and the Term Type Override, a record will not send from the override field.
  • Do not send records if the Calendar Exclude check box is checked or Course is marked as Inactive or Exclude.
PutWhen the Grading Period data is changed or the Grading Period record is deleted.
DeleteIf the Term is deleted or the mapping is removed the Session record and all dependent data will be removed

** Start and End dates are not part of the natural Key so only 1 record per Term Type can be sent to Ed-Fi.  Logic has been implemented to determine the priority of what start and end dates to use for a Term Type.


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 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 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
Delete/Post

Natural Key change:

  • If the School ID changes, all data will remain under the old number and a resync will need to be completed to populate data under the new number. The delete tool would need to be used to remove all data from the old School ID.

Delete/PostIf the Session Name changes.
Delete/Post

If the natural key changes all dependent resources will delete/post.

  • Course Offerings, Sections, Staff Section Associations, Student Section Associations, Student Section Attendance Events, Grades


Scope Year Logic

This table describes scope year logic of this object.

Logic
Reports Sessions for the scope year the to which the calendar is aligned.
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.

*If there are multiple terms, overridden courses, or overridden sections in a school with the same term descriptor, there will be an identity mapping record for each Campus record and they will have the same edFiIdentityID.

Where  Posting FromcampusObjectTypeObject Key Data Source
Course overrideCoursecourseID
Section overrideCoursecourseID-sectionID
TermTermtermID


Event Queue Detail

This table describes the Event Queue Detail of this object.

Campus TableEd-Fi ActionFields
TermPost/Put/DeleteThe primary table used for sending data for this resource.
CoursePost/Put/DeleteThe primary table used for sending data for this resource.
SectionPost/Put/DeleteThe primary table used for sending data for this resource.
sectionPlacementPutStart/End Date


Error Log

This table describes the Error logic of this object.

ErrorPossible Causes/How to Fix
Error code return from Ed-Fi. 400: [message:Validation of 'Session' failed.  BeginDate is required.  BeginDate : '1/1/0001 12:00:00 AM' must be within SQL datetime range ('1/1/1753 12:00:00 AM' to '12/31/9999 11:59:59 PM')  EndDate is required.  EndDate : '1/1/0001 12:00:00 AM' must be within SQL datetime range ('1/1/1753 12:00:00 AM' to '12/31/9999 11:59:59 PM') ].Term start or end dates are missing


Object Data Elements

This table describes data elements sent within the Sessions resource.

Data Element LabelBusiness RequirementBusiness RulesM, C or O

Data Source GUI Path

Database Field
idThe unique identifier of the resource.


M

SessionName

The identifier for the calendar for the academic session.

  1. Reports the Term Descriptor of the Term(s) being reported.
MSystem Administration> Ed-Fi> Configuration> Resources Preferences> Sessions> Ed-Fi Codeedfimapping.edFiValue
schoolReferenceA reference to the related School resourc.e
  1.  Reports the fields that are part of the Natural Key for the School resource.


M

schoolYearTypeReferenceA reference to the related SchoolYearType resource.
  1. Reports the end year from the calendar the term is reported.
    • Reports 'XXXX'.
M

academicWeeksAn unordered collection of sessionAcademicWeeks.This is optional, do not report.O

beginDate Term start date
  1. Report the start date of the term being reported:
    • If more than 1 term has the same Term Type selected, report the earliest start date.
    • When Term Descriptor Override is populated, report from the Term Descriptor Override.
MSystem Administration> Calendar> Calendar> Terms> Start Date

term.startDate

endDateTerm end date
  1. Report the end date of the term being reported:
    • If more than 1 term has the same Term Type selected, use the latest end date.
    • When Term Descriptor Override is populated, report from the Term Descriptor Override.
MSystem Administration> Calendar> Calendar> Terms> End Date term.endDate
gradingPeriodsAn unordered collection of sessionGradingPeriodsSee the Grading Periods in the Array section below for logic.

O



termDescriptorThis descriptor defines the term of a session during the school year (e.g., Fall Semester).
  1. When reporting from Term Descriptors mapping, report the Ed-Fi Code for the value selected.
    • When Ed-Fi Term Type is Null, or when no Ed-Fi code exists, do not report.
  2. When reporting from the Term Descriptor Overrides, report the Ed-Fi code value selected.
M

System Administration> Ed-Fi> Configuration> Resources Preferences> Sessions> Ed-Fi Code

edfimapping.edFiValue
totalInstructionalDaysTotal Days in Session 
  1. When reporting from Term Schedule, count the total number of instructional days from the Days tab from the calendar and schedule structure the term is associated with:
    • A day reset must be completed before the days will calculate.  Use the resync after day reset is completed to have instructional days calculated and sent.
    • If more than 1 term schedule has the same Term Type, count the distinct number of instructional days from all terms for that Term Type.
    • When Term Descriptor Override is populated, report from the Term Descriptor Override.
M Calculated

Arrays

Click here to expand...

Grading Periods

Data Element LabelBusiness RequirementBusiness RulesM, C or O

Data Source GUI Path

Database Field
gradingPeriodReferencereference to the related Grading Period resource
  1. Report all Grading Periods that are mapped to the term schedules that are used to report the session and has a Grading Period End Date that overlaps the term being reported:
    • Grading Period End Date must be on or after Session Start Date and on or before Session End Date.
    • When Term Descriptor Override is populated, report from the Term Descriptor Override.
M


Type/Descriptor

Click here to expand...

Term Descriptors

CodeEd-Fi Code ValueEd-Fi Short DescriptionEd-Fi Description
10B10th Block10th Block10th Block
1B1st Block1st Block1st Block
1Q1st Quarter1st Quarter1st Quarter
1S1st Semester1st Semester1st Semester
1T1st Trimester1st Trimester1st Trimester
2B2nd Block2nd Block2nd Block
2Q2nd Quarter2nd Quarter2nd Quarter
2S2nd Semester2nd Semester2nd Semester
2T2nd Trimester2nd Trimester2nd Trimester
3B3rd Block3rd Block3rd Block
3Q3rd Quarter3rd Quarter3rd Quarter
3T3rd Trimester3rd Trimester3rd Trimester
4B4th Block4th Block4th Block
4Q4th Quarter4th Quarter4th Quarter
5B5th Block5th Block5th Block
6B6th Block6th Bock6th Bock
7B7th Block7th Block7th Block
8B8th Block8th Block8th Block
9B9th Block9th Block9th Block
AAnnualAnnualAnnual