OneRoster Terminology

Here is a list of some of the terms you will encounter in our documentation, and what we mean when we use them.

  • Field – A space where data is entered. For example, in a spreadsheet a field would be equivalent to a cell.
  • Value – The actual data that is entered within a field. For example, a value might be “82465” or “”.
  • Row – In a .csv file, a row correlates to a horizontal row of data. A row is one complete set of fields that contains values that describe a single entity or record. For example, each row in the classes.csv file describes a single class.
  • Column – In a .csv file, this correlates to a vertical column of data. A column contains one field of data across every row. For example, the email column in the users.csv file contains just the email addresses for every user represented in the file.
  • Field Header – The first (top-most) value in a given column. Its name describes the information that should be included in that column. The first row of each file is comprised entirely of field headers.
  • sourcedId – In the OneRoster format, each row in a table is addressed by a primary key in its first column under the field header of sourcedId. Every sourcedId in a given file must be unique – no two values may be the same. The sourcedId is used to reference data between files. Note: sourcedId should not be confused with referential field headers such as classSourcedId, which appear later in the file and reference sourcedIds in other files. These referential columns may contain duplicate values!