Timetable Daily: Synchronisation set up for Compass via Direct Connection

Modified on Thu, 14 Aug at 12:53 AM

Add Compass as a sync system

Go to Daily > Synchronise
Choose 'Add sync system'

Note: Event type 'Exams' or the 'Exam module' created in Timetable Daily are appearing in Compass on 'Teachers and students' timetable (schedule) when an Advanced sync is performed from Timetable Daily to Compass.

There is also a requirement of making sure the 'Exam' setting in Compass is set to ON in Administration Tools --> Subject Manager ( Subject and Classes) --> Settings.

Compass currently only accepts the 'Cancellation' and 'Exam' events, all other events are not used. This does mean the 'Split Classes' function is not supported by Compass at this time.

While we do send the data, Compass does not currently support 'Replace', 'Move and Replace' functions in the Covers panel or the 'Swap Days' function in the Date Mapping section.

Room swaps do not work if the room has already been changed in Compass as it takes priority over any syncs from Daily.

Compass will be the first option as default within the 'Create sync config' screen.

Note the following with each input field within the sync configuration:

1. Ensure the system selected is Compass

2. The format of the server address for Compass is https://xxxxxxx-vic.compass.education/Services/LISS/1/?academicYear=20XX. please ensure that your server address follows this format.

3. The username is the same as the Compass username

4. The API Key is supplied by Compass. You can find your API by logging to Compass and Go to Tools > Login and Security > My API Key. Compass will display the API key on a new screen, which may be copied and pasted into the relevant area. Once this has been located, copy the API Key and paste it into the Tes Timetable file‘ File > Synchronise > Configure > Connection ' window.

Refer to your school Compass manager if you still need assistance with locating API key.

5. Ensure that the rotation dates set in the 'Rotation start dates' section are the same as what has been entered within the Timetable file. These dates will automatically populate with the rotation dates set in Daily > Settings > Date mapping. If the dates in the sync configuration do not match the dates in the Timetable file, change the rotation dates in Date mapping.

6. The Basic sync section is deselected by default. If you wish Timetable Daily to sync room bookings and/or cyclical timetable changes from the Timetable file automatically then select one or both of these options.

For more information on this feature please see the following document: Automated Instant Synchronisation

7. In the 'Other' section you have the option to Append year-level to class names if you require. The default option is "Don't append year-level to class names".

The 'Years' field is to be used only if there are multiple configurations for different Compass destinations. Data for the selected years only will be synced to the configured Compass server address.

8. The option to 'Exclude teacher Admin IDs (not recommended)' should only be used by schools with teachers who are also parents of students at the school.

Once the correct data has been input you may 'Test connection' to verify whether Compass accepts the configuration settings. If the settings are accepted then you may select the 'Save' option to save these settings. If the settings are not accepted you will need to contact Compass to confirm whether your Compass-specific settings are correct, otherwise you may lodge a ticket to determine why the settings have not been accepted.