In this guide we will look specifically at rostering your district using a Twig Science Format CSV
-
Manual Setup via Twig Science Format CSV
- Accepted CSV format
- Notes on users.csv
- Notes on classes.csv
- Enabling Google Classroom Single Sign On
- CSV upload checklist
- Data Import via Twig Science Website (Recommended)
- Uploading the CSV files to our SFTP server
- Updating your district data on Twig Science
- How do users log in once data has been synced?
Manual Setup via Twig Science Format CSV
Overview of rostering process
- Add all users/class data into two separate files, users.csv and classes.csv (templates can be found below)
- Upload your users.csv and classes.csvs
- Await confirmation.
Upload methods
With this method of rostering there are two ways to upload files:
Accepted CSV format
We require a users.csv file and a classes.csv file. Examples of these files can be found below.
Notes on users.csv
The users.csv file should list everyone who needs an account for Twig Science. All teachers and students must be listed in your users.csv for every upload.
Any users removed from the users.csv file in subsequent uploads will be also be removed from Twig Science.
| Heading | Notes | Required |
|---|---|---|
| user_id | Should be a unique and permanent identifier for each user. The user_id will be used in the classes.csv file as teacher_id or student_id. | YES |
| first_name | YES | |
| last_name | YES | |
| username | A unique and permanent identifier | NO |
| password | Data is optional, but the header must be present | NO |
| role | Should be one of "student" "teacher"or "administrator" | YES |
| Data is optional, but the header must be present | NO | |
| school_names | Data is optional, however school_names should be included for all users with "administrator" role. This data provides them with access to specific school reports. | NO |
Example users.csv data
Notes on classes.csv
The classes.csv file should detail the schools and classes each student and teacher belongs to. Each teacher referenced in the classes.csv file should be listed in the users.csv file. Each student referenced in the classes.csv file should be listed in the users.csv file.
Any errors in the classes.csv file may mean teachers or students are rostered in the wrong school or class.
| Heading | Notes | Required |
|---|---|---|
| class_id | Should be a unique and permanent identifier for each class. | YES |
| class_name | The name of the class "Room 1" etc. | YES |
| school_name | YES | |
| teacher_id | This is the user_id of any teacher listed in the users.csv | YES |
| student_id | This is the user_id of any student listed in the users.csv | YES |
| grade | The grade associated with the class. Must be one grade from the CEDS grade list. | YES |
Example classes.csv data
After you complete both templates, please upload them together to your Twig Science SFTP account.
Enabling Google Classroom Single Sign On
You can allow users to login 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.
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
CSV upload checklist
Prior to uploading your CSV files please check the data for the following common errors:
- Duplicate user entries: Please ensure there are no duplicated users in the user list.
- Misspellings and typos: Please check spelling of schools and classes. Any mistakes may result in two different schools or classes when there should only be one.
- Missing headers: Please check each file contains the correct headers.
- users.csv file missing users referenced in the classes.csv file: Any users referenced in the classes.csv file should be in the users.csv
- Preferred naming convention for files: Please ensure the files you upload to our SFTP folder are named ‘users.csv’ and ‘classes.csv’
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 TSF rostering files to Twig Science using our self service dashboard.
Step by step guide to uploading files via self service
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 and classes.csv files in the SFTP folder with the updated ones.
You must update both 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.
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 log in once the district has synced?
All users can log in to Twig Science using either Google Single Sign On, or the credentials detailed in the CSVs by going to our login page.