Ed-Fi v3.X - Sessions Resource Preferences

Tool Search: Ed-Fi Configuration

The Ed-Fi Configuration tool is used to establish Ed-Fi data resources.

The following describes how to set the resource preferences for the Sessions resource. Sessions report the Term Descriptor data entered in the Resource Preferences.   If the Configure or Edit buttons do not display, then the resource does not need to be mapped and the toggle button can be used to turn the resource on or off.

Any item not mapped will not report to Ed-Fi.

  1. Select the appropriate Ed-Fi Code for the Term Descriptors for each school. This page shows all of the unique school, calendar, and schedule structure combinations for the configured year. The filter option at the top of the section can be used to filter by school, term name, term start dates, and/or grade level. The various filter fields determine which information displays. The Fill option can be used to fill the Ed-Fi code value for all fields or all empty fields.

    Select the Ed-Fi Term Type that matches the majority of the sections within the school.
    • Example: If quarters are set on the Calendar and the sections are scheduled for 4 quarters, then the Ed-Fi Term Type for all 4 quarters should be set to Full School Year. 
    • Example: If quarters are set on the Calendar and the sections are scheduled for 2 quarters, then the Ed-Fi Term Type should be set to Fall Semester for Q1 and Q2, and Spring Semester set for Q3 and Q4.

The same Ed-Fi Term Type can be selected for multiple terms if they should be grouped together to make one term. The earliest Start Date and latest End Date will be used in reporting the Sessions resource.

  1.  If Term Descriptors are changed, a resync on Sessions for the impacted school(s) must be completed. If any dependent data of Sessions has been sent for the prior term, the dependent data will be deleted and inserted with the new Term Descriptor. Dependent resources include Courses, Course Offerings, Sections, Student Section Associations, Staff Section Associations, Grades, and Student Section Attendance Events and can potentially cause a large amount of data in the Event Queue to be processed.
    Term Descriptors
    UI LocationSystem Administration > Calendar > Calendar > Terms > Term Name
    FieldDescription
    SchoolUsed to filter by school.
    Calendar
    Used to filter by calendar
    Term NameUsed to filter by term name.
    Term Start DatesUsed to filter by term start date.
    Grade LevelsUsed to filter by grade level.
    Ed-Fi CodeThe Ed-Fi code that will be used to fill all fields or fill all empty fields.
    Fill EmptyThe selected Ed-Fi code will be populated in all empty fields.
    Fill AllThe selected  Ed-Fi code will be populated in all  fields.

    Screenshot of Term Descriptors.Term Descritpors

  2. Select the appropriate Ed-Fi Code for the Term Descriptor Overrides for each course/section that have a different Term Schedule than what was set in Step #1. Only the courses/sections that have the Ed-Fi Term Descriptor Override checkbox marked in Scheduling > Courses > Course and/or Scheduling > Courses > Section display (see screen shot at the bottom of the page). The filter option at the top of the section can be used to filter by school, term start date, term end date, and active courses. The various filter fields determine which courses/sections display. The Fill option can be used to fill the Ed-Fi code value for all fields or all empty fields.

  3. Term Descriptor Overrides should only be set on a course or section if it does not use the same term that is set on the Term Schedule in Step #1.  A new Sessions resource will be created using the Section Placements to determine the Start and End Dates. 

    If Term Descriptor Overrides are changed, a resync on Sessions for the impacted school(s) must be completed. If any dependent data of Sessions has been sent for the prior term, the dependent data will be deleted and inserted with the new Term Descriptor Override. Dependent resources include Courses, Course Offerings, Sections, Student Section Associations, Staff Section Associations, Grades, and Student Section Attendance Events and can potentially cause a large amount of data in the Event Queue to be processed.

Term Descriptor Overrides
UI LocationScheduling > Courses/Sections
FieldDescription
SchoolUsed to filter by school.
Term Start Dates
Used to filter by term start date.
Term End DatesUsed to filter by term end date.
Course Active
Used to filter by active/inactive courses.
Ed-Fi CodeThe Ed-Fi code that will be used to fill all fields or fill all empty fields.
Fill EmptyThe selected Ed-Fi code will be populated in all empty fields.
Fill AllThe selected  Ed-Fi code will be populated in all fields.

Screenshot of Term Descriptor Overrides.Term Descriptor Overrides

3. Click Save.

Additional Sessions Information

Multiple Term Schedules

Using multiple Term Schedules with Ed-Fi is not supported due to the natural key conflicts with the Ed-Fi framework.   If you have courses or sections that align to a different Term Schedule than what is set for Term Descriptors on the Primary Term Schedule, you must use the Ed-Fi Term Override fields on the Course or Section in order to report the proper Term Descriptors to Ed-Fi.   All other data that reports to Ed-Fi with a Sessions reference will report from the Primary Term schedule only.

There is an Ed-Fi Term Descriptor Override checkbox on the Course Editor and Course Section Editor if the Calendar Term selection needs to be different for certain courses or certain course sections.  Once the Ed-Fi Term Descriptor Override checkbox is checked, alternate Terms can be set in the Sessions Resource Preferences.

   Screenshot of Ed-Fi Term Descriptor Override checkbox on Course.   Screenshot of Ed-Fi Term Descriptor Override checkbox on Section.