Microsoft Office Tutorials: School data sync required attributes for clever sync

Monday, July 27, 2020

School data sync required attributes for clever sync

Instead of using CSV (comma separated value) files to synchronize School Information System (SIS) data with Microsoft 365, you can use School Data Sync to connect directly to your Clever Instance. With this sync method, you use the REST-based API Endpoints provided by Clever to sync data directly from Clever to Microsoft 365.

When you're creating a sync profile using the Clever sync method, you must have required attributes listed below, fully populated in the Clever Instance. Any object that does not contain the required attributes will fail to sync and generate an error within the SDS portal. You can also include any of the optional attributes listed below as well.

This topic lists the required attributes. Learn more about how to deploy School Data Sync by using Clever Sync.

School attributes

Attributes associated with the School in the Clever Instance.

Clever ID – Clever ID of the School.
Name – Name of the School.

Section attributes

Attributes associated with the Section in the Clever Instance.

Clever ID – Clever ID of the Section.
School Clever ID – Clever ID of the School associated with the Section.
Section Name – Name of the Section in Clever.

Teacher attributes

These 2 attributes are required, regardless of the sync method (create new users vs sync existing users) or the identity matching options chosen in the sync profile setup wizard.

Clever ID – Clever ID of the Teacher.
School Clever ID – Clever ID of the School associated with the Teacher.

If you select the Sync Existing Users option within the sync profile, you are required to sync the corresponding single attribute chosen in the identity matching options section of the sync profile setup wizard.

Username – Only required if you select Username as the source identity matching attribute within the sync profile.
Secondary Email – Only required if you select Secondary Email as the source identity matching attribute within the sync profile.
Teacher Number – Only required if you select Teacher Number as the source identity matching attribute within the sync profile.

If you select the Create New Users option within the sync profile, you are required to sync the 3 attributes below, to successfully create the corresponding user object in Azure AD.

Username – Clever Username of the user in Clever.
First Name – First Name of the user in Clever.
Last Name – Last Name of the user in Clever.

Student attributes

These 2 attributes are required, regardless of the sync method (create new users vs sync existing users) or the identity matching options chosen in the sync profile setup wizard.

Clever ID – Clever ID of the Student.
School Clever ID – Clever ID of the School associated with the Student.

Username – Only required if you select Username as the source identity matching attribute within the sync profile.
Secondary Email – Only required if you select Secondary Email as the source identity matching attribute within the sync profile.
Teacher Number – Only required if you select Teacher Number as the source identity matching attribute within the sync profile.

If you select the Create New Users option within the sync profile, you are required to sync the 3 attributes below, to successfully create the corresponding user object in Azure AD.

Username – Clever Username of the user in Clever.
First Name – First Name of the user in Clever.
Last Name – Last Name of the user in Clever.

TeacherRoster attributes

Attributes used for Teacher to Section mappings.

Section Clever ID – SIS ID of the Section.
Teacher Clever ID – SIS ID of the Teacher.

StudentEnrollment attributes

Attributes used for Student to Section mappings.

Section Clever ID – SIS ID of the Section.
Student Clever ID – SIS ID of the Student.

Microsoft Office Tutorials