OneRoster SFTP Process

CSV sync via SFTP is a simple and powerful option for SIS syncing the district rosters on the MagicBox platform. The OneRoster CSV file can be sent to multiple third-party vendors. Each vendor should have a file server that supports file transfer, using the SSH File Transfer Protocol (also known as Secure File Transfer Protocol or SFTP). The platform recommends using "Filezilla" for this activity.  Publishers and district admins can make a direct connection to the SFTP and pick the OneRoster 1.1 CSV files from the input folder location. 

Prerequisites for One Roster SFTP 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 just need to export the input sheets from the SIS and upload them on the third party SFTP tool. Once the sheets have been uploaded, the publisher and district admin can make a direct connection to the SFTP and pick the OneRoster 1.1 CSV files from the input folder location and then sync all the data 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 require  host and port.
• Information Needed by the District Admin from the Publisher - The district does not require anything from the Publisher if they want the setup to be done at their end.  

Step by step process flow for OneRoster SFTP: 

1. Create a school district.

2. Add district admin for the school district.

3. Enable OneRoster for the school district.

4. Complete OneRoster SFTP setup for the district. (Follow the below steps for instruction)

Follow the below steps to setup OneRoster SFTP

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 from the drop-down list for which you wish to initiate OneRoster SFTP.

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

8. Click "Start Configuration."

You will see the below screen.

9. Enter the "Host" autogenerated by the potal.

10. Enter "PORT"

11. Enter "Username"

12. Enter "Password"

13. Enter the "When should we stop syncing the district" date. The district will keep syncing rosters till the specified date. The district sync process will stop after this date. If there is any modification or addition of new users in the API, the data will not be synced on the platform after the specified date. (Note - It is mandatory to enter the sync expiry date. This date must be equal to or greater than the current date.) 

14. Click "Test Connection." If the test connection is successful, you will receive the following message on the screen. 

15. Click "Start sync."

You can see the sync status card view for the district on the "OneRoster" page.  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 the 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.

The platform will show the following sync 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 - Whe sync has not started.

Failed - When sync is unsuccessful.