94 lines
7.4 KiB
ReStructuredText
94 lines
7.4 KiB
ReStructuredText
Overview
|
|
========
|
|
|
|
Safe Exam Browser Server (SEB Server) is a web-service application to help setting up and maintain e-assessments with `Safe Exam Browser <https://safeexambrowser.org/>`_ (SEB) in one place. The SEB Server application can be used by an institution or organization as a self-maintained, lightweight server application to organize and setup their e-assessments but can also run within a cloud infrastructure of a general service provider.
|
|
|
|
SEB Server consists of a web-service that provides a REST API and is able to run within one or many instances to scale up and a graphical user interface (GUI) server component that can either be integrated within the web-service or separately as a stand alone server application that connects to a defines web-service instance. SEB Server is written in Java and uses Docker for installation and setup. For more information about the architecture and installation, please go to `SEB Server Installation Guide <https://seb-server-setup.readthedocs.io/en/latest/overview.html>`_
|
|
|
|
For an organization or institution that provides safe e-assessments with `Safe Exam Browser <https://safeexambrowser.org/>`_, SEB Server can help to organize this e-assessments more effectively, safely and in one place.
|
|
|
|
There is the possibility to use the a SEB Server with built-in multi-tenancy functionality by creating institutions that are separated by each other. This is most convenient for smaller groups of organizations or institutions that want to have one self maintained SEB Server instance but need internal separation of institutions.
|
|
|
|
Since SEB Server is generally an administration tool, meaning generally used to do administration work and task to setup and maintain e-assessments, there is yet just a built-in small user-account management where users can register itself and get needed privileges assigned by already registered administrator users that has the privileges to maintain user accounts. Currently there is no possibility to register with a third party account and single sign on.
|
|
|
|
We will have a quick overview of the functionality and the roles on SEB Server in the next chapter.
|
|
|
|
|
|
|
|
Roles and Use-Cases
|
|
-----------------------
|
|
|
|
The SEB Server supports a simple role based privilege system where a role has defined read, modify and write privileges on certain domain entities. The privileges for a role are defined and cannot be changed by a user. Roles can be combined within one user-account.
|
|
|
|
Privileges for domain objects are categorized in read, modify and write where write includes creation and deletion grants in addition to the more restrict modify right that only allows to modify already created objects. They are also categorized in overall, institutional and owner privileges where overall means for all object, over all available institutions and institutional means only the object of the own institution and owner means the creator or assigned owner of an object.
|
|
|
|
Currently there are four roles that reflect a good separation of concerns within the SEB Server application administration itself and the setup and maintain for e-assessments with SEB.
|
|
|
|
|
|
SEB Server Administrator
|
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
This role is primarily to administer the SEB Server application, create new and maintain institutions and user-accounts. In addition to that a SEB Server administrator also has overall read privileges for the most parts to be able to analyze problems and help others to solve them.
|
|
|
|
A typical use-case for a SEB Server administrator is to create a new institution and an institutional administrator for this institution.
|
|
|
|
Institutional Administrator
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
An institutional administrator has overall read access for its institution and is able to modify the institution properties as well as create new or maintain existing user-accounts for the institution. Furthermore an institutional administrator is able to create and maintain learning management system bindings and SEB startup-configurations for the institution.
|
|
|
|
A typical use-case for a institutional administrator is to give the appropriate roles and privileges to newly registered users of the institution, to create and maintain SEB startup configurations for the institutions and maintain learning management systems within the SEB Server and institution.
|
|
|
|
Exam Administrator
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
With this role a user is able to prepare an exam with SEB restriction and support from creating configuration to import exam and prepare them for run and monitoring.
|
|
|
|
A typical use-case for an exam administrator is to create a SEB exam configuration within the templating and configuration section. Then finding a specific course or quiz from the learning management systems that are defined within the institution. This course or quiz can then be imported by the administrator as an exam. After that an exam administrator will prepare this exam for run and monitoring by attaching a exam configuration to it, prepare monitoring indicators and specify the SEB restriction conditions.
|
|
|
|
Exam Supporter
|
|
^^^^^^^^^^^^^^
|
|
|
|
This role is to support a running exam within SEB Server. An exam administrator is able to see the running exams on that he/she has an assignment and open them either for monitoring or editing some exam attributes or configuration during the exam.
|
|
|
|
A typical use-case for an exam supporter is on the time an exam is running, to overview the connecting SEB clients and manage them. While SEB server shows incidences or irregularities, a exam supporter can act on them and take the appropriate actions if needed.
|
|
|
|
Sign Up / Sign In
|
|
-----------------
|
|
|
|
What one probably see first when applying to a SEB server application is the login-screen
|
|
|
|
.. image:: images/overview/login.png
|
|
:align: center
|
|
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/overview/login.png
|
|
|
|
If you are already registered you can use your username and password to log in. Or use the "Register" button to go the the register page to create a new user-account. The newly created user account will only have the Exam Supporter role assigned. If one need another role or more privileges, this must be given and granted by an institutional administrator of the specified institution.
|
|
|
|
.. image:: images/overview/register.png
|
|
:align: center
|
|
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/overview/register.png
|
|
|
|
Fill in the register form and create a new account. After successfully creation, the application redirects to the login page for login. On the current version, e-mail confirmation is not a feature of the SEB Server application and therefore the e-mail address is just informative by now.
|
|
|
|
With the "Time Zone" one can choose a specific time zone for an user-account. All dates and times will then be showed within this specific time zone to the user.
|
|
|
|
|
|
Graphical User Interface
|
|
------------------------
|
|
|
|
After successful login, one will see the main graphical user interface of the SEB Server application. On the left hand are the activities that can be done, categorized within some few main sections with its relating activities underneath. By selecting a activity, the main content section will show the activity content and the action that are possible for this activity on the right hand
|
|
|
|
.. image:: images/overview/overview.png
|
|
:align: center
|
|
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/overview/overview.png
|
|
|
|
The main content usually is a list or a form.
|
|
|
|
Overview
|
|
^^^^^^^^
|
|
|
|
Lists
|
|
^^^^^^
|
|
|
|
Forms
|
|
^^^^^^
|