E10 - Synchronisation to Engage (DoubleFirst) via Direct Connection

Modified on Thu, 14 Aug at 1:03 AM

TABLE OF CONTENTS

Preamble

Timetabling data that exists in the 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


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 a 'LISS' sync, which is a sync that sends and receives 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?

This table lists many of the data and features found in Tes and and whether they are 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 Timetable feature
Notes on feature
Is this feature received
by the other system?
Other notes
Bell times
Bell times as per Grid structures
No

Campuses
Campuses and their associated rooms
 Unsure

Classes
Classes as per Class data screens
Yes

Class lists

Yes

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

Duty roster

Yes

Faculty data

Yes

Grid structure codes

Unsure

Multi-file
Two (or more) timetable files
Unsure

Multi-grid
Multiple grids with different bell times
Unsure
On-call roster

Unsure

Priority classes
The priority class that shows on student's timetables where they have class clashes
Unsure

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

Rotation classes
Classes from particular rotations
Unsure

RTO roster

No

Student data
No

Study roster
Study classes, staffing and rooming roster
Unsure

Sub-classes

Unsure

Teacher data
No

Teacher days off (Unavailable)

No

Timetable data

Yes

Two (or more) rooms at once
A class with two or more rooms at the same time
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, Yr9+10 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 the Timetable file. 
Unsure - The data is being sent from the Timetable file but we are unsure if it is being processed and supported by 3rd party system. 

Steps to synchronise data

Step 1: Set up the Engage Doublefirst Sync

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

Step 2: Configure the Timetable File

  1. Go to File > Synchronise > Configure >  Connection tab: Enter the following information into the Connection screen:
OptionDetail
URL
Contact Engage (Double First) support for your school's URL
Username
Engage (DoubleFirst) username
Password
Password
School code
School code is provided by Engage (DoubleFirst)
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 the Timetable file and Engage (DoubleFirst) is working correctly. 
  2. Go to  File > Synchronise > Configure >  Other tab 



Option

Details

Sync timetable & class lists every time you save

Sends enrolment data to Engage (DoubleFirst) upon every save. 

Exclude Yard Duties

When ticked, Yard duties are not sent

Exclude Study Classes

When ticked, Study classes are not sent

Exclude On-call

When ticked, On-calls are not sent

Accept Statewide ID's that are sent to the Timetable file (recommended)

Student Id's can be displayed in Students > Student data > View > Statewide ID

When downloading the list of students, what format?

Select whether the formal or preferred name for the students are downloaded.

Which years?

- Sync all year levels: By default, all year levels are ticked, in which case all year levels will be synced.
 


- Sync some year levels: Select only the desired year levels where not all year levels should be synced. Include Meetings if duties are to be included, as this is where duties are stored.



This option will become available if the file is a Multi Grid file. It allows you to indicate which Year levels are synced to.


Step 3: Perform the sync

  1. Go to File > Synchronise > Sync now.
    There are two sync options: Basic or Advanced.

Basic Sync

The Basic sync sends Classes, Class lists and the Timetable to Engage (DoubleFirst) for the desired time period, and downloads student data into the file. 
To perform a Basic sync:
  1. Go to File>Synchronise>Sync Now, and select ‘Basic’ 
  2. Ensure ‘Engage (DoubleFirst)’ is selected from the dropdown in the top-right corner.
  3. Input the date range you wish to update for.
  4. Click ‘Go’ to sync.


Notes


Check course codes:  Click this button to see if there is any confusion over course code that Engage might not support. Engage only takes the course code into consideration and not the class identifier so if if you have two similar course codes, but different subject names, then Engage will pick one of the subject names for both course codes. e.g. if you have class codes 11AHI.H1 (History), 11AHI.S2 (Ancient History) with the same code of AHI, Engage will pick randomly one of the course names and assign it to both. 
Warning


The basic sync may download staff data that is not wanted in the timetable file, such as admin and support staff. The Advanced option may be used to avoid this situation.

Advanced Sync

The Advanced sync allows the user to maintain full control over what data is synced back and forth between the Timetable file and Engage (DoubleFirst).
The left hand side section (Engage (DoubleFirst) --> Timetable) shows download options for data transfer from Engage (DoubleFirst) into the Timetable file.
The right hand side box (Timetable--> Engage (DoubleFirst) server) shows the options for data transfer from the Timetable file into Engage (DoubleFirst).
To perform an Advanced sync:
  1. Go to File>Synchronise>Sync Now, and select ‘Advanced’ 
  2. Ensure ‘Engage (DoubleFirst)' is selected from the dropdown in the top-right corner.
  3. Select which data you want to sync to Engage (DoubleFirst)
  4. Enter the sync dates and relevant rotation.
  5. Click ‘Go’ to sync


Info


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

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