Skip to main content

SFTP for your Secured Access Accounts

  • Updated

Our system supports multiple file types and data formats. However, the preferred format we accept is defined in the OneRoster standard, and it is in .CSV format. We can accept .CSV, delimited TXT, and XLS file types. This document lists all the fields which we support including some extra, optional CMS4Schools Touch-specific fields. Then, we will examine how our clients interpret the OneRoster format and make adjustments accordingly in their custom-tailored mapping sequence.

If you would like to have an SFTP for your secured access account, please contact your project manager or our support team, to have our team set up the SFTP location for your app.

Please provide answers to the following questions:

  1. Do your want to use a username/password pair or a secure SSH key for authentication?

  2. Do you have a single or a set of dedicated IP addresses from which you are going to connect to our SFTP server? If so, please provide the IP addresses so we can restrict connections to those sources, making the connection even more secure.

  3. What is the source of data? What school information system will the information be syncing from?

  4. Is there any documentation about the data structure you are about to send? Does it follow a standard (e.g. OneRoster)?
  5. Are we creating administrator, teacher, student, and/or staff accounts? Will teacher accounts be used to log in to the backend (app dashboard) of the app or just the app itself?
  6. Would you like us to send invites immediately?
    1. You can mass send invites from the People manually if desired).
    2. Note that if you are using an SSO option, you may request that users log in via SSO rather than sending them login information.
  7. Should we delete people who are not in the incoming payload (full sync) or disable them, or only add a new person and edit existing ones (incremental sync)?

Mapping Schema

View SFTP Mapping Scheme Document.

Note that a separate file should be created for each identity type. Example files have been attached at the bottom of this article.

Mapping Staff Identity (Administrator, Teacher) Fields:

  • Role Name
  • File Name
  • Organization ID
  • Unique ID Field (source id)*
  • Email (required if an app or dashboard account needs to be created)
  • First Name*
  • Last Name*
  • Middle Name
  • Department
  • Phone Number
  • Country
  • State
  • Zip
  • City
  • Address
  • Title
  • Employee ID
  • Security PIN

Mapping Parent Identity (Aide, Guardian, Parent, Relative) Fields

  • Role Name
  • File Name
  • Organization ID
  • Unique ID Field (source id)*
  • Email (required if an app or dashboard account needs to be created)
  • First Name*
  • Last Name*
  • Middle Name
  • Department
  • Phone Number
  • Country
  • State
  • Zip
  • City
  • Address
  • Title
  • Relationship ID Field (source id list of the related Students)

Mapping Student Identity Fields

  • Role Name
  • File Name
  • Organization ID
  • Unique ID Field (source id)*
  • Email (required if an app or dashboard account needs to be created)
  • First Name*
  • Last Name*
  • Middle Name
  • Department
  • Phone Number
  • Country (Full name or Alpha2Code)
  • State (Full name or abbreviation)
  • Zip
  • City
  • Address
  • Student ID
  • Grade
  • Relationship ID Field (source id list of the related Parents)

Related articles