Skip to main content
How to enable and use the iSAMS Integration
Nicholas Hillier avatar
Written by Nicholas Hillier
Updated over a week ago

Overview

Like our other integrations, you need to be an admin in order to enable the iSAMS integration. With the iSAMS integration, you can eliminate the hassle of double-handling data between two systems. iSAMS will manage core information fields within Orah so any updates made within iSAMS will reflect in Orah upon your next automatic or manual sync. This will help ensure your data is consistent and accurate across the board.

What data can you sync?

Orah is capable of syncing your most relevant pupil information from iSAMS. See below for the exact information that can be integrated.

Pupil Information:

  • First name

  • Last name

  • iSAMS ID

  • Email

  • Phone

  • House Assignment

Contact information:

  • First name

  • Last name

  • Relationship

  • Phone

  • Email

  • Address

Houses:

  • House name

Actions:

  • Create

  • Edit

  • Delete

Enabling

To be able to integrate with Orah, you first need to install the Batch API module in iSAMS and then ensure the below methods are enabled:

• Pupil Manager > Current Pupils

• Pupil Manager > Contacts (Filtered)

• School Manager > Boarding Houses OR Academic Houses

The Contact and House Batch methods are optional if disabled in these settings.

If you have any questions about generating the Batch API module, please contact iSAMS support or review their help pages here

Once you have this enabled, please plug your API URL and API key into the iSAMS integration option on the Data Integration page, set your settings, and then enable.

How it works

By enabling this integration, your iSAMS API credentials will be authenticated and saved to our Orah database. An initial sync will take place to import all students from your iSAMS database and merge any existing students in the Orah database.

Managing your data

Syncing your data

You can set the automatic sync to occur periodically (every 6 hours) or alternatively, you can perform a manual sync with a single click which will sync your student information instantly.

Existing students

If you already have students in your Orah account, we do our best to automatically link existing students via individual matching references from within Orah and iSAMS. If we are unable to match your students, you will find these students are listed on the debugger page where you can search and match these students.

Deleting students

As iSAMS will manage your core information, you will need to mark a student as inactive in iSAMS in order to remove them from your Orah account. We offer the option of deleting students, which will permanently remove all records associated with this student, or a deactivate option which will archive their records. The deactivate option is applied by default.

Did this answer your question?