Twig: Rostering with CSV TSF Format

 

In this guide we will  look specifically at rostering your district using a Twig Science Format CSV

Manual Setup via Twig Science Format CSV

Overview of rostering process

  1. Add all users/class data into two separate files, users.csv and classes.csv (templates can be found below)
  2. Upload your users.csv and classes.csvs
  3. 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
email 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

Screenshot 2021-08-03 at 15.40.14.png

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

Screenshot 2021-07-22 at 14.38.47.png

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.
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

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.

Interactive guide to uploading TSF rostering files

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

25 STEPS

1. Welcome to our Uploading Twig Science Format File Walkthrough!

Learn how to upload completed files for processing. Before beginning this process you should have a users.csv file and a classes.csv file.

Click on 'Begin' to start the guide.

Step 1 image

2. Navigate to https://app.twigscience.com/login and click 'District ID'.

Enter your District ID. In this example we are using SELFSERV. Please check with your Customer Success Manager if you're unsure what your District's ID is.

Step 2 image

3. Here you type in your District ID and Click 'Next'.

Step 3 image

4. Type in your District Admin Username and Password.

Note: District Admins cannot log in with Clever or Classlink.

Step 4 image

5. Click 'Log in.'

Step 5 image

6. Navigate to your Admin Dashboard.

To start the Self-Service Rostering Process, click 'Data Imports: Roster status'.

Step 6 image

7. This is the Data Imports page. This will provide you with a log of previous imports as well as the ability to download our CSV templates.

When your user.csv and classes.csv files are complete, click 'Import New Files'.

Step 7 image

8. Click 'Select File' next to the users.csv box.

Step 8 image

9. Select your completed users.csv file.

Step 9 image

10. Click 'Open'.

Step 10 image

11. Click 'Select File' next to the classes.csv box.

Step 11 image

12. Select classes.csv file.

Step 12 image

13. Click Open.

Step 13 image

14. You're now ready to upload your files for processing. Click 'Upload'.

Step 14 image

15. You'll then be presented with the following pop-up.

Click 'Close' to continue.

Step 15 image

16. Our files are now processing. The time to complete this job will depend on the size of your roster.

You can click 'Refresh Job Status' to update the page as needed.

Step 16 image

17. When your import has finished the Import Status will change to Successful or Failed.

If your import is successful you can view your user credentials in the Users section of your Dashboard.

Step 17 image

18. You can verify all of the users you've just rostered via the 'Users' section in your Admin Panel.

To access it, click 'Manage'.

Step 18 image

19. Then click 'Users'.

Step 19 image

20. This is the Users section of the Admin Panel.

Here you'll be able to browse your District's user data and reset passwords.

It is split into 5 sections, School Admins... Teachers...

Step 20 image

21. Students...

Step 21 image

22. Schools...

Step 22 image

23. And finally Classes.

Each section will allow you to verify the CSV files you've just uploaded into your Twig Science roster.

Step 23 image

24. If you have any questions or queries then please do not hesitate to reach out to us at support@twigscience.com.

You can also find a dedicated link to our Rostering support resources in the 'Data Imports' section of your Admin Panel.

Step 24 image

25. Guide complete!

Thank you for using our Support Center resources.

Step 25 image

** Best experienced in Full Screen (click the icon in the top right corner before you begin) **

https://www.iorad.com/player/2148739/Twig-Science---TSF-CSV-Self-Service-Rostering-Guide

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.