This is an overview of the data which may be transmitted on a regular schedule to TeachTown systems via SFTP secure upload. All data conforms to the OneRoster 1.0 Standard. The benefit of setting up OneRoster Integration is to facilitate easy setup and maintenance of your district. Some of the primary benefits are stated below:
Prior to setting up OneRoster, our Professional Services team needs to set up your School District account (a parent Organization in our system), plus a School Account (child Organization under the parent) for each school. We need to have these accounts established in order to connect your OneRoster integration with these accounts. Our professional Services team should be in touch with you regarding this.
The OneRoster 1.0 standard specifies a Zip file which contains the files described further on in this document. The Zip can be uploaded daily and will be processed by our system that evening. We will contact your IT department in order to establish SFTP credentials for your district. This can be done via RSA Authentication (we will require your public RSA key), or via username and password. You can inform us what the Zip file name will be and our system will look for and process that file.
The TeachTown servers can receive OneRoster file via SFTP. The customer must provide us with the IP address of their server that will be uploading the file so that we can whitelist it in our system. We will set up SFTP credentials and provide to the customer. These will be similar to:
TeachTown server Hostname: ftp.teachtown.com
Protocol: SFTP over port 22
Customer Username: <tbd>
Customer Password: <tbd>
Path: Should not be required, or could be simply ./
The format of each file is standard comma-delimited data.
The following fields are required*.
type*
Currently the only valid value for this field is ‘school‘.
sourcedId*
Your district’s unique internal identifier for each school.
name*
Your district’s unique name for each school.
The following fields are required* in order to create teacher and student accounts.
sourcedId*
A unique identifier for each user.
orgSourcedIds*
This identifier must match with a sourcedId value found in orgs.csv, and indicates which organization this user is primarily associated with in the TeachTown system.
role*
Valid entries are
username*
A string that uniquely identifies each user. This ideally should be the same as the sourcedId field in this file. It is the value which should be provided to the TeachTown system during a Single Sign On (SSO) operation using, for example, Clever.com, ClassLink, or SAML SSO.
givenName*
Given Name
familyName*
Family Name
email*
Vaild email address, only required for users having role ‘teacher’ or ‘administrator’, however older students may have email addresses.
metadata.grade
Optional for users of type ‘student’. Usually an integer.
The following fields are required*.
sourcedId*
A unique identifier for this enrollment. This should be present in the file, but it’s value is not utilized by TeachTown’s OneRoster integration.
classSourcedId*
An identifier that groups together rows in this file, indicating which students are to be associated with a given teacher in the TeachTown system.
schoolSourcedId*
This identifier must match with a sourcedId value found in orgs.csv
userSourcedId*
This identifier must match with a sourcedId value found in users.csv
role*
Valid entries are
Either the ‘teacher’ or ‘administrator’ role will result in the association of the user to the group of students indicated in this file. Typically, this value will always be ‘teacher’.
username*
Should be set equal to the corresponding ‘username’ value from users.csv based on the user that matches based on ‘userSourcedId’.