SchoolEdge Timetable Integration

SchoolEdge Timetable Integration

Overview

Timetables built within SchoolEdge can be imported into Compass directly via LISS.

You can access SchoolEdge for assistance via the below options:

w -  https://support.schooledge.com.au/
e -  support.schooledge@tribalgroup.com
p -  1300 301 931 Australia
     +61 3 9690 5044 International 

Add Details to Third-party LISS 

Before attempting to use the LISS export feature, you need to provide connection details for the third party LISS server.  LISS connection details are added via the Maintenance > Options screen.

     

In the LISS server section of the Options screen, add a server record with the following details:

Description - Assign a name to the server.  This will appear in the server list on the export screen.
URL - Enter the url to the 3rd party vendor’s LISS server
Vendor -  Select Compass.
Username & Password - Enter the authentication details the third party vendor has provided to access their LISS server.

 
URLhttps://yourschoolportaladdress/Services/LISS/1?academicYear=CurrentlyRelevantAcademicYearImportIdentifier
For example: https://hogwartsp12-vic.compass.education/Services/LISS/1?academicYear=2021
UsernameCompass/LDAP username
API KeyCompass API Key
(See below for further information on obtaining the API Key)


Finding Compass API Key

The Compass API key is a unique code associated with each user account in Compass. Users can access their own API Key by hovering over the Tools menu (cog icon) at the top right of Compass, and selecting 'Login & Security' from the dropdown menu.

This will take the user to the 'Login & Security' page. Copy the API Key, which is highlighted in the image below, and paste it into the 'Compass connection details' window as the API Key. 

     

If a user's API Key is reset (using the 'Reset API Key' button at the right in the image above) the new API Key will need to be entered again in School Edge.

Validation

To export a timetable to Compass, run the File > Export > LISS program and select a Compass LISS server, if not already selected.

     

On entering the program, or on changing the selected LISS Server, the data will be validated to ensure that it conforms to Compass & LISS requirements.  If issues are found, messages will appear on screen and some export options will be disabled, until all issues are rectified.

     

The LISS standard requires the timetable class names to be formatted in a way that the 3rd party vendor can use to create Subject Codes and Class Identifiers.  To do this class names must be formatted as <SubjectCode> + “ “ + <ClassIdentifier>, where a space exists between the two components.

     

Naming Requirements


The following are the naming requirements that must be met before you can export your timetable data:

LISS Class Name Requirements -

Class name cannot be empty.  It must be in the <SubjectCode> + “ “ + <Class Identifier> format
Class name cannot be longer than 20 characters
The class identifier component of the class name may not exceed 10 characters
Class name can only contain one space, being the space that delineates between the subject code component and the class identifier component
Class names must be unique

Compass Class Name Requirements - 

The subject code component of the class name must be wholly uppercase (ie: 10MATH not 10Math)
The subject code component of the class name must be at least 3 characters long
The subject code component of the class name must be wholly alphanumeric (A-Z, 0-9)

Compass Subject Name Requirements - 

Note: Subject name issues are reported in the Repair Class Name screen, but you need to resolve them in the Timetables > Subject screen

Subject names in the timetable must be between 5 and 50 characters long
Subject names must contain a space (10 Mathematics, rather than just Mathematics)
 
Compass Timetable Period Code Requirements - 

Note:Period code issues are reported on entering the LISS export program and must be resolved before the export screen will launch.

Px, where x is a number is not allowed for a period code (use 1 not P1)
Period codes within a timetable day must be unique (don’t use REC for both morning and afternoon recess)
Period codes must be a maximum of 3 characters (use LUN not Lunch)
Period codes must be wholly uppercase (LUN not Lun)

Repair Class Names

This feature reports any validation issues with class names and provides the ability to correct them.

Manual Correction
Class names that fail an export validation can be corrected by clicking on the Class Name cell and editing.  After updating, move the cursor out of the cell and the Problem column will be updated to reflect the change.  When the Problem cell is empty, you have a class name that meets the export requirements.  Repeat for any other class name with problems and press Save to update the timetable to the new class names.

Auto-Generate
The Auto-generate function, provides a quick way of assigning class names to classes that have no name (empty).   Note: The class name is not a compulsory field in SchoolEdge Timetable but is required for the LISS export.

Non-blocked classes with empty class names will be assigned 
<Timetable Subject Code> + “ “ + <Timetable Form>

Blocked classes with empty class names will be assigned
<Timetable Subject Code> + ‘“ “ + <Sequential Identifier>

Examples:
Non blocked class 7MAT for form 7B, will produce a class name 7MAT 7B, although using the form without year option will produce a class name 7MAT B
A block with multiple 8HIST subject classes will produce class names 8HIST 1, 8HIST 2, etc.  The sequential identifier can be assigned as an alpha or numeric code.

