OneRoster CSV Set Up Process

Prerequisite for One Roster CSV Setup

• The Setup Process - The district that wants OneRoster setup should have a Student Information System (SIS) that is compliant with the OneRoster standard. They then need to export the input sheets from the SIS and upload them on the publisher's portal, under OneRoster. Once the sheets have been uploaded, the portal will store the data on the OneRoster server and the MagicBox (Publisher) portal. After this, all the data will be synced from OneRoster to MagicBox.
• Information Required from District Admin - OneRoster sheets can be uploaded either by the publisher or the district admin. If the district wants the setup to be done by the publisher, then the publisher will need the input sheets from the district, to upload them on the OneRoster system through the publisher portal. 
• Information Needed by the District Admin from the Publisher - No information is required by the district from the publisher if they wish the setup to be done at their end.  

Step by step process flow for OneRoster CSV

1. Create a school district.

2. Add the district admin for the school district.

3. Enable OneRoster for the school district.

4. Complete the OneRoster CSV set up for the district. (Follow below steps for instructions)

Follow the below steps to set up OneRoster CSV

1. Log in to the portal.

2. Select  "School District List" from the left-hand side menu.

3. You will see the below screen. 

4. Click on the OneRoster Setting icon. 

You will be redirected to the "OneRoster" screen. Here, you can see the district sync details in a card view. 

 5. Click "Create New" to initiate OneRoster for the district. You will see the below screen.

6. Select the district for which you wish to initiate OneRoster CSV from the drop-down list.

7. Select "OneRoster CSV" sync method from the options provided on the screen.

8. Click "Start Configuration."

9. Click "Download zip template" to download the template.

10. Fill in the details in the various templates within the zip file before uploading. (Note - Do not delete the first row, listing field names for the template.)

11. Zip all the files. 

(Note - The name of the zip file should be -"OneRosterv1p1BaseCSV .zip". Any deviation from this name will result in unsuccessful upload.)

11. Upload/drag and drop the zip file by clicking on the "+" icon. 

12. The sync will automatically start, once the file is successfully uploaded. You will receive the following message on the screen. 

Please see below the list of files in the template:

The following files are mandatory for successful OneRoster sync: 

• academicSessions.csv
• classes.csv
• courses.csv
• enrollments.csv
• manifest.csv
• orgs.csv
• users.csv 

You can see the sync status card view for the district on the "OneRoster" page. 

The platform will show the following syn statuses:

In Progress - When sync is in process. 

Launched (in green) - When district sync is successful without errors.

Launched (in yellow) - When district sync is successful but has errors. The error count will be shown in the card view. 

Not Started - When sync has not started.

Failed - When sync is unsuccessful.

The card view will show the total record count number. You can click on the card view to see the One Roster sync information in detail along with last sync records count.

You can also see the number of errors in the card view and download the.txt error file from the portal to view error details.