Calendars (Arizona v3.6)

This entity represents a set of dates associated with an organization.

Object Triggering Logic

This table describes logic for triggering syncing of this object.

ActionTrigger
Post

A Calendars record will be created for each Calendar/Schedule Structure combination.

  • When a new Calendar and Schedule Structure is created and saved via the Calendar Wizard.
  • When a new Schedule Structure in an existing Calendar is created and saved.
  • Do not send a record if the Calendars resource is toggled 'OFF' in the Calendars Resource Preferences.

  • Do not send a record if the Calendar is mapped to an override calendar in the Resource Preferences > Calendars > Calendar Override Mapping tool.
  • Do not send a record if the Calendar 'Days Per Week' field is blank/null.
Put

When fields that are not part of the natural key are changed.

  • If the Type is changed on the Calendar tab.
  • When a grade level is deleted from the Grade Levels tab it will be removed from the array.
  • When a grade level is added to the Grade Levels tab and a mapping exists already for that grade level.
Delete

If a calendar and/or schedule structure is deleted.

  • If a previously created Calendars record has been sent, then it is subsequently mapped to a different calendar via the Calendar Override Mapping tool, and a resync of the Calendars resource is performed.
Delete/PostDelete if a 2nd Schedule Structure is added after 1st Calendar is sent.


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
NoneNo data will send if the School or Calendar is marked as Exclude.
DeleteIf the Calendar is marked as exclude after the Calendar or any dependent data is sent, the calendar and all dependent data will delete upon a resync even if the resource is toggled 'OFF'.
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.
ResyncIf a Calendar 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 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:  If a 2nd schedule structure is added after data is sent, the first Calendar record will need to be Deleted/Posted with new Calendar Code logic to be Calendar ID + Schedule Structure ID.

  • If a calendar or schedule structure is moved via script, all data send to the ODS will remain and the Delete tool will need to be used to remove all data sent.

  • If the School ID changes, a delete/post will occur with the cascading deletes from the School ID change triggers.


Scope Year Logic

This table describes scope year logic of this object.

Logic

Calendars will only send for the school year to which they are aligned. 

  • Data will only send for years that have valid configuration.
  • A resync must be completed on the resource when a new scope year is connected in order for this data to send.


Resource Preferences

This table describes the Resource Preferences of this object.

Data Element LabelMapping Needed
calendarTypeDescriptorcalendar.type
gradeLevelDescriptorUses the overall 'Grade Levels' mapping


Identity Mapping Object Key

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

campusObjectTypeObject Key Data Source
ScheduleStructurestructureID


Event Queue Detail

This table describes the Event Queue Detail of this object.

Campus TableEd-Fi ActionFields
calendarPost/Put/DeleteThe primary table used for sending data for this resource.
gradelevelPutWill update the Grade Levels field if a grade level is added/removed to the school and a mapping exists for that grade level.


Error Log

This table describes the Error logic of this object.

ErrorPossible Causes/How to Fix
403 Forbidden:

{"message": "Access to the resource could not be authorized for the requested action 'http://ed-fi.org/odsapi/actions/create'."}

This is usually caused by a security set up error in the ODS.  Contact the Ed-Fi Alliance for assistant on correct security setup in the ODS.
Error code return from Ed-Fi. 400: [message:Validation of 'Calendar' failed.  CalendarTypeDescriptorId is required.].The Type field is not selected on the Calendar that is being sent or the Type selected on the Calendar is not mapped to an Ed-Fi Code in Resource Preferences.


Object Data Elements

This table describes data elements sent within the Calendars resource.

Data Element LabelBusiness Requirement
M, C or O

Data Source 

GUI Path

Database Field
idThe unique identifier of the resource.M

Calendar Code

The identifier for the Calendar.

Report the following values, concatenated with dashes
between each value, in the following order:

  1. District Entity ID Override
    1. If NULL, District Entity ID
  2. School Entity ID
  3. Calendar Days Per Week
  4. Structure ID
M

System Administration > Resources > School > District Entity ID


System Administration > Resources > District Information Entity ID


System Administration > Resources > School > Entity ID


System Administration > Calendar > Calendar > Days Per Week


System Administration > Calendar > Calendar > Schedule Structure > Structure ID

CustomSchool.value

district.entityID

School.entityID

Calendar.daysPerWeek

CustomCalendar.value

ScheduleStructure.structureID

SchoolReference

A reference to the related School resource.

Reports the fields that are part of the Natural Key
for the Schools resource.

M

SchoolYear
TypeReference

A reference to the related School Year resource.

Reports the End Year the calendar is associated.

M

calendarType
Descriptor

Indicates the type of Calendar. (Numeric Track
Identifier. (Track 01, 02…))

Reports the Ed-Fi Code the Calendar Days Per Week i
s mapped to in Calendar Resource Preferences.

MSystem Administration > Calendar > Calendar > Calendar > Days Per WeekCalendar.daysPerWeek

calendarLocal

Education

AgencyReference

LEA Identity Column - the LEA reporting the
calendar information.

Reports the value, if it exists.

  1. If it does not exist, then do not report.
MSystem Administration > Resources > District Information > district record > Entity IDDistrict.entityID
beginDateReport the first day marked as Instructional tied to the calendar.MSystem Administration > Calendar > Calendar > Days > date record > Instructional
endDateReport the last day marked as Instructional tied to the calendar.MSystem Administration > Calendar > Calendar >
Days >
date record > Instructional

totalInstructional
Days
Calculate the total number of
days with the "Instructional"
checkbox checked, and report
that value.
MStudent Information > calendar > Calendar > Day > Instructional

trackLocal

Education

AgencyReference

localEducation

AgencyId

Report the value

  • localEducationAgencyId
  • link
Report the override value on
the School editor if it's filled in;
if not, report the number on the
District editor.
M

Override, if it exists: System Administration > Resources > School > school record > District Entity ID


System Administration > District Information > district record > Entity ID

Calendar.distrcitID

School.districtEntityID

gradeLevels

Indicates the GradeLevel associated with the Calendar.

  1. Reports all unique Grade Levels for the Calendar/Schedule
    Structure that are mapped to an Ed-Fi Grade Level.
    a.  Do not report if the Grade Level is in a Calendar marked
    as Exclude.
  2. If a grade level is not mapped, do not report.

Do not report if the Grade Level is in a Calendar marked as Exclude.

OSystem Administration> Calendar> Calendar> Grade Grade Levelsgradelevel.name


Type/Descriptor

This table describes the Ed-Fi Value mapped and reported for Calendar Type Descriptor:

Code ValueDescriptionNamespaceShort Description
Student SpecificStudent Specific
uri://ed-fi.org/CalendarTypeDescriptor
Student Specific
IEPIEP
uri://ed-fi.org/CalendarTypeDescriptor
IEP