OneRoster CSV Import

Importing Class Rosters from CSV Files

Overview

CSV Import offers an an alternative solution for classroom roster management within LanSchool Air. It allows for Site Admins to import data from CSV files to populate LanSchool Air with class rosters on behalf of teachers.

Currently, site admins can choose one of the following rostering options:
  1. Google Classroom
  2. Clever
  3. ClassLink
  4. CSV Import
Only one classroom rostering integration method can be enabled at a time. Instructors can always manually create class rosters.

CSV File Requirements

  1. Prepare the following 3 CSV files with the data you want to import into LanSchool Air. 
  2. Templates for the CSV files can be found  here  or on the CSV Import upload page in LanSchool Air.
  3. The CSV files can be opened and edited in Excel if you do not wish to use an SIS export.
  4. Save the CSV files as CSV UTF-8
The  following CSV files are required and leverage the  OneRoster standard:

users.csv

The users.csv file contains all of the teachers and students that belong to the class rosters imported into LanSchool Air.  Rosters will only be imported for teachers that have active LanSchool Air accounts.

While all OneRoster fields must be present in the CSV file, the following marked required  must not be empty in order to upload rosters into LanSchool Air.

Column Name
Required for LSA
Description
sourcedId
Yes
Unique ID value for each user
status
No

dateLastModified
No

enabledUser
Yes
Defines the status of the user (true or false)
orgSourcedIds
Yes
The school this user belongs to
role
Yes
User role (teacher or student)
username
Yes
Value to identify the user (e.g. jsmith)
userIds
No
Not required, but if filled in it needs to be a value like {FED:123456} 
givenName
Yes
The first name of the user
familyName
Yes
The last name of the user
middleName
No

identifier
No

email
Yes
Value to identify the user (e.g. jsmith@school.edu )
sms
No

phone
No

agentSourcedIds
No

grades
No

password
No


enrollments.csv

The enrollments.csv file describes the associations between users (teachers and students) and classes. Each record in the CSV will associate one user to one class roster.

While all OneRoster fields must be present in the CSV file,  the following marked   required   must not be empty  in order to upload rosters into LanSchool Air.

Column Name
Required for LSA
Description
sourcedId
Yes
Unique ID value for each enrollment record
status
No
Not required, but if filled in needs to be all lowercase letters i.e. "active"
dateLastModified
No

classSourcedId
Yes
The sourcedId for the class (from classes.csv)
schoolSourcedId
No
The sourcedId for the school (from classes.csv)
userSourcedId
Yes
The sourcedId for the user (from users.csv)
role
Yes
User role (teacher or student)
primary
No

beginDate
No

endDate
No


classes.csv

The classes.csv file describes each class that will be imported into LanSchool Air.

While all OneRoster fields must be present in the CSV file,  the following marked   required   must not be empty  in order to upload rosters into LanSchool Air.

Column Name
Required for LSA
Description
sourcedId
Yes
Unique ID value for each class
status
No
Not required, but if filled in needs to be all lowercase letters i.e. "active"
dateLastModified
No

title
Yes
The name of the class
grades
No

courseSourcedId
Yes
The sourcedId for the course this class is an instance of (from courses.csv)
classCode
No

classType
Yes
Class type (scheduled or homeroom)
location
No

schoolSourcedId
Yes
The school this class belongs to
termSourcedIds
Yes
The sourcedId for the term this class is taught in (from academicSessions.csv)
subjects
No

subjectCodes
No

periods
No


Other CSV File Requirements

  1. Columns must remain in the order defined by the OneRoster standard
  2. A header row must be present in each CSV file
  3. All header (column) names are case-sensitive (e.g. ✔️ schoolSourcedId  ❌ schoolSourcedID)

Enabling CSV Imports

After preparing the CSV files, enable the CSV Import integration can be enabled from the Classroom Management panel in Admin Settings. 
  1. Log into LanSchool Air as Site Admin.
  2. Click on the menu at the top left corner and select LanSchool Air Settings.



  3. Click on Setup.



  4. Scroll until you see Classroom Management.



  5. Click on Enable under CSV Import.



  6. A confirmation message will appear after clicking on enable. Click Confirm to continue.


Once CSV Import is Enabled, classes imported from other sources will be removed from LanSchool Air.

Uploading the CSV files

Before uploading the CSV files, confirm all teachers listed in the users.csv file have accepted their LanSchool Air invites.  Class rosters will only be imported for teachers with active accounts. Teachers present in the CSV files that are not yet activated in LanSchool will result in Sync Error notification.

For information on how to invite teachers please see Adding New Instructors and Site Admins to LanSchool Air.
  1. Once CSV Import is Enabled, click on Import.



  2. To download the CSV templates, click on Download CSV templates.



  3. Edit the CSV files with the data required for the CSV Import.
  4. Click Select to choose each respective file to upload.



  5. There are two options you can select to handle duplicates.
    • Update duplicate users, classes, and enrollment.
      • Selecting this option will overwrite any existing data found in LanSchool Air from a previous CSV Import.

    • Ignore duplicate users, classes, and enrollment.  
      • Selecting this option will leave any existing data as-is and only add new data to LanSchool Air.

  6. Once all files are selected, click Upload.
  7. LanSchool Air will verify that the formatting of the CSV files is valid
  8. If multiple School IDs are found in the CSV files, select the school's rosters that you wish to upload.
    1. To upload all data for multiple school IDs to a single, districtwide LanSchool Air organization:
      1. Edit users.csv so that orgSourcedIDs = 1 for all users
      2. Edit classes.csv so that schoolSourcedID = 1 for all classes

  9. Verify that the information is correct and click Sync.


    If any errors appear please refer to the Error Section in this article.

  10. A Processing screen will appear and a notification will be sent when the process is complete. Click Done.


Updating CSV Files

LanSchool Air does not support automatic CSV file uploads. Any changes made to classes will require the CSV files to be updated with the correct data and re-uploaded in the CSV import.

LanSchool Air does not remove or delete CSV data when new CSV files are uploaded. It will add to or overwrite the current data already there. For example, if a student leaves the school and new CSV rosters are uploaded to reflect that data, the old student account will still remain in the class rosters.

To remove old CSV data you will need to clear out the CSV rosters. To clear out the CSV rosters:
  1. Log into LanSchool Air as a Site Admin.
  2. Go to the menu at the top left and select Settings.
  3. Go to Setup.
  4. Select Enable under Google Classroom. This will clear the CSV rosters.
  5. Select Enable under CSV Import.
  6. Select Import and re-upload the CSV files.

Error Reporting 

Errors can occur at 2 possible stages, on import and on Sync. We do our best to help you identify what the issue might be with detailed error reporting.

Import Errors


If the CSV file(s) contain errors, we will relay back  the line and column which is affected: , click Details  to find out more:



Here is what a typical error detail may look like, in this case a user has an incorrect email format in the user file:



Sync Errors


After a sync, any errors that have occurred will show up in the notifications display on the upper right hand corner of your interface. Click see errors to view what errors were found during syncing. 




Here is what a typical sync error may look like, for in this case the teacher with id 67890 failed to sync because they do not have an active account in LanSchool Air.