...
Revision | Author | Date | Comment |
|---|---|---|---|
v1.0 | David Armstrong | 25/07/16 | First Version |
| v1.1 | David Armstrong | 15/05/18 | Move to Confluence |
| v1.2 | David Armstrong | 22/05/18 | Meeting / Unavailable Support. New Action Message Types |
| v1.3 | David Armstrong | 02/01/19 | Yard Duty Extras Support |
| v1.4 | Andrew Rose | 13/09/22 | Timetabler V10 |
| Table of Contents | ||
|---|---|---|
|
...
| Timetabler Version | File Extension | File Type |
|---|---|---|
| 8 | tdfx | Access File |
| 9 | tdf9 | XML File |
| 10 | tfx | JSON file |
Daily organizer organiser database file:
This contains the staff extras / room replacements.
| Timetabler Version | File Extension | File Type |
|---|---|---|
| 8 | dofx | Access File |
| 9 | dof9 | XML File |
| 10 | NOT YET IMPLEMENTED - use version 9 file |
Setup Requirements:
- This is a subscription module which is currently charged along with support. You will need a licence in order to use this process.
- The automatic import first needs to be installed on the SQL server. For Timetabler Version 8 this utilises the Microsoft office Access database engine to connect to the Timetabler databases. There are specific SQL jobs that also need to be created in order for the integration to function.
- The SQL Server service account needs to have access to the folder where the database files are stored. You can view which account this is by opening SQL Configuration Manager.
- Synergetic needs to be configured to point to the Timetabler database location(s) with settings for when& how to import.
...
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| TimetableCode | This is the code that is used when importing the timetable. This is used when creating the linked server to the database and is also populated into the staging tables to differentiate the different imports. | ||||||||||
| Description | A description of the timetable being imported. This is an internal description which isn’t populated through the imports. | ||||||||||
| TimetablePath | The location of the file either on the network or locally on the SQL server itself. This is the location that the SQL server service account needs access to. | ||||||||||
| FileYear | The Year that we are importing into. | ||||||||||
| FileSemester | The Semester / Term that we are importing into. | ||||||||||
| FileType | The FileType we are importing into. | ||||||||||
| ClassCampus | The ClassCampus that is being imported | ||||||||||
| TimetableGroup | The TimetableGroup that is being import | ||||||||||
| TimetableType | What type of import are we doing: Valid Values:
| ||||||||||
| YearLevelFrom | The starting year level that we are importing. The import will only import students who are in the year levels in this range. The year level needs to be set up in Timetabler against the class details. This is imported from the following Timetabler locations:
| ||||||||||
| YearLevelTo | The end year level that we are importing. The import will only import students who are in the year levels in this range. The year level needs to be set up in Timetabler against the class details. This is imported from the following Timetabler locations:
| ||||||||||
| StudentLinkField | Timetabler stores a student code in the database. This is what that code represents in Synergetic and what we will be matching it to. Valid Values:
| ||||||||||
| StaffLinkField | Timetabler stores a staff code in the timetable. This is what that code represents in Synergetic. Valid Values:
| ||||||||||
| ImportOrderSeq | The order that we importing the files in. | ||||||||||
| TimetableOperationMode | This links to luTimetableOperationMode which has various settings for the import. See below for all of the options. Examples might be as follows:
| ||||||||||
| ImportStartDateTime | The date that the import will start from. If the date the import is running doesn’t fall inside this range then nothing will be imported. | ||||||||||
| ImportEndDateTime | The date that the import will end. If the date the import is running doesn’t fall inside this range then nothing will be imported. | ||||||||||
| EnabledFlag | Whether the import is enabled. If this is set to 0 then nothing will be imported for the schedule selected. | ||||||||||
| PeriodOffset | This field allows you to set an offset on the periods that are being imported. This adjusts the timetable period that is being imported by the periodoffset. | ||||||||||
| ImportMeetingsFlag | This Flag controls whether to import meetings from Timetabler. This defaults to 0 (False).
| ||||||||||
| ImportUnavailableFlag | This Flag controls whether to import Teacher Unavailable records from Timetabler. This defaults to 0 (False).
|
...
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| SetExistingNonAssessableFlag | If class not imported for students with matching campus and year level this class is set to non-assessable. | ||||||||
| SetNewNonAssessableFlag | If there are new classes in Timetabler that are not in Synergetic this controls the Assessable flag for these classes. If there are new classes being imported from the import they are set to non-assessable. | ||||||||
| SetStoppedFlag | When Ticked: If the student is in the class currently in Synergetic but no longer in the class in Timetabler then the stop date will be set with the date the timetable import was processed minus 1 day. ie if the import was processed on the 06/02/2021 then the stop date would be 05/02/2021. When Unticked: Students will remain in classes regardless of if they are no longer in the Timetabler import file. New classes will be added in and no stop dates will be updated. | ||||||||
| AllowCoreClassClearFlag | If Set this will also clear Synergetic Classes that are marked as Core Classes. If not set Synergetic Classes that are marked as Core classes are not cleared. | ||||||||
| ClearStaffFlag | Clear the staff against the classes in Synergetic based on the campus that is being imported. Note: this will only clear classes where the Never Clear on Timetable import and Keep Assessable Flags are unticked. | ||||||||
| CreateLuRoomFlag | Creates entries in luRoom in Synergetic based on data from Timetabler if the Room Code exists in Timeabler but not in Synergetic. | ||||||||
| RemoveAsterixFlag | Removes asterixes from the end of the Staff Code from Timetabler before importing. | ||||||||
| UpdateFormFlag | Updates the Synergetic Student Form from Timetabler. This is imported from the following Timetabler locations:
| ||||||||
| ExplodeObjectsFlag | Imports the timetable into Object boookings bookings | ||||||||
| UpdateClassDescriptionFlag | Updates the class description based on the timetable. | ||||||||
| UpdateTutorFlag | Updates the Synergetic Student Tutor from Timetabler. This is imported from the following Timetabler locations:
|
...
| Field | Description | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| StudentCode | Student code from from Timetabler. This is matched to Synergetic based on the StudentLinkField This is imported from the following Timetabler locations:
| ||||||||||||||||||||||
| ClassCampus | ClassCampus from the Synergetic Timetable Configuration | ||||||||||||||||||||||
| ClassCode | ClassCode from the timetable. This is imported from the following Timetabler locations:
| ||||||||||||||||||||||
| ClassDescription | Class Description from Timetabler This is imported from the following Timetabler locations:
The Following Configuration key affects which Name to use. If this is True then the SubjectName is used. If this is false then the ClassName is used.
| ||||||||||||||||||||||
| StudentID | Mapped Synergetic ID Based on the StudentLinkField in the Timetable config and the StudentCode from Timetabler. This is mapped as part of the process. Any that are not mapped will remain as 0. | ||||||||||||||||||||||
| ImportFlag | Whether the record can be imported. If the StudentCode from Timetabler doesn’t match with the relevant Student Code in Synergetic or the class code from Timetabler is too long then the record is not imported. Valid Values:
| ||||||||||||||||||||||
| TimetableCode | Timetable Code from the Synergetic Timetable Configuration |
...
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| TimetableGroup | Timetable Group from the Synergetic Timetable Configuration | ||||||||
| DayNumber | Day Number from Timetabler This is imported from the following Timetabler locations:
| ||||||||
| PeriodNumber | Period Number from Timetabler
| ||||||||
| ClassCampus | ClassCampus from the Synergetic Timetable Configuration | ||||||||
| ClassCode | Class Code from Timetabler. This is imported from the following Timetabler locations:
| ||||||||
| StaffCode | Staff Code from Timetabler. This is matched to synergetic based on the StaffLinkField This is imported from the following Timetabler locations:
| ||||||||
| RoomCode | Room Code from Timetabler This is imported from the following Timetabler locations:
| ||||||||
| StaffID | SynergeticID based on the StaffLinkField and the Staff Code. | ||||||||
| ImportFlag | Whether the record can be imported. If the class code Is too long then the record is not imported. | ||||||||
| ClassDescription | Class Description from Timetabler. This is imported from the following Timetabler locations:
| ||||||||
| TimetableCode | Timetable code from the Synergetic Timetable Configuration. | ||||||||
| PeriodOffset | Period offset from the Synergetic Timetable Configuration. | ||||||||
| MeetingFlag | This records has come from the meetings area in Timetabler. This is handled separately to the Academic Timetable and any staff entered against the meeting will be added. | ||||||||
| UnavailableFlag | This records has come from the meetings area in Timetabler. This is handled separately to the Academic Timetable and any staff entered against as unavailable will be added. These are imported using the following Class Codes:
|
wkxiTimetableSubstitutes
Staging table for student Substitute Classes before importing them into the main Synergetic tables
| Field | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| TimetableGroup | Timetable Group from the Synergetic Timetable Configuration | ||||||||
| TimetableDate | Day of the substitute from Timetabler. This is imported from the following Timetabler locations:
| ||||||||
| DayNumber | Day Number from Timetabler. This is imported from the following Timetabler locations:
| ||||||||
| PeriodNumber | Period Number from Timetabler. This is imported from the following Timetabler locations:
| ||||||||
| ClassCampus | ClassCampus from the Synergetic Timetable Configuration | ||||||||
| ClassCode | Class Code from Timetabler. This is imported from the following Timetabler locations:
| ||||||||
| StaffCode | Staff Code from Timetabler. This is matched to Synergetic based on the StaffLinkField from the Synergetic Timetable Configuration. This is imported from the following Timetabler locations:
| ||||||||
| OriginalStaffCode | Staff Code from Timetabler. This is matched to Synergetic based on the StaffLinkField. This is imported from the following Timetabler locations:
| ||||||||
| RoomCode | Room Code from Timetabler. This is imported from the following Timetabler locations:
| ||||||||
| OriginalRoomCode | Original Room Code. Not supplied in Timetabler. Taken from the Synergetic Timetable. | ||||||||
| StaffID | SynergeticID mapped based on the StaffLinkField and the Staff Code. | ||||||||
| OriginalStaffID | SynergeticID mapped based on the StaffLinkField and the Original Staff Code. | ||||||||
| ImportFlag | Whether the record can be imported. If the StaffCodes doe not match or the class code Is too long then the record is not imported. | ||||||||
| TimetableCode | Timetable code from the Synergetic Timetable Configuration | ||||||||
| PeriodOffset | Period offset from the Synergetic Timetable Configuration |
...
| Key1 | Key2 | Key3 | Key4 | Key5 | Value | |
|---|---|---|---|---|---|---|
| Timetabler | AutoImport | ClassDescription | UseSubjectName | True/False | If True this will Use the Subject Name from Timetabler for the Class Description in Synergetic. If False this will Use the Class Name from Timetabler for the Class Description in Synergetic. | |
| Timetabler | AutoImport | CreateMissingTimetable | True/False | If True this will create the timetable for any classes without students. If False only classes with students will be created. | ||
| Timetabler | AutoImport | YardDuties | Automap | Periods | True/False | If True this will automap distinct Yard duty periods If False this will take the timetable period for the yard duties directly from Timetabler. There can be duplicate period numbers in timetabler as they can be marked before / after a period. True is recommended for Yard duty imports. |
| Timetabler | AutoImport | Timetable | AllowDuplicates | True/False | If False only one staff member is assigned to the timetable record. This is to avoid duplicates in the Staff Timetable. If True any staff members that are listed against the timetable record as assigned. | |
| Timetabler | AutoImport | Extras | DaysAhead | INT | When Importing Extras this controls the number of days ahead you want to process the extras. |
Action
...
Centre Messages
There are several Action Message Types that have been created to assist with the import process:
...