If you wish to integrate MySchool with Microsoft education packages (Teams) this is possible via our synchronisation tool kit. We use the API integration with MS SDS One roster.
You must have the module for Integrations (Sync Centre) to be activated on your MySchool platform. Reach out to your CSM for more information.
Please note that Microsoft setup and directory management cannot be supported or administered by the MySchool team. Your school will need to have access to an IT specialist who understands the Microsoft 365 administrator environment.
Microsoft offers various documents and walkthroughs to assist you. Before starting the integration process, please make sure that you understand the configuration path;
SDS setup needs to have
- An Office 365 Education tenant
- Global Administrator Permissions
What can be synchronised?
Sync Centre will PUSH your MySchool enrolment data to your Microsoft platform every night, around 00h00 local time. If you change enrolment details for a student on MySchool, then this will show on Microsoft rosters the next day.
We are able to push;
- Academic Years
- Terms
- Classes
- Includes enrolled students
- Includes Teachers
- Subjects
- Course relationship to the subject
- Courses
- Includes enrolled students
- Includes Teachers
- Teachers
- Students
Can we synchronise if we have Teams set up already?
Yes. During the set-up phase, one of the first requirements is to choose whether you require the API to create new users on your active directory or update existing users already created within your directory. So both are possible.
Can we synchronise future and past years' data?
We can only synchronise for the active MySchool academic year. Previous years will not be synchronised. You will need to activate the synchronisation and choose the classes and courses in the sync centre after your MySchool rollover is complete.
What about assignments?
We cannot synchronise with the assignment module in Teams.
We don't know what to do with Microsoft
We do urge you to have expert knowledge of the Microsoft platform, although we can advise checking certain settings, we cannot be responsible for supporting this. Again, please make sure you have checked out the comprehensive Microsoft knowledge base before starting this process.
Phase 1: Your staff and students must have a valid Microsoft licence or be registered in the active directory
The unique identifier for synchronisation is the MySchool primary email field in student and staff profiles. This must be identical to your MS active directory. If you need to update your email addresses in MySchool, we have the mass edit tool which can help update records quickly if needed.
Phase 2: Generate your security credentials
Create your Sync, by choosing One Roster 1.1 from the drop-down options;
Give it a name, and assign it to the school. In multi-school systems, you can add multiple schools if needed. Leave it active for the moment, it will not do anything until we complete the mapping step.
Choose User email as the option for user name format. This will check the primary email field of your staff and users.
You do not have to select anything for guardian and demographic data unless you wish to sync this with Teams.
Save the sync. We need to now set up the API on your Microsoft SDS platform.
Reopen the saved sync in MySchool, and it should automatically try to sync. A loading screen will appear. Wait a few seconds, and on the Configuration tab, press Generate One Roster credentials. You will have your client ID token and the client secret code.
Please note that you must only generate your credentials once. They do not have to be regenerated yearly. You can deactivate the sync during summer to prepare for rollover, then reactivate when rollover is complete.
These credentials need to be entered in your SDS API sync workflow.
On the SDS panel, you will need
- Web access URL - You need to take the URL used to access your MySchool instance and add /ims/oneroster/v1p1
E.g: https://myschoolinstanceurl.msm.io/ims/oneroster/v1p1
- Client id
- Client secret code
You will also be asked for an access token URL
This again is your Myschool instance URL but you need to add /oauth/token to the end of it.
E.g: https//myschoolinstanceurl.msm.io/oauth/token
We connect with Teams via API ONLY. We should be listed as an accredited API supplier.
Check out the Microsoft article explaining the steps.
Once completed. You can test the synchronisation by running a manual sync.
Both systems should now be connected. Our synchronisation will happen automatically on a daily basis around 00h00 - 02h00 each day, you don't need to manually sync unless you have drastically changed your course or class enrolment.
Phase 5: Mapping the courses and classes
Next switch to the mapping tab. As explained we push data to teams. You can enable the auto-create for course/class enrolment if you would like us to create users on the SDS roster from valid profiles held in your MySchool platform. If you would just like us to check if we have a valid profile to map to then leave these sliders non-activated. Auto-delete is not possible with the API.
To the right, there are three coloured columns, Green for MySchool, Blue for successfully synchronised entities, and red for error logs.
Open the MySchool mapping and a pop-up will appear with all your current courses or classes within your active year. Check all courses/classes or select individual entities to map.
You choose whether we should create the courses or not if they are already created. Enrolment in Teams will now be synced with your MySchool platform.
You can manually synchronise, by using the synchronise button if you want to create the entities after rollover for example.
Comments
0 comments
Please sign in to leave a comment.