E10 - Synchronisation to Alma (US) via Direct Connection

Modified on Thu, 14 Aug at 1:03 AM

TABLE OF CONTENTS

Step 1: Configure the Alma (US) sync in Tes
Step 2: Perform the sync
Basic Sync
Advanced Sync

This document will outline how to sync your data between Tes timetable and Alma (US).

Make sure that your region in 'Setup > School info > Admin' is set to 'USA' and not 'Unknown' or 'Other'.

Alma (US) is only used by US schools sync system may not appear in sync drop-down if the incorrect region is selected.

E10 can GET from Alma (US):

Rooms
Students
Teachers
Courses
Subject requests

E10 can PUBLISH to Alma (US):

Sections
Section lists
Timetable
Bell times

Step 1: Configure the Alma (US) sync in Tes

Go to File > Synchronise > Configure
Select the ‘Sync’ sub-tab
Click the '+' and select "Alma (US)" from the dropdown

Multiple systems can be set up to sync. It is common to have both the Edval webserver and the school's learning management system configured, along with any other systems the school wishes to regularly sync with.

Go to the ‘Connection’ sub-tab
Ensure that “Alma (US)” is selected in the top-right corner
Input your credentials. Alma will provide you with the Alma Server URL, Username, Password and School code.

Proxy credentials are not usually required. Please see your school network administrator if a proxy message
appears after testing your connection.
Go to the 'Other' tab
Tick 'Exclude Yard duties/Study sections/On-calls' option if you do not want to send this data to Alma.
Tick 'Accept StatewideID's that are sent to Tes (Recommended)'.
Generally, Tes will obtain StatewideID's from the external school information / admin system (SIS) eg, Alma,
since this is regarded as source of truth for this field.

'Sync each time you save' - This means the 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 2: Perform the sync
Basic Sync
Basic sync is for general syncing. A basic sync allows you to download students from Alma, and publish
Sections, Section lists and timetable to Alma. To perform a basic sync:
1. Go to 'File > Synchronise > Sync Now', and select the ‘Basic’ sub-tab
2. Ensure “Alma (US)” is selected from the dropdown in the top-right corner
3. Input the date range you wish to update the Alma in and select the rotation you wish to sync
4. Click “Go” to sync
Advanced Sync
Advanced sync is used to publish specific parts of your data to Alma. An advanced sync also allows you to
download rooms, students, teachers, courses and subject requests from Alma, and publish bell times,
sections, section lists and timetable to Alma.

To perform an Advanced Sync:
1. Go to File > Synchronise > Sync Now, and select the ‘Advanced’ sub-tab
2. Ensure “Alma (US)” is selected from the dropdown in the top-right corner
3. Select which data you which to sync with Alma
4. Input the date range you wish to update the Alma data in and select the rotation you wish to sync
  
  The date range is only specific to Timetable data. Sections, Section lists and bell times will sync from
  today to the 'To' date inputted.
5. 'Create Support Log File' is usually required by Tes support to check the data validation and any issues with syncing
6. Click “Go” to sync

E10 - Synchronisation to Alma (US) via Direct Connection

Step 1: Configure the Alma (US) sync in Tes

Basic Sync

Advanced Sync