PaperCut Integration

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 detail how to also integrate CompassLink with PaperCut. 

Any schools that use CompassIdentity cards are able to have their card numbers synced across to PaperCut. Any reissued cards will automatically be updated in PaperCut, typically within 12 hours of being issued. CompassIdentity cards can be used with either their Magnetic strip (Swipe) or Contactless Chip (Tap), depending on the print release approval device being used.

Module/Functional Prerequisites

  1. CompassIdentity (student cards)
  2. CompassKiosk (for PaperCut top-up)

Details

CompassLink needs to be able to talk to your PaperCut server over the local school network. Your PaperCut server also needs to be configured to listen for API calls from the CompassLink IP address. To do this go to Options > General > Allowed XML Web Services callers


Further Configuration

From the PaperCut Admin Web Console > Options > Console Editor
  1. Find the auth.webservices.allowed-addresses config setting.
  2. Enter the IP address of the machine with CompassLink installed on it, or an asterisk (*), and click Update to the right.
  3. Find the ext-device.card-no-regex
  4. Enter 0*([\d]+) into the value and click Update.
The instructions below are an extract from PaperCut's documentation. Please refer to the full PaperCut documentation at
To specify an alternative web service authentication token, to avoid the need to use/share the built-in admin user's password:
  1. Login to the system (PaperCut admin web console).
  2. Navigate to the Options section.
  3. Click on the Config Editor link in the list of actions.
  4. Find the auth.webservices.auth-token config setting
  5. Enter a new value that will be the new web services authentication token (or API Key).
  6. Press the Update button to the right to apply the change.
This authentication token can now be used in addition to the built-in admin user's password.



Contact Compass

Once you've completed the configuration steps listed above, please contact our Support Team to finalise the set-up and confirm that we can communicate with your PaperCut server.
Please specify when emailing these details to Compass if you would like the card numbers synced or not.

You can view the PaperCut configuration by going to Administration Tools (under the cog menu icon) and selecting Client Manager.

The instance of CompassLink on the curriculum network with PaperCut will be indicated by have A/P in brackets at the end of the Client ID.  Click the associated edit pencil icon to open and view the PaperCut details.


  


Please note you can only have PaperCut integration configured on one CompassLink curriculum network instance. 

To enable PaperCut if this has not yet been done, click the edit pencil for the CompassLink instance, and tick the Enable PaperCut option.

  




The configuration screen will then display for you to add in the PaperCut Hostname and the PaperCut API Key.

  



Select the applicable Identifier for your school that is to be used for PaperCut syncing and top-up.

     



Click 'Save'.

Syncing Cards to PaperCut

Scheduling Initial Card Sync

As the ability for students and teachers to print is tied to their cards and the data that is in PaperCut, when first moving to Compass syncing with PaperCut, as well as every year when you receive new ID cards, it is recommended that you determine a date/time of when you will be syncing the cards.  This gives you the chance to communicate to students and teachers when to start using their new ID cards for printing, and also time to effectively distribute the cards.

To sync the cards, you can do this by going to Administration Tools>Client Manager and clicking the edit pencil icon associated with the CompassLink instance configured for PaperCut.

Click the Card Numbers to sync.

  


Primary Card Number

Compass is only able to sync into the 'Primary Card Number' field in PaperCut. If you already use this field for something else and would prefer we sync into another field (usually the 'Secondary Card Number' field) this is not possible. To resolve this we recommend exporting out the data from the 'Primary Card Number' field and importing this into the 'Secondary Card Number' field.

Disclaimer

Papercut is a third party product. We are unable to provide any support or warranty with this product.

    • Related Articles

    • Kiosks

      Overview The Compass Kiosk is a touch-screen unit designed for use within the school's administration office. The Kiosk provides an integrated online terminal for student late arrivals and early departures, visitors to the school, PaperCut top-up and ...

    • WA - Kiosks

      Overview The Compass Kiosk is a touch-screen unit designed for use within the school's administration office. The Kiosk provides an integrated online terminal for student late arrivals and early departures, visitors to the school, PaperCut top-up and ...

    • CompassPay FAQs

      Frequently Asked Questions Which credit cards are accepted? We accept the following types of cards: We do not accept the following cards: Is there a guide available for Parents? Yes, click here to access the Parent Guide. What if a parent disputes a ...

    • CompassPay

      CompassPay What is CompassPay? CompassPay is our payment and billing management system. You may have received your CompassPay login details already. If not, please email us at support@compass.edu.au. We can only distribute the CompassPay login ...

    • KioskLite

      Overview The Compass KioskLite offers convenient, integrated visitor and emergency management features, student and staff sign in/out, and much more. The Compass KioskLite is a touch-screen unit designed for use with a school's Compass portal, this ...