E10 - Synchronisation to JSON Timetable via Export

Modified on Thu, 14 Aug at 1:01 AM

Timetabling data that exists in Tes Timetable file are usually sent on to one or more other non-Tes systems, such as student learning management systems, reporting systems, administration systems, and many more. The Tes integration team works with other systems to make sure that the data required to be sent is in the correct format.
This document outlines the synchronisation process to JSON Timetable.
  1. new school file set up
  2. synchronisation processes
  3. synchronisation troubleshooting
Info


While Tes takes all care to ensure any mention to the other system is correct and up to date, it is the user's responsibility to check with the other system prior to an initial sync. If the user becomes aware of any changes to the other system, we would very much appreciate this feedback.

Type of sync

This sync is performed by exporting a csv file that has been correctly formatted, ready uploading into JSONTimetable.

The JSONTimetable export function will export one TXT file:
  1. TIMETABLE.TXT

Which data is sent to the other system?

This table lists many of the data and features found in Tes and, where known by Tes specialists, whether they are also understood by the other system.
Alert


Note that Tes builds many excellent features to help users build high quality timetables, and while these features can be sent onto the other system through the synchronisation process, not all systems have built the capability on their end to receive/display these features.
Tes featureNotes on feature
Is this feature received
by the other system?
Other Notes
Bell times
No

Classes
Classes as per Class data screens
Yes

Class lists

No

Composite (linked) classes
One teacher teaching more than one class at the same time
No

Duty roster
Yes
Faculty data

Yes

Grid structure codes

Yes
Multi-file
Two or more .etz timetable files
No
Multi-gridMore than one bell times structures set up
No
On-call roster
Yes

 Priority classes

The chosen class on a student's timetable where they have class clashes.

Yes

Room dataRoom Code, Name, Size, Campus, Comment
Yes

Rotation classes
Classes from particular rotations
Yes
File is exported based on the current rotation of the file. 
RTO roster
Yes

Student data
Student Code, Name, Preferred name, Year level, Letter group, House, Gender, StatewideID, Email, Phone
Yes

Study roster
Study classes, staffing and rooming roster
Yes

Sub-classes

Yes

Teacher data
Teacher Code, Name, Preferred name, Faculty, Gender, Email, Phone
Yes


Teacher days off (Unavailables)

No

Timetable data

Yes

Two (or more) rooms at once
Self-explanatory
No

Two (or more) teachers at once
A class with two or more teachers at the same time
No

Year levels
Year levels such as SPT, LSUP, ROLL etc
Yes


Yes - The data is sent from our end and is being received and processed by 3rd party system. 
No - The data is not supported by 3rd party systems and is not sent from Tes. 
Unsure - The data is being sent from Tes but we are unsure if it is being processed and supported by JSONTimetable.

Steps to synchronise data

Step 1: Check if any JSON Timetable set up is required

Many systems require some set up prior to receiving timetable data from Tes. Check with JSONTimetable.

Step 2. Configure the Tes Timetable file

  1. Open the relevant Timetable file, and go to File > Synchronise > Configure > Sync tab
  2. Select the + button and choose 'JSON Timetable' from the drop down menu.


Info


Multiple systems can be set up to sync. It is common to have both the Edval webserver, the schools learning management system configured, along with any other systems the school wishes to regularly sync to.
  1. Select the Configure button, which will move you to the Connection tab. A destination folder must be selected to direct where the .csv files will be saved. Select Browse and locate or create the desired location.
Select Connection:
  1. Enter the name of the folder where the export csv is to be stored.


Info'Sync each time you save' - This means, sync will occur automatically on a ctrl-S save. In this case, data is first saved locally to disk, and then an attempt is made to sync with all external systems. This is simple, but you may want to disable this if the external systems or your network is slow to sync, or you want more control about 'when' you publish data through to other systems. No message is shown on a sync-on-save, as it is done quietly. Only active sync via menu/ctrl-K will show a completion message.

Step 3: Perform the sync export

  1. Go to File > Synchronisation > Sync now.
  2. Ensure ‘JSONTimetable’ is selected from the dropdown in the top-right corner.
  3. Select Create TT publish file
  1. Select OK


You can navigate to the file location to look at the data if desired.





The below table explains what type of data the csv file contains when exported:
TimetableDetailsExample
Timetable DataCurrent Rotation, Year level, class code, Membership, Subjects, Courses, Class ID, Class Type, Teacher, Lessons (Day, Year, Period, Class, Teacher, Room){"CurrentRotation":2,"timetable":[
{"year":"7",
"code":"7MAT2",
"membership":["09064","09058",
"classtype":"",
"teacher":"AGGA",
"lessons":[
{"day":2,
"year":"7",
"period":"2",
"class":"7MAT2",
"teacher":"AGGA",
"room":"R18"},

Step 4: Upload/Import the TXT files into JSONTimetable

Info


Please refer to JSONTimetable documentation for instructions on how to upload/import the TXT file.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article