RM Integris: What data is pulled through?

Created by Colin Kearney, Modified on Tue, 24 Mar at 1:32 PM by Georgie Bryant

SchoolCloud integrates with RM Integris to allow data to be read from the management system. This helps to make the setup of your system much easier. This guide goes through the things we pull through via the Datashare API, along with required criteria. The only data supplied via the API that we keep and use is that indicated below.

Object	Data	Criteria	Comments
Students	Known Name Surname Current Year Group Current Class Date of Birth Student ID	Only students that are assigned to one or more classes, as in the classes section below.	All data with the exception of the Student ID is shown in the Data > Students section. The ID is used to track changes such as a name change or class change.
Contacts	Title First name Surname Contact ID Email address Phone number Relationship	The title, forename and surname must not be blank. You can specify that only contacts with parental responsibility are brought through. The contact must have at least one student assigned to them to be synced.	The email and phone number don't need to be set for the data to pull through but if you're using SSO you need to make sure it matches the email address given by your SSO provider as this is how we match those records. Combined records (e.g. Mr and Mrs Bloggs) will be split in two. Your data for contacts can be obtained via the Data > Parents section by clicking the Export Parents button. All contacts in Integris are assumed to be priority 1 because the MIS doesn't provide a priority for contacts. You may see this in the Messages section.
Teachers	Title Forename Surname Primary email address Staff ID	The title, forename and surname must not be blank. The teacher must have at least one class assigned to them in order for them to come through. The class must fulfil the criteria in the classes section below.	The email address is not a requirement for the data to pull through but if you are using SSO then you need to make sure it's the same as the one used by your SSO provider. Teachers are not assigned rooms with Integris but you can manually enter the room in the Data > Teachers section. The room will not be overwritten when you sync with Integris.
Classes	Class Code Class Description Class ID Staff ID Student ID Type Main Teacher (in some cases, see Comments)	There must be one or more students and teachers assigned to the class. Students and teachers must adhere to the conditions set out in the relevant sections above. The class must be one of the following types to come through as a class: Registration Mixed group (i.e. a group containing both students and teachers) Teaching set	Datashare gives us up to two teachers for registration groups. Where there is more than one teacher, the first (assigned as StaffID1 in the API) is the one we deem to be the main teacher. The other will be pulled through as a supervisor. There can be more than two teachers assigned to a teaching set or custom group. These do not distinguish which teacher is the main one. All these teachers are the same level on the system. Teaching sets, registration groups and custom groups are pulled through as "classes" with types class, registration and custom groups respectively.
Contact Links	Student ID Contact ID Relationship	You can specify that only contacts with parental responsibility are brought through.	All contacts in Integris are assumed to be priority 1 because the MIS doesn't provide a priority for contacts. You may see this in the Messages section.
Groups	Group Description Group ID Group Type Student ID	The group must have one or more students assigned. Students must fulfil the conditions set out in the students section above. Groups must be one of the following types: Student group House group Year group	Groups do not have assigned teachers. These only appear under the Students section of Clubs & Events when creating or editing a new event. Groups are assigned to headings in the Students section of the create/edit evening page depending on the type of group they are.

Duplicated records

Integris data relies on the details for parents provided being the same. You should contact Integris if you have issues with duplicate data. When contacting them, make sure to give them a particular example of a parent this will help them assist you.

What if the expected data isn't coming through?

If you are unsure why something isn't coming through, please get in touch with SchoolCloud by sending an email to schoolcloud@tes.com along with the details of what you're expecting. We'll look into the issue and get back in touch with you as soon as possible.