Product: Roster Server
Audience: ClassLink Administrator
- Opening Reports
- Job Details
- File Summary
- Error Details
- Action Details
To view the details of an import, click on the Import Rosters section of the side menu -> click the link under the Status column for the import details you wish to view.
The Job Details section will show you the status for that particular import, the time it started, and the time it ended. The tiles below show a summary of the changes made for each CSV with this import.
Numbers in green are the number of records added for that particular file.
Numbers in red are the number of records removed from that particular file.
Numbers in orange are the number of existing records that were changed in some way.
Below the Job Details is the File Summary, which lists the CSVs that were imported. Only OneRoster compliant CSVs will be shown; any additional files used for a preprocessor will not be shown.
The color next to the name of the CSV shows its status:
Green indicates that the file has no errors or warnings.
Red indicates that the file has errors.
Orange means that the file has warnings, but no errors.
Click View under details of a CSV with errors or warnings to view more details about them. Here you can also download a copy of the CSVs imported, by clicking the Download files button. Clicking this will give the option to download the CSVs in the import directory (or the ones generated from an API connector, if enabled), the CSVs created after preprocessing (if enabled), or both.
The Error Details section provides more in-depth details on issues with your data. The information shown falls into one of four categories: Critical Errors, Errors, Warnings, and Notices.
Critical Errors are the most severe and will prevent an import from completing. Critical Errors are differentiated from regular errors in the File Summary by the Critical Errors ribbon in the Total Errors column.
Critical Errors include things such as thresholds being exceeded and CSVs having extra or missing columns.
Errors are problems with individual rows in the CSV that prevent the row from being imported. Errors will not stop an import from completing unless there are enough of them to trigger a threshold error.
Examples of errors are rows missing required values, (like a row in users.csv missing a username) referencing invalid entries (a row in classes.csv having a value for courseSourcedId that doesn't exist in courses.csv), and values not meeting requirements (a row in academicSessions.csv with schoolYear value that isn't four digits).
Warnings are non-critical issues with rows in a CSV. Warnings do not prevent a row from importing and do not count toward threshold errors.
Examples of warnings are grades or subjects being empty, values being in the improper case (lower or uppercase), and duplicates.
Notices are potential problems with the relationships between your data. Notices draw attention to possible problems with your information.
Examples of notices are a class having no students, teachers or students having no classes, and courses having no classes.
The entire list of error details can be exported as a CSV by clicking the Download Errors CSV button under Error Details.
Aside from errors, you can also see each action that was done for each CSV. To switch to the Action Details view, click the Show Actions button.
Like the error details, actions are shown by CSV. Actions fall into one of four categories: insert, delete, ignore, and update.
Insertions are records (rows) that have been added to the data.
Deletions are records that have been removed from the data.
Ignore means that the data in the row was unchanged.
Updates mean that an existing row was changed, and the details of the change can be seen in the Notes column.
The list of actions can also be exported to a CSV, by clicking the Download Actions CSV button.
Updated: Mar 2019