The data interface file master specification is a spreadsheet that describes the structure, format, and content of the data files that are to be uploaded to SEAtS. It specifies the data elements, their types, values, and meanings, as well as the rules and validations that apply to them.
The master specification covers all interfaces across different tabs: Student, Timetable, Staff, Staff Security, Generic Events, Activity, Badge ID, Student Swipe data, Devices, Rooms, Assessment, Assessment Events, Student Profile, Student Tags, Custom Fields.
Data Interface File Master Specification Considerations
Mandatory/Non-Mandatory Fields
All columns in data interface files are required, but certain fields referenced as having a default value or as non-mandatory can be left blank but must still be included in the file. The system has a base set of mandatory fields highlighted per data interface within the Master Data Interface Specification.
Non-Default Values
Many fields across data interfaces contain attributes and values for mapping from client source data. Note that your instance of SEAtS may not be automatically enabled with all attributes available by default. Please consult with your SEAtS Project or Client Manager if you seek to introduce new attributes, as this will be fulfilled through Change Control.
File Format
The file must be in CSV UTF-8 (Comma Separated Values) format. Values with commas in them can be enclosed in quotes to load properly.
Leading Zeroes
Take care when using data fields with leading zeroes. Spreadsheet applications such as Microsoft Excel will strip leading zeroes from data fields and could corrupt the data. Check before every upload to ensure leading zeroes are present.
Header Row
The file must contain a header row of predefined column names for the specific data interface file type. A template for these column IDs is available within the SEAtS Master Data Interface Specification.
Consistency Across Files
Data placed in the School, Course, and Module fields within both Student and Timetable files must match and be identical. If the values are not identical, a new record with a different naming convention will be created in SEAtS, causing issues with data quality.
Username Values
- Student File: The username field (40.STUDENT_LOGIN_ID) must be the university SSO logon ID value, including the university domain - Staff File: The username field (11.LOGIN_ID) must be the university SSO logon ID value, including the university domain
Sample Files
Sample CSV flat files can be downloaded from your customer SEAtS Administration Site — navigate to the Imports Screen, select the Import Type, and use the 'Get Sample File' option.