OneRoster Preference

Su
Su
  • Updated

The OneRoster Site Preferences page allows administrators to configure and manage the OneRoster integration for their Atlas site. From this page, you can control the automated sync schedule, define what data is synchronized, set teacher editing permissions for OneRoster-created courses, run manual uploads, and review synchronization history and errors.

Changes made here directly affect user provisioning, course creation, and enrollments. Only users with full administrative access should modify these settings.

2026-02-22_06-40-16.png

Admin Account Credited With Changes (Required)

Select the administrator that will be recorded in the system logs as the user responsible for OneRoster updates. This ensures traceability for auditing and troubleshooting.

  • Click Save after making any changes.

33333.png

Sync Enabled

Toggle automated synchronization:

  • ON → Atlas will run scheduled OneRoster syncs.

  • OFF → No automated sync will occur.

  • Click Save after making any changes.

4444.png

Best Practice: Turn off the sync during the summer break to…

  • Prevent unintended deactivations when users, courses, or enrollments are temporarily removed or not yet finalized in the SIS for the new academic year.
  • Avoid premature course creation based on incomplete or rolling schedules.
  • Protect historical data and curriculum work from being overwritten by early or test SIS updates.
  • Reduce sync errors caused by end-of-year transitions, archiving processes, or ID changes.
  • Allow safe SIS cleanup and rollover preparation without impacting Atlas access or enrollments.
  • Give schools time to review and validate rostering data before re-enabling the automated sync.

You can then re-enable the sync once the new academic year data in the SIS is complete, verified, and ready to be published to Atlas.

Days of the Week & Sync Time (UTC) (Required)

  • Choose the days when the automated sync will run. Multiple days can be selected.

  • Set the time the sync will run. Time is in UTC, so adjust based on your local time zone.

  • Click Save after making any changes.

5555.png

Synchronization Processes

Choose what data Atlas will process during sync:

  • Users only: Creates, updates, and deactivates users only with no courses.
  • Users + Course Assignments: Creates, updates, and deactivates users and courses. 
  • Click Save after making any changes.
6666.png

Teacher Permissions for OneRoster Courses

Defines what teachers can edit in courses created via OneRoster:

  • Teachers edit Units and Lessons: Full curriculum editing access.
  • Teachers edit Lessons only: Teachers cannot modify the unit structure. Recommended when units are centrally managed by the Curriculum Developers.
  • Click Save after making any changes.

7777.png

Manual Upload Options

  • Manually upload users.csv: Imports and updates users only.
  • Manually upload courses.csv: Imports courses and related data.
  • Manually upload OneRoster.zip: Imports a full OneRoster data package: users and courses. 
8888.png

Recent Synchronizations

This section provides a log of previous sync runs. 

  • Date time (UTC): When the sync started.
  • Sync Type: Example: Users + Courses,  Automated
  • Users: Number of users added, Number of users deactivated, Errors.
  • Courses: Courses added, Courses removed, Errors. 
  • Course assignments: Assignments added, Assignments removed, Errors. 
  • Full Log File: Click Full Log file to:
    • View detailed error messages
    • Identify failing records
    • Support troubleshooting

Error Handling & Best Practices

  • Always review the Recent Synchronizations after enabling or changing settings.
  • High error counts usually indicate:
    • Data formatting issues in the source system
    • ID mismatches
    • Missing required fields
  • Use the Full Log file to locate the exact cause before running another sync.
3445667.png

When to Contact Support

Reach out to the Atlas Support or Technical team if:

  • Errors persist across multiple syncs

  • Large numbers of courses are being removed unexpectedly

  • You need help validating your OneRoster files

Share

Was this article helpful?

0 out of 0 found this helpful