OneRoster Specifications
Last updated About 2 months ago
OneRoster Specifications
Table of Contents
How does the OneRoster sync work for Pathful?
Setup Instructions
File requirements
How does the OneRoster sync work for Pathful?
Every application utilizes the OneRoster data, from your school, a little differently. Below is a list explaining the unique ways we apply the data to our system and other common questions.
We filter the sync process down to the school level. So only the schools we have mapped in our system, will be rostered.
Only users with access to the mapped schools, will be rostered into our system.
We cannot filter out users in a particular school, so all users will be rostered if they are part of a mapped school. In order to achieve this, you must filter the users out before sending the OneRoster file.
While you are a customer in our system, we will not delete users. The users are only archived, and will not lose their work.
We do not have classes or courses in our system, we have groups. Groups are created based on the classes.csv file, and students in those groups come from the enrollments.csv file.
Only courses connected to mapped schools are rostered.
Only 1 teacher can be associated with a group. We take the first teacher provided in the OneRoster files.
We can customize what fields are used as usernames in our system. So please let the Pathful representative know if you have any preference.
Groups created through rostering are mostly not editable. We provide a custom title field, in case teachers would like the groups displayed name to be different.
Teachers can create custom groups in the applications. These will not be affected by the rostering system.
Setup Instructions
These are the basic instructions for setting up OneRoster with our applications. Because there are multiple systems for sending OneRoster files, these instructions may vary.
Step 1: Review the File Requirements below.
Step 2: We will send you SFTP credentials for sending over the OneRoster files.
Step 3: You will use the credentials to send over the zipped OneRoster folder.
Step 4: You should create a daily sending schedule for the files. Let the Pathful representative know the scheduled time of day when the files will be sent. We recommend between 12am - 6am EST.
Step 5: We will review the OneRoster files, and report back any issues.
Step 6: We will map any existing users in our system, to users in the OneRoster files. Does not apply to new customers.
Step 7: We will run the initial sync, and report any issues.
Step 8: We will initialize the scheduled sync. At this point, our system will consume the OneRoster files daily at the scheduled time provided in Step 4.
File Requirements
The files must be sent as a zip file.
There are NO requirements for the name of the zip file.
The OneRoster files in the zipped folder, do have name requirements. Those details are listed below.
Here is a sample zip file: VjsCreateRoster.zip
We do not require all the files for utilizing OneRoster. Here is a list of the required files.
manifest.csv
orgs.csv
users.csv
classes.csv
enrollments.csv
Within each file, there are required columns/data. Here is a list of the columns and whether they are required. If a column is [optional] it will be surrounded with brackets.
manifest.csv
propertyName
value
orgs.csv
sourcedId
[status]
[dateLastModified]
name
type
[identifier]
[parentSourcedId]
users.csv
sourcedId
[status]
[dateLastModified]
enabledUser
orgSourcedIds
role
username
[userIds]
givenName
familyName
[middleName]
[identifier]
[email]
[sms]
[phone]
[agentSourcedIds]
[grades]
[password]
classes.csv
sourcedId
[status]
[dateLastModified]
title
[grades]
courseSourcedId
[classCode]
classType
[location]
schoolSourcedId
termSourcedIds
[subjects]
[subjectCodes]
[periods]
enrollments.csv
sourcedId
[status]
[dateLastModified]
classSourcedId
schoolSourcedId
userSourcedId
role
[primary]
[beginDate]
[endDate]