How to configure the Groupcall Xporter for iSAMS by IRIS
Published Date : 17 May 2017
Last Updated : 04 Oct 2024
Content Ref: TEC5695576
Operating System
(none)
Part No
(none)
Summary
Provides steps to configure Groupcall Xporter for iSAMS by IRIS.
Symptoms
RM Cloud Service Delivery can assist you with your MIS Sync installation. For further information, please speak to your Sales representative on 01235 645 316 or email getintouch@rm.com, quoting this article.
Requirements
iSAMS by IRIS requires activation for API access for Groupcall Xporter to be able to extract data from the system.
You need to contact iSAMS in the first instance to enable third-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:
Calendar Manager Datasets:
Calendar Types
'Categories & Subcategories'
All Events
Report Manager Datasets:
Report Templates
Report Cycles
Reports
Discipline Manager Datasets:
Detentions
School Manager Datasets:
Academic Houses
Boarding Houses
Pastoral Tutors
School Divisions
School Forms
School Terms
Year Groups
Estate Manager Datasets:
'All Buildings & Rooms'
SEN Manager Datasets:
'Gifted & Talented Registers'
SEN Register
SEN Types
HR Manager Datasets:
Current Staff
Current Staff Photos
Teaching Manager Datasets:
'Departments & Subjects'
Teaching Sets
Teaching Set Lists
Teaching Forms
Pupil Manager Datasets:
Current Students
Current Students Photos
Applicants
Custom Group Categories
Custom Group Membership
Custom Groups
Contacts (Filtered)
Siblings
Timetable Manager Datasets:
Published Timetable Schedule
Student Timetables
Timetable Week Allocations
'Weeks, Days & Periods'
Pupil Registers Datasets:
Free School Meals
Tracking Manager Datasets:
Active External Data
External Data List
Registration Manager Datasets:
Registration Codes
Registration Present Codes
'Registration Dates & Times'
Registration Out of School
Registration Status
Registration Periods
Please note or copy the API Key for use in the Procedure section below.
Groupcall have stated that they strongly recommend you include all data areas and/or permissions that you have been asked to share above. However, if there are certain permissions you do not wish to grant access to, you are welcome to configure the account as required. Please be aware that this may impact the synchronisation of data between iSAMS and RM Unify, so if you encounter any errors when attempting to send data to RM Unify, Groupcall suggest you ensure all the recommended permissions for Xporter have been selected. If you do not wish to share certain permissions or have done so and are still experiencing issues relating to permissions, please raise a support request with Groupcall support directly - Contact Support - Community Brands UK.
Procedure
Download the Group Xporter installer from DWN4153727 in the Other Useful Articles section below.
Additionally, open a browser and go to the school's iSAMS URL, e.g. https://<schoolname>.isams.cloud.
Run the Group Xporter installer and follow the installation instructions in DWN4153727.
In the Select MIS window, click the iSAMS radio button and click Next.
In the 'Complete your iSAMS URL: https://isams.' field, type the iSAMS website address beginning with 'https://'.
In the 'iSAMS Batch API Key' field, enter the batch API key you have created from the Requirements section above.
Click Next.
Enter the correct school LEA and DfE numbers when prompted.
Select Next to save the details and finish the installation.
More Information
The Satchel One SSO app in RM Unify
Due to Satchel One extracting a different attribute from iSAMS as the MIS Id for staff and students, the RM Unify SSO app for Satchel One does not work as desired. It is advised that customers speak with Satchel One support for further advice.