CompassLink
Overview
Compass integrates with your school infrastructure using the CompassLink service.
The CompassLink service communicates between LDAP infrastructure such as Active Directory or Open Directory, and School Information Systems such as Cases21, and Compass.
Authentication instances are responsible for login and access information and can be identified by the '(A)' next to the Client ID. Please refer to the Authentication sub-article in the top right of this screen for further details.
Synchronisation instances are responsible for importing information from School Information Systems, and can be identified by the '(S)' next to the Client ID. Please refer to the Synchronisation sub-article in the top right of this screen for further details.
The CompassLink service communicates between LDAP infrastructure such as Active Directory or Open Directory, and School Information Systems such as Cases21, and Compass.
Authentication instances are responsible for login and access information and can be identified by the '(A)' next to the Client ID. Please refer to the Authentication sub-article in the top right of this screen for further details.
Synchronisation instances are responsible for importing information from School Information Systems, and can be identified by the '(S)' next to the Client ID. Please refer to the Synchronisation sub-article in the top right of this screen for further details.
Service Requirements
In order for CompassLink to work on your server, it requires the following service
capabilities:
capabilities:
Microsoft Windows 7 or above (x86 or x64)
Microsoft Windows Server 2003 R2 or above
Microsoft Windows Server 2012 R2 is recommended
.NET Framework 4.5.1 (Installer will prompt for update)
Microsoft Windows Server 2003 R2 or above
Microsoft Windows Server 2012 R2 is recommended
.NET Framework 4.5.1 (Installer will prompt for update)
Please Note:To ensure that CompassLink runs smoothly, we highly recommend that the workstation is turned on and connected to the network 24 hours a day.
First Time Installation
Installing CompassLink
To begin installing CompassLink, you will need to follow these steps:
2 - Once downloaded, double-click on the file and run the installer.
3 - If Windows protector indicates that this is a unrecognised program, click More Info and then Run anyway.
4 - Navigate to 'C:/ProgramFiles(x86)/JDLFInternational/CompassLink' and copy ‘CompassLink-Config’ to the desktop.
5 - Right click ‘CompassLink-Config’ and open with a text editing program (Notepad) and enter proxy details.
6 - Remove the two comment tags above and below the proxy tags.
7 - Copy ‘CompassLink-Config’ back into the JDLF International folder.
8 - Open ‘Services’ and right click CompassLink then click 'Restart'.
9 - Visit http://localhost/compasslink within the web browser on the machine CompassLink is installed and ensure that everything is working correctly.
Here is an example of a working CompassLink:
Once the service is installed please visit http://localhost/compasslink within the web browser on the machine CompassLink is installed and ensure that everything is working correctly by seeing all the dots as green. If you experience red dots on this page email support@compass.education with a screenshot of the localhost and they will be able to assist.
Checking Proxy Details
A common fix to get CompassLink connected is to check that the proxy settings have been entered on the config file.
This file can be found on the Workstation by going to:
C:\Program Files (x86)\JDLF International\CompassLink.
This file can be found on the Workstation by going to:
C:\Program Files (x86)\JDLF International\CompassLink.
The config file will be called ‘Compasslink-config’.
Open this file in notepad and ensure that the proxy details have been entered, shown below is the regular eduproxy which most schools will have:
Netspace proxy = proxy.education.netspace.net.au - Port: 8080
Eduproxy = 10.?.?.19 - Port: 8080 (the ? will be unique numbers for your school)
Eduproxy = 10.?.?.19 - Port: 8080 (the ? will be unique numbers for your school)
Please note that some Authentication instances require a username and password in the proxy settings in order to connect to Compass.
Confirm with your tech if the proxy needs a username/password.
Reinstalling CompassLink
Uninstalling CompassLink
To uninstall CompassLink, please follow these steps:
1 - Go to the Control Panel - Programs - Programs and Features.
2 - Press and hold (or right-click) on the program you want to remove and select Uninstall or Uninstall/Change. Then follow the directions on the screen.
3 - Navigate to C:/ProgramFiles(x86)
4 - Delete the 'JDLF International' folder
Reinstall CompassLink
Please Note: Do not remove the 'JDLF International' folder before uninstalling via Programs and Features. This will cause the CompassLink to no longer function and will not be able to be uninstalled fully.
Syncing with CASES into Compass (for Victorian Public Schools only)
Before setting up CompassLink for syncing with CASES, you will need to obtain your schools eduHub account credentials and data location.
This information can be found in the eduSTAR Management Console
This information can be found in the eduSTAR Management Console
1 - Open Compass and select Tools (Cog Icon) - Top right corner of Compass
2 - Click Client Manager
3 - Click the Pencil Icon on the CompassLink instance you would like to sync with CASES
4 - Remove 'Maze' service if it is present
5 - Click Add Service
6 - Add EduHub
7 - Enter the credentials from the eduSTAR Management Console, here is an example:
If you are syncing attendance data to CASES, you will need to add EduhubV1Writeback service as well.
We advise waiting at least an hour after changes have been made in CASES before pushing a manual sync. This is to allow for CASES to update the eduHub folder and allow Compass to import the data.
Troubleshooting
Check that the Workstation (Computer or server) upon which CompassLink is installed on is switched on. If it is off, turn it back on.
If the Status Light next to the Client ID is Red, the instance is down.
This means the device upon which CompassLink is installed on the network is not connecting to Compass.
Restarting CompassLink service on Workstation
1 - Click the Windows Key and searching for 'Services'
2 - Right click the 'CompassLink' service and click Stop
3 - Once the service is stopped, right click again and click Start.
4 - Ensure that your proxy settings are correct and up-to-date by following the 'Checking Proxy Details' section of this article.
If you have confirmed that your proxy details are correct and the issue persists, try uninstalling and reinstalling CompassLink on the server.
Additional Resources
Related Articles
PPOD
Overview Once a student's data has been added to PPOD, it will be synchronised across to Compass via the CompassLink service. The CompassLink service runs inside your school and will automatically synchronise school data from PPOD to Compass. This ...Authentication
Overview The CompassLink service runs inside your school and allows your users to authenticate using your existing LDAP infrastructure (such as Active Directory or Open Directory). This removes the need for separate password management and accounts ...Ancestry Structure Installation
Overview When all schools are under the same Ancestry network, one CompassLink instance can handle those multiple school portals. To install CompassLink for this type of Ancestry structure, please follow the below steps. Installation Steps 1 - ...Compass Status Checklist
Overview This article outlines preventative measures that can be undertaken by the end users at schools to avoid inconsistencies and operational issues in the platform short term and long term. It’s important that areas of Compass are checked ...PaperCut Integration
Overview Compass now integrates directly with PaperCut using CompassLink. The previous method of integrating via the SUSSI Service is no longer supported. While most schools use CompassLink already for authentication with Compass, this article will ...