Twig: Rostering with One Roster Format CSV

In this guide we will cover:

Manual Setup via One Roster format

Overview of rostering process

  1. Export One Roster data from your SIS
  2. Upload One Roster files
  3. Await confirmation

Upload methods

With this method of rostering there are two ways to upload files:

Accepted CSV format

The CSV file format we accept is OneRoster standard specification v1.1: https://www.imsglobal.org/oneroster-v11-final-csv-tables

Export One Roster data from your SIS

Most SIS systems can export files in One Roster CSV format. We require the following files:

  • users.csv
  • classes.csv
  • enrollments.csv
  • orgs.csv

CSV required data

The following tables indicate the data we need for each file. 
 

Required data for users.csv

 

Heading Notes Required
sourcedid A unique identifier for each user. This is a permanent identifier and should not be changed. YES
Status active, tobedeleted, inactive NO. NOT PROCESSED
dateLastModified ISO-8601 date NO. NOT PROCESSED
Enabled user true,false YES
orgSourcedids "10239845,10239846,10239849,10239889" Values must match sourcedid values in orgs.csv YES
role Should be "student""teacher" or "administrator" YES
username Should only contain: letters, numbers, and the characters @+-_ YES
userids Should only contain: letters, numbers, and the characters @+-_ NO. NOT PROCESSED
givenName Maya NO. NOT PROCESSED
familyName Rodriguez NO. NOT PROCESSED
middleName Susan NO. NOT PROCESSED
identifier Student1A NO. NOT PROCESSED
email mrodriguez@gmail.com NOT REQUIRED. EMAIL WILL BE PROCESSED IF PROVIDED AND CAN BE USED FOR GOOGLE SSO
sms   NO. NOT PROCESSED
phone   NO. NOT PROCESSED
agentSourcedid   NO. NOT PROCESSED
grade Must be one of the CED grades NO
password Should be a secure password NO



 Required data for classes.csv

Heading Notes Required
sourcedid A unique identifier for each user. This is a permanent identifier and should not be changed. YES
Status active, tobedeleted, inactive NO. NOT PROCESSED
dateLastModified ISO-8601 date NO. NOT PROCESSED
title Class name or identifier: Science class 1A YES
grade Grade associated with class. Must be a grade from the CEDs grade list. YES
courseSourcedid biology1290 NO. NOT PROCESSED
classCode Class2b NO. NOT PROCESSED
classType Science NO. NOT PROCESSED
location Room 36 NO. NOT PROCESSED
schoolSourcedid Small Town Elementary YES
termSourcedid 2023/2024 NO. NOT PROCESSED
subjects Chemistry NO. NOT PROCESSED
subjectCodes Chem14 NO. NOT PROCESSED
Periods   4

  Required data for orgs.csv

Heading Notes Required
sourcedid A unique identifier for each user. This is a permanent identifier and should not be changed. YES
Status active, tobedeleted, inactive NO. NOT PROCESSED
dateLastModified ISO-8601 date NO. NOT PROCESSED
title Class name or identifier: Science class 1A YES
name School name YES
type department, school, district, local, state ONLY PROCESSED IF SCHOOL IS DATA VALUE
identifier   NO. NOT PROCESSED
parentSourcedid   NO. NOT PROCESSED

Required data for enrollments.csv

Heading Notes Required
sourcedid A unique identifier for each user. This is a permanent identifier and should not be changed. YES
Status active, tobedeleted, inactive NO. NOT PROCESSED
dateLastModified ISO-8601 date NO. NOT PROCESSED
classSourcedid This should be the Sourcedid referenced in your classes.csv file YES
schoolSourcedid A unique, permanent identifier for each school YES
userSourcedid This should be the sourcedid referenced in the users.csv file YES
role administrator, teacher, student YES
primary Signifies who is the main teacher for each class. Data input should be "true" or "false" NO
beginDate ISO-8601 date NO
endDate ISO-8601 date NO

Enabling Google Classroom Single Sign On

You can allow users to log in using Google credentials simply by using Google email addresses in your users.csv file. In the users.csv file  simply add google email addresses to the "email" column.

This will allow users to log in here.
rtaImage.jpeg

 Note: Google Workspace for Education

If your district uses Google Workspace for Education, you will need approve the Twig Science app on your Google Console first. Please read Google's guide: Control which third-party & internal apps access Google Workspace data

Data Import via Twig Science Website (Recommended)

District Admins can directly upload their rostering files to Twig Science using our Data Import tool.

The Data Import tool features:

  • An import log
  • File processing updates and detailed error reports
  • Support links

Rostering via Data Import Tool means you can upload files at anytime, be provided with detailed error reports if anything goes wrong, and get a confirmation that the upload has been successful.

How do I roster with Twig Science Data Import?

Follow our interactive step by step guide to learn how to upload OneRoster files to Twig Science using our self service dashboard.

Step by Step guide to OneRoster CSV upload

Uploading the CSV files to our SFTP server

After you create the CSV files in the required Twig Science format, please upload them to the Twig Science SFTP account. Credentials will be supplied during initial setup with your sales rep, and will look like the following:

Hostname: sftp-rostering.twigscience.com
Port: 22
Username: [district specific]
Password: [district specific]
Folder path: [not required]

If you need to download an SFTP client, we recommend FileZilla.

Your update will be processed overnight and you will receive an email to confirm that the update has been successful.
 

Updating your district data in Twig Science

After the initial CSV upload, your data can be updated in Twig Science with subsequent CSV uploads.

Please replace the existing users.csv, classes.csv, orgs.csv and enrollments.csv files in the SFTP folder with the updated ones. You must upload all four files each time. 

Records will be updated/removed/added as a result of processing the new CSV files.

 Note

Any users removed from the users.csv file in subsequent uploads will also be removed from Twig Science.

Your update will be processed overnight and you will receive an email to confirm that the update has been successful.

How do users login once the district has synced? 

All users can login to Twig Science using either Google Single Sign On, or the credentials detailed in the CSVs.