E10 - Synchronisation to Literatu via Direct Connection

Modified on Thu, 14 Aug at 1:01 AM

TABLE OF CONTENTS


Preamble

Timetabling data that exists in Timetable files 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 can be referenced for:
  1. new school file set up
  2. synchronisation processes
  3. synchronisation troubleshooting
Info


The following information has been provided by the other system and was correct at the time of publication. Please check the other system's documentation for any changes to the process and contact them for any support required, as Tes specialists are not able to advise.

Type of sync

This sync is performed by a 'LISS' sync, which is a sync that sends data at the push of a button with no need to manually upload data into the other system.

Which data is sent to 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 

Yes

Classes
Classes
Yes

Class lists

Yes

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

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
Unsure
Campus code is appearing in the log file with Ttstructure flag. Please with Literatu if MG is supported.
On-call roster
Yes

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

Room data
Room Code
No
Rotation classes
Classes from particular rotations
Yes
Both rotation classes are appearing in the log file. 
RTO roster
No

Student data
Student Id (Code), First name, Surname, Year level, Gender, Email. 
Yes

Study roster
Study classes, staffing and rooming roster
Yes

Sub-classes

No
Teacher data
Teacher Code, Surname name, first name, Faculty, Gender, Guid. 
Yes

Teacher days off (Unavailables)

No

Timetable data

Yes

Two (or more) rooms at once
No

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

Year levels (non-numeric)
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 Literatu.

Steps to synchronise data

Step 1: Check if any Literatu set up is required

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

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 'Literatu' from the drop down menu.

  1. Go to File > Synchronise > Configure >  Connection tab: Enter the following information into the Connection screen:
Options
Details
URL
Contact Literatu for your school's URL
UsernameContact Literatu for your school's Username 
PasswordContact Literatu for your school's Password
School CodeContact Literatu for your school's Password
ProxyNot usually required. See your school network administrator if a proxy message appears after Testing connection. 


  1. Click the 'Test Connection' button to check that the details are correct and the link between Tes and Literatu is working correctly. 
  2. Go to  File > Synchronise > Configure >  Other tab 



OptionDetails
Sync timetable & class lists every time you saveThis will send only the timetable and class membership data to Literatu each time you save the file
Exclude Yard dutiesTicking this option will not send yard duties to Literatu.

Exclude study classes
Ticking this option will not send study classes to Literatu.
Exclude On-calls
Ticking this option will not send On-calls to Literatu.

Which years?
This option allows you to select the specific year levels to sent to School Bytes.

Please leave all of the year levels un-ticked if you want to send everything.

Note. This function will only appear if the etz file is a Multi grid.

Step 3: Perform the sync

  1. Go to File > Synchronise > Sync now.
    There are two sync options: Basic or Advanced.
The Basic sync sends Class lists, Timetable, Duty Roster and Study classes to Literatu for the desired time period, and downloads student and teacher data into the file. 
Warning: The basic sync may download staff data that is not wanted in the .etz file, such as admin and support staff. The Advanced option may be used to avoid this situation.



The Advanced sync allows the user to maintain full control over what data is synced back and forth between Tes and Literatu.
The right hand side box (Timetable--> Literatu server) shows the options for data transfer from Tes into Literatu.


  1. Enter the sync dates. If using the Advanced sync, tick the data that is to be sent/received.
  2. Press Go!
Info


Create support log file: Occasionally, Tes specialists may ask you to perform a sync and tick this box, which will create a text file in the same location as the .etz file. This file can be sent to Tes to help with troubleshooting.

Warning


While Tes support has some understanding of Literatu settings, users must refer to Literatu documentation for detailed Literatu configuration.

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