Setting Up Automated Syncs
After you have successfully imported your first set of data, you can setup the server to automatically synchronize data on a nightly basis.
- Under Settings, turn on Sync, specify a time and click save.
- Enter any email address you would like Sync Summaries to be delivered to by clicking the '+' icon, entering the email, and clicking save. Addresses can be removed by clicking the '-' icon.
Setting Up Thresholds
Thresholds allow you to stop a sync if a certain number of changes are detected during a sync process.
- Enter a number for the allowed number of changes in each of your files. 0 will not allow any changes, while leaving the field blank will allow all changes.
Data successfully imported into OneRoster is marked with a status of 'active'. If, on a subsequent import, imported data is modified in a way that makes it invalid (For example, removing a user's name), or deleted from the CSV entirely, the data is not actually removed from the OneRoster server. Instead, it is marked with a status of 'tobedeleted'. These records have a status of 'tobedeleted' until an import is done with the modifications corrected (in the case of records being modified and invalid) or returned to the CSV. The options under Removal allow for deletion from the server of records marked 'tobedeleted'.
Deletion from the server cannot be undone, so be absolutely sure you want to remove data.
Clicking 'Purge' in the screenshot above will remove 'tobedeleted' records that are older than 180 days.
Selecting a SIS API connector
If supported, you are able to configure Roster Server to pull data directly from your SIS (Student Information System) via our API connector. First, select a SIS from the selection window. If we support direct API connections, there will be a blue API banner at the top right of the icon.
After you make the confirmation, enter in the URL and proper credentials. PowerSchool is the only SIS where you can set a connection limit. Keep in mind that the higher the connection limit you set, the more likely the SIS will start denying or throttling requests.
Once you have entered in the proper information, test the connection to the API and if successful, run the connector.
To make SIS pulls a part of your daily sync, toggle the enabled switch to "ENABLED"
This will also change the import directory from the DailyImport folder, to the SISImportFiles folder.
Turning daily email reports on
Daily emails regarding the status of your Roster Server can be enabled by entering in your email address in the box labeled "EMAIL ADDRESSES"
You can control how many emails you want to receive. Selecting "Errors" will only send an email if there is a validation error with your data. Selecting "Thresholds Exceeded" will only send an email if a large amount of changes in your data are detected. Selecting "All" will send an email every day, regardless of import status.