TimetableCell
- Chris Steel
- Hossein Jami
- James Overell
The purpose of this object is to identify a specific cell within a particular TimeTable. A time table is a structure that represents all the available days and times (periods) for which a particular teaching group, or subject can be scheduled.
A TimeTableCell is uniquely identified in the ZIF zone by its GUID.
And the following must be provided at object creation:
- the timetable it belongs to,
- the subject that is being scheduled,
- the teaching group (representing the students, teachers and subject),
- the room that is allocated,
- the allocated teacher.
All local ids in non-authoritative objects are optional. It is therefore up to the provider and the actual agent's design and choreography to determine whether or not to use or local ids from parent objects. There are cases in some subscribing systems where it might not possible to add RefId columns and therefore the RefId of related objects cannot be stored. For example a target system that listens to TimeTableSubject events and updates them may not be able to store the associated SchoolCourseInfoRefId with that object. The only way it can link the TimeTableSubject object with the appropriate course might be through its local course id. Having local ids that link the parent objects with the child object can simplify the agent design. Generally it is suggested to use the appropriate RefIds whenever possible and only use local ids if there is no other way to use RefIds.
| Implemented | Partial or Future Implementation | No Mapping |
| Element/@Attribute | Char | Synergetic Mapping | Description | Type |
|---|---|---|---|---|
| RefId | M | Timetable.SIF3RefID The refid is unique across FileYear, FileType, FileSemester, ClassCampus, ClassCode, TimetableGroup, DayNumber and PeriodNumber | The GUID of the TimeTableCell | RefIdType |
| TimeTableRefId | M | Related TimeTableDefinition.SIF3RefID | The GUID of the TimeTable to which this Cell belongs | IdRefType |
| TimeTableSubjectRefId | O | SubjectClasses.SIF3RefID | The GUID of the Subject that this Cell is scheduling | IdRefType |
| TeachingGroupRefId | M | SubjectClasses.SIF3RefID | The GUID of the TeachingGroup being scheduled | IdRefType |
| RoomInfoRefId | O | <NOT MAPPED> | The GUID of the Resource being Scheduled | IdRefType |
| StaffPersonalRefId | O | Related Staff.StaffSIF3RefID | The GUID of the Staff Member being Scheduled | IdRefType |
| TimeTableLocalId | O | Timetable.TimetableGroup | Time Table Local Identifier | LocalIdType |
| SubjectLocalId | O | <NOT MAPPED> | Subject Local Id | LocalIdType |
| TeachingGroupLocalId | O | SubjectClasses.ClassCode | Teaching Group | LocalIdType |
| RoomNumber | O | Timetable.Room , the record whose StaffLocalID matches the StaffID in SubjectClassStaff.StaffSeq =1 | Room number as presented to the user/application. | HomeroomNumberType |
| StaffLocalId | O | StaffID from SubjectClassStaff.StaffSeq =1 | Staff LocalId | LocalIdType |
| DayId | M | Timetable.DayNumber | Day Id | LocalIdType |
| PeriodId | M | Timetable.PeriodNumber | Period Id within the Day Id | LocalIdType |
| CellType | M | "Teaching" | Type of Lesson/Session eg Teaching, Lunch etc | xs:normalizedString |
| SchoolInfoRefId | O | Config.Value (ExternalSystem>SIF>SchoolInfo>>RefID) | Optional, the GUID of the SchoolInfo Object if this object is known in the zone | IdRefType |
| SchoolLocalId | O | School.SchoolSystemCode | Optional, Local School Id | LocalIdType |
| TeacherList | O | Linked to Timetable.StaffID | A listing of the teachers assigned to the activity, and the type of supervision they are credited with. If no teachers are listed, the activity is assumed to be unsupervised. | ScheduledTeacherListType |
| RoomList | O | <NOT MAPPED> | List of rooms in which the scheduled activity is held. Used for onsite venues which are represented in the source system as rooms. Can include large venues (ovals, library, etc), if they have been represented as rooms; source system practice varies. | RoomListType |
| LocalCodeList | O | <NOT MAPPED> | LocalCodeListType | |
| SIF_Metadata | O | <NOT MAPPED> | SIF_MetadataType | |
| SIF_ExtendedElements | O | <NOT MAPPED> | SIF_ExtendedElementsType |
Table 3.11.10-1: TimeTableCell