Press 'Save' to update the timetable with the new class names.

Class Start/End Dates

Start and end dates for each timetable class are required by Compass, so it can determine when classes are active, and generate attendance and session information for applicable dates only.   The dates should represent how long the subject will run across the whole school year, so may span multiple timetables in SchoolEdge.

The LISS export provides the ability to record and maintain class start and end dates for all academic classes on the timetable.   The information is stored at the SchoolEdge Date Range level, so applies to all timetables within a date range.  If a class is running in both Semester 1 and Semester 2 timetables, the start/end dates you define when exporting Semester 1 also apply to Semester 2.

After the class names pass all the validation checks, use the Class Start/End Dates button on the LISS export screen.  Any class names that have not had dates recorded for the current date range will be assigned a default start and end date.  The default will be based on dates from the SchoolEdge date range, the timetable start end dates or the current date.

The class start date will be set to the Date Range start date, the Timetable start date, or the current date, whichever is later.
The class end date will be set to the Date Range end date.

           

You may edit the start and end dates for situations where a class runs for a single semester, but there are several restrictions you should be aware of

You cannot choose a past date for either start or end dates
Once a class has been sent to Compass, a start or end date in the past will no longer be editable
The end date cannot be before the start date
The start date cannot be after the end date

You can edit dates for an individual record by using the date picker controls on that record.   You can also edit multiple classes at one time by first selecting the records with the tick control located at the start of each row, then using the date picker on any one of the selected records.  

Any time you modify or add a new class name to your timetable, rerun the Class Start/End Dates program to ensure the dates for the class are set correctly.

Export data to Compass

Once you have validated the class names and set start/end dates you are ready to export (publish) your timetable data to Compass.  There are 3 publish options, Publish Rooms, Publish Timetable, and Publish Extras.

Publish Rooms
Sends Compass the list of rooms you are using on your timetables. Compass needs these codes to accept the timetable, so you should publish rooms first.   The dialog box on the export screen will confirm if the transmission of the liss.PublishRooms object has been successful.

Publish Timetables
Transmits the standard timetable classes to Compass.  The from/to date selection provides Compass the information about which school days to apply this timetable to.   It is recommended to send the timetable in small increments, rather than for the complete semester/year.   The following restrictions apply
The From date defaults to today or the timetable start date, whichever is later
The From date cannot be set to prior to today
The To date defaults to 14 days from the From date or the timetable end date, whichever is earlier
The To date cannot be set to prior to today
The To date cannot be set prior to the From date
The To date cannot be set past the timetable end date

When you use Publish Timetables, the LISS exports transmits the following LISS objects to Compass
liss.PublishBellTimes
liss.PublishClasses
liss.PublishTimetable
liss.PublishClassMemberships

The dialog box on the export screen will indicate if the transmission of each LISS object has been successful.

It is not necessary to send the Timetable everyday, since you can send it for a number of days in advance.  If you make any permanent changes to the timetable, export it as soon as possible so the changes can be reflected in Compass.

Publish Extras
Transmits the daily variations for the dates selected. Compass will use these variations to adjust attendance rolls and sessions.  Daily variations included are cancelled classes, staff absences and room changes.  Events and extra classes are not catered for as these are handled within Compass.  You can choose to send extras for up to 14 days before today and for 14 days after the current date.  Leave the Days Past and Days future fields set to zero (0) if you wish to send just the current day’s extras.

The dialog box on the export screen will confirm if the transmission of the liss.PublishDailyDeltas object has been successful


    • Related Articles

    • Compass Data Sync Tool

      Compass Data Sync Tool The Data Sync Tool is designed for use by school administrators, such as a Timetabler or Daily Organiser. It allows schools to synchronise their timetables from various timetabling packages in to Compass. If you are syncing a ...
    • Microsoft School Data Sync

      Overview Microsoft School Data Sync simplifies class management in Office 365. Using exports from Compass, you can populate your Office 365 tenant with Students, Staff, Subject and Class information for use in applications such as OneNote and Teams. ...
    • Timetabler Timetabling Solutions V9 (TSV9)

      Overview Timetables built within Timetabling Solutions V9 (TSV9) can be imported into directly into Compass, removing the need to export your timetable and using the Data Sync Tool to import. This process will not work for Timetabler V8. Imports from ...
    • Edval

      Overview Timetables built within the Edval Timetable Solutions package can be imported into Compass directly via the Edval program. You can also import your Exam Timetable via Edval (for details on importing exams, please refer to the 'Edval - ...
    • Canvas Integration

      Overview If your school uses both Compass and Canvas, this integration will allow you to: Use Compass to import SIS data into Canvas Import Canvas assignments and their grades into learning tasks (including Rubrics) Use Compass calculated grading ...