All Collections
ClassTag Connect API Integrations
OneRoster
How do I create a OneRoster Users file?
How do I create a OneRoster Users file?
Migui Franco avatar
Written by Migui Franco
Updated over a week ago

ClassTag Connect offers Single Sign-On (SSO) rostering integration with ClassLink or Clever. Alternatively, set up data with SFTP or use our manual process in the product.

The manual process of uploading District and School rosters requires OneRoster-compatible users, classes, and enrollment CSV files. This article will provide you with information about these files.

USERS.CSV

You can view the sample file here.

This is to upload all students, parents/guardians, School Leaders, teachers, and other School Staff.

You can leave out the parents if you prefer uploading them separately. The process of uploading parents/guardians separately can be found here.

Below is the definition of each column of the users.csv file.

sourceId

  • Student, parent, teacher, staff ID or any unique identifier for your students, parents, and staff. There must only be one sourceId per person.

orgSourcedIds

  • The School's unique identifier. This will have to be set manually to all Schools before you upload your users.csv file. If you haven't done so, please follow the instructions from this article.

  • You can use multiple IDs for users that exist in multiple schools. Separate the orgSourced IDs by a comma.

  • You can remove this column if you are uploading the file from the School Level.

role

  • The user's role. One of: student, parent, guardian, relative, teacher, aide, proctor or administrator. Parent/guardian/relative are processed the same way. Teacher/aide/proctor are processed the same way.

givenName

  • The user's first name.

familyName

  • The user's last name.

email

  • The user's email address.

sms

  • The user's mobile number.

phone

  • The user's home phone number if there is any. It will be kept in the account confidential but will not be used for notifications.

agentSourcedIds

  • Parent/guardian IDs from the first column to be connected to the student in each row.

  • Each student can have up to 6 parents/guardians so the file can have 6 unique IDs separated by commas.

grades

  • The student's grade level.

  • The acceptable codes are listed here.

language

  • The parent/guardian's preferred language for communication.

  • Leaving it blank will default to English

  • This will be used for all future communications with the parents.

  • A user can change his preferred language anytime from account settings.

  • If the Language selected is different than the teacher or other school members that write an Announcement or a private message, the Announcement or message will be automatically translated.

  • The acceptable Language codes are listed here.

EXPLORE MORE:

Did this answer your question?