Usage
FESEIP defines three roles in a course:
- Student: They can only view or interact with their own data.
- Teacher: They can view or interact with all student's data.
- Course Admin: They can view, interact with or override all student's data, can modify configuration, set up scheduled tasks and examine logs.
There is one additional, system level role:
- Admin: They can manage platforms, courses and users. They can promote teachers to course admins.
Authorization is partially based on the LMS. If the user has a student role in the LMS, they will have a student role in FESEIP. If the user has a teacher role in the LMS, they will have a teacher role in FESEIP.
The user interface consists of tabs.
For teachers and course admins:
- Course: Overview of all students' data.
- Logs: Accessing the logs. Only visible for course admins.
- Errors: Accessing error reports generated by the system. Only visible for course admins.
- Schedules: Scheduling tasks. Only visible for course admins.
- Config: Modifying configuration. Only visible for course admins.
- Admin: The administration tab used for setup. Only visible if the user has the system wide admin role.
For students:
- Student: Overview of the student's data.
Important
Certain (potentially destructive) operations are hidden by default. Enable Danger mode to access them.
Displays the data for one student.
The top part displays the data for the course instance. Below the course instance, each phase instance has a panel. Inside the phase instances panel, each task instance has a panel as well. The red parts are payload defined.
For both course, phase and task instances, different operations are available. The history icon shows the history of actions run. The play button allows to execute an action. The edit button enables to edit the data for the specific item. The trash icon deletes the given item. Some of these buttons are only available to teachers or course admins.
The course view is a tabular view, where each course, phase and task has a dedicated tab. Each tab displays a payload defined view for the selected course, phase and task (in red rectangle).
Displays the logs in a table, and enabled viewing them.
Displays errors encountered during actions. Ideally, you do not like to see anything here :)
Lists all the scheduled tasks and their current status. Execution logs can be viewed in the Logs tab.
Adding a new schedule requires:
- Name: A name for the schedule
- Cron: A cron when the schedule should run
- Filter: Which students should the schedule run for. ADVANCED!!! Technically, it is a MongoDB query on the fields of the course instances.
- Available Actions: The list of all actions to choose from.
- Selected Actions: The selected actions (order matters). Some actions may be given additional configuration (pencil icon).
The courses, phases and tasks. The play button allows to execute actions. The history button shows the history of actions run. The pencil icon enabled to edit the configuration associated with the course, phase or task.
See Installation.
Data tables are often used in the UI. The data is paginated and can be filtered if necessary. Filtering supports with specific filters: strings, numbers, booleans, dates and enums. The columns can be rearranged, resized, sorted or hidden.
Clicking on the icons in the header enable the generation of inline statistics. Pie charts, bar charts and tables are supported for enums and booleans, while histograms are supported for numbers and dates. The charts support grouping by an enum or boolean field.
The edit dialog allows to edit data. Each field has a type (from a schema), with support for nested and array fields. An advanced, JSON editing dialog can be opened by clicking the pencil icon.
