XporterOnDemand:
Installing for 
iSAMS

Introduction

XporterOnDemand is a service that securely provides school data from your MIS to software partners to automatically populate their solutions with your data.

It puts you in control of your data and allows you to see exactly what information your software providers are requesting you to share with them.

Groupcall has no access to your data and all personal and potentially sensitive data is encrypted to industry standards at all times.

The Xporter tool is the part that talks to your MIS to collect that data before delivering it to your software providers.

Table of Contents

Getting your MIS Ready for Xporter

To connect to your MIS, Xporter usually needs to be provided with a user account with certain permissions or some “API” details.

“API” details usually consist of a URL (website address) and a username and password. Sometimes it might be an “API Key” instead (a long list of letters and numbers).

Before you install Xporter, it is a good idea to have these details ready to go so you can finish the installation all in one go. Sometimes you may have to request these details from your MIS provider.

Installing the XporterOnDemand Client

You will be provided a link to download the installer once you finish your registration. However, if you have closed this window or moved to another machine without getting the setup file, you can visit:

https://manage.groupcall.com/XodRegister/SchoolInstaller

iSAMS

iSAMS requires activation for API access for Groupcall Xporter to be able to extract data from the system.

You will need to contact iSAMS in the first instance to enable 3rd Party API access on your iSAMS account. Once this is confirmed with iSAMS, you will either need to create, or request creation from iSAMS support, a Batch API Key with the following access permissions:

  • CalendarManager
  • EstateManager
  • HRManager
  • PupilManager
    • CurrentPupils
    • Contacts
  • RegistrationManager
  • RewardsAndConduct
  • SchoolManager
    • All Sub Items
  • TeachingManager
    • All Sub Items
  • TimetableManager
    • Published Timetables
      • All Sub Items
    • Structure
    • Timetable
    • Timetable Allocations


You will also need to have ready your iSAMS Website URL. E.g. https://schoolname.isams.co.uk

Alternatively, we can host your iSAMS Xporter at no extra cost. Please speak to our support team to arranged a hosted Xporter installation.

Best Install Location: Application server or any machine that remains on

Required Software:

Microsoft .net Framework 4.6 with Windows Updates applied

Installing Xporter

  1. Download and run XporterOnDemand_Setup.exe. Then select your installation folder and click Next.

    XOD_select_destination_location.jpg
  2. Confirm the installation folder is correct and click Install.

    XOD_ready_to_install.jpg

  3. The installer will now download any updates required and unpack the data to the installation folder.

    XOD_download.jpg

  4. The technical contact details are not required, if you do not wish to provide this information please leave the fields blank and click Next. 

    We recommend you do provide contact details for ease of communitation in the event of any technical issues. We will NOT share your infomation with anyone outside Groupcall Ltd.

    XOD_technical_contact_details.jpg

  5. Select iSAMS as the MIS you are currently runing and click Next.

    XOD-select-iSAMS.png

  6. Confirm iSAMS is the MIS system you are using and click Install.

    XOD-ReadyToInstall-iSAMS.png

  7. Enter your iSAMS URL (E.g. https://schoolname.isams.com) and you API Key. As mentioned at the start of this document the API Key is obtained from iSAMS.

    XOD-iSAMS-API-Details.png

  8. Enter your LA code, ESTAB code and School Name then click Next.


    XOD_School_details.jpg
  9. The Cohort Year Details are not essential for XoD however they will be required if you use our identity platform (IDaaS) in the future. The details can be added later via the Xporter console. To continue click Next.

    XOD_cohort_year_details.jpg

  10. Please fill in your XoD user credentials provided during the XoD registration process and click Connect.

    XOD_connect_to_XOD.jpg

  11. If the connection is successful a green Connection Completed message will be displayed. To continue click Next.

    XOD_connect_to_XOD_connection_complete.jpg

  12. The installer will now download, unpack and run the scripts required for setting up the XporterOnDemand tasks.

    XOD_post_install_checks.jpg

  13. Groupcall XporterOnDemand is now installed and running. To close the installer click Finish.

    XOD_finish.jpg



Need further help?