zervo/seb-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #8 from SafeExamBrowser/documentation

Browse source 
Documentation
This commit is contained in:
Andreas Hefti 2020-05-13 10:18:00 +02:00 committed by GitHub
commit 8f31205d09
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 316 additions and 100 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.rst
View file

@ -16,13 +16,16 @@ What is Safe Exam Browser (SEB)?
What is Safe Exam Browser Server (SEB Server)?
----------------------------------------------
While the interaction with SEB is well known in Learning Management Systems (LMS) like `Open edX <https://open.edx.org/>`_, `Moodle <https://moodle.org/>`_ etc. the SEB Server is an entirely new component to set up secured online exams. It interacts with the assessments system/LMS as well as with SEB on exam clients.It supports exam scenarios on student owned devices (BYOD) and on managed devices.
While the interaction with SEB is well known in Learning Management Systems (LMS) like `Open edX <https://open.edx.org/>`_,
`Moodle <https://moodle.org/>`_ etc. the SEB Server is an entirely new component to set up secured online exams.
It interacts with the assessments system/LMS as well as with SEB on exam clients.It supports exam scenarios on student owned devices (BYOD)
and on managed devices.
SEB Server is a modern webservice with a REST API and a GUI service on top of it. SEB Server is written in Java and uses Docker for installation and setup.
SEB Server provides a range of basic functionality:
SEB Server provides a range of basic functionalities:
- Built-in institutional multi-tenancy
- Built-in institutional multitenancy
- Linking of multiple Learning Management Systems (LMS). Currently supported: `Open edX <https://open.edx.org/>`_
- Accessing the Course/Exam-API of a linked LMS to import a courses or exams for managing with SEB Server
- Creation and administration of SEB Client Configurations that can be used to startup a SEB and that contains SEB Server connection information for a SEB Client
@ -30,11 +33,36 @@ SEB Server provides a range of basic functionality:
- Automated SEB restriction on LMS side if the specified type of LMS supports the SEB restriction API
- Monitoring and administration of SEB Client connections within a running exam
The image below shows a very simplified diagram that locates the SEB Server in a setup with a Learning Management System (LMS) and the
Safe Exam Browser (SEB). The SEB Server communicates with the LMS for managing and prepare exams as well as with the SEB Client to ensure
a more automated and secure setup for high-stake exams.
SEB - SEB Server Compatibility
------------------------------
The table below shows available and upcoming SEB client versions that has SEB Server integration support and are compatible with particular
SEB Server version. There is an entry for each platform with a beta or testing release date and a official release date.
**SEB Server Version 1.0.X**
.. csv-table::
:header: "Platform / OS", "Beta/RC Version", "Release Version"
"SEB Client for iOS", "22. April 2020 - Version 2.1.50", "Q2 2020 - Version 2.2"
"SEB Client for Mac", "Q2 2020 - Version 2.2", "Q2 2020 - Version 2.2"
"SEB Client for iOS", "Q2 2020 - Version 3.1", "Q3 2020 - Version 3.1"
Install SEB Server
------------------
For a complete guide to install SEB Server please go to `SEB Server Installation Guide <https://seb-server-setup.readthedocs.io/en/latest/overview.html>`_
Getting started with SEB Server
-------------------------------
For a complete SEB Server user guide please go to `SEB Server User Guide <https://seb-server.readthedocs.io/en/latest/#>`_
Project Background
------------------

108
docs/exam.rst
View file

@ -25,7 +25,9 @@ indicators for monitoring as well as defining details of the SEB restriction if
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examNotReady.png
At the beginning of the page - if there is no note - you see all the details of the exam.
- Name: Is the name of the course, defines on the LMS
- LMS Setup: Is the name of the LMS Setup on the SEB Server from which the course was imported
- Start-Time: Is the date and time when the exam is starting. This is defined on the LMS
@ -73,7 +75,8 @@ client that receives the encrypted SEB exam configuration will prompt the user f
.. note::
If you need to use the same SEB exam configuration for different exams, you can just make a copy of a SEB exam configuration that is already used
by another exam. To do so go the the "Exam Configuration" section and find the specified SEB exam configuration by using the filter. If you have
by another exam.
- To do so go the the "Exam Configuration" section and find the specified SEB exam configuration by using the filter. If you have
found the SEB exam configuration double-click on the table entry to open the SEB exam configuration. Then use the "Copy Exam Configuration" action
from the right action pane. A pop-up will prompt you the give a new name and optionally description for the copy. Click "OK" and the system will
generate a copy of the original SEB exam configuration with the new name and description and will lead you to the details page of the copy configuration.
@ -106,78 +109,65 @@ see the details of the SEB exam configuration as well as a table of exams where
to apply one SEB exam configuration to one exam, there is only one entry and you can quickly navigate back to the exam be also double-click on the
table entry of the exam.
Other Features
--------------
Apply Indicators
-----------------
Currently there are two other features that can be managed within the exam administration.
For monitoring connected SEB clients, SEB server supports some indicators that can be defines within an exam and that are shown and measured during an
exam. When you import, the application automatically creates a default ping-indicator for the exam. You are able to modify this default indicator and also
add some other indicators to the exam to be able to get notified while monitoring a exam session.
- **:ref:`exam-indicators-label`** : Define indicators to measure values for each connected SEB client when an exam is running. And
define thresholds for the indicators to show incidences.
The type of indicators are pre-defined within the SEB Server and restricts the number of available indicators that can be used. Currently following
indicators are supported:
- Last Ping Time: | This indicator measures the time that has passed since the last ping from a specified SEB client was received by the SEB Server in milliseconds.
| This can be used to monitor constant SEB client connections and get notified when a SEB client connection gets lost for some defined
| time or when a SEB client connection that has been list is back again.
| This indicator is used as default indicator and automatically applied to the exam on import. You are able to modify this indicator
| and also delete it but we recommend to have this basic indicator in place for every exam.
- Errors: This indicator measures the number of error-logs a specified SEB client is sending to the SEB Server.
- Warnings: This indicator measures the number of warning-logs a specified SEB client is sending to the SEB Server.
You can define thresholds for each indicator. A threshold is defined by an indication-color and by a threshold-value. On the monitoring side, the
indicator for each SEB client connection with change to the threshold color when the measured indicator value has reached the threshold-value.
To add a new indicator to the exam you can use the "Add Indicator" action from the right action pane. In the indicator edit page you can give the
new indicator a name. This name will be displayed in the SEB client connection table on monitoring section as column name for the column of this
indicator. Then you can choose an "Type" that specified the type of indicator. Choose this from a drop-down selection of supported indicators.
If you have selected one indicator type, a discription of this indicate will be shown just below the "Type" attribute. You can also define a "Default Color"
for the indicator. An indicator which measured value has not reached any defines threshold will be shown in this color on the SEB client
connection table of the monitoring section.
.. note::
To select a color click on the brush-palette icon of the color input field to open up a color chooser pop-up window. Within the color chooser
you can select one of the basic colors provided by the chooser or by defining the red, green and blue part of the color.
.. image:: images/exam/lmsExamLookup.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/editIndicator.png
- **:ref:`seb_restriction-label`** : If this feature is supported within the underling LMS of the exam, you are able to automatically
restrict the course or quiz on the LMS for SEB only access and may also be able to set the conditions and attributes for the restriction
as defined by the LMS.
.. _seb_restriction-label:
Automated SEB restriction
--------------------------
TODO
Use Cases
---------
**Apply or remove exam supporter**
Exam supporter "Eric" was planed to support the upcoming exam but he cancelled for reasons of illness and exam supporter "Anie" will take over.
Therefore you have to remove Eric from the exams supporter list while also adding Anie to the list. So she will be able to support the running exam.
- Login as an exam administrator and go to the "Exam" page under the "Exam Administration" section.
- Use the filter to find the exam on that you have to change the supporter assignments.
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- Use the "Edit Exam" action form the right action pane to go into the exam edit page.
- Find Eric's user account on the list of selected exam supporter and use the minus sign icon on the entry to remove Eric from the list of exam supporter
- Click into the input field of the exam supporter selector and start typing the name of Anie's account. The drop down will present you all matching entries.
select Anie's account to add it to the list of selected exam supporter.
- Use the "Save Exam" action on the right action pane to save and confirm the task. This will lead you also back to the exam details page.
- Check again if all exam supporter are correctly assigned for the exam.
**Change the type of exam**
Although the exam type has just informative character for now and did not affect the exam in any other way, you have to change the type because
your institution use the type information of the exam to set them into context.
- Login as an exam administrator and go to the "Exam" page under the "Exam Administration" section.
- Use the filter to find the exam on that you have to change the supporter assignments.
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- Use the "Edit Exam" action form the right action pane to go into the exam edit page.
- Use the drop down selection to change the type of the exam.
- Use the "Save Exam" action on the right action pane to save and confirm the task. This will lead you also back to the exam details page.
**Apply a SEB exam configuration**
**Remove a SEB exam configuration**
**Add an indicator**
**Modify indicators**
**Apply automated SEB restriction**
- Login as an exam administrator and go to the "Exam" page under the "Exam Administration" section.
- Use the filter to find the exam on that you have to change the supporter assignments.
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- If the exam has already one exam configuration attached you have first to delete this attachment before being able to attach another exam configuration.
Use the "Delete Configuration" action from the right action pane to remove the attached exam configuration.
- Use the "Add Exam Configuration" action form the right action pane to open up the attachment dialog.
- If there is currently no exam configuration that can be attached to the exam, an information dialog will be shown instead of the attachment dialog.
- On the attachment dialog use the drop down selection to select the exam configuration you want to apply to the exam.
The drop down selection shows the names of the available exam configurations and you can filter this names by start typing the name of the exam configuration you
want to find in the input field of the selection.
- When you have selected a exam configuration the dialog shows you some additional information about the exam configuration.
- If you want or need to put an password protected encryption to the exam configuration for this exam you can do so by give the password for the encryption also within the attachment dialog.
Be aware that every SEB client that will receive an encrypted exam configuration from the SEB Server will prompt the user to give the correct password. In most cases an
encryption of the exam configuration is not needed, because a secure HTTPS connection form SEB client to SEB Server is already in place.

13
docs/exam_import.rst
View file

@ -76,4 +76,17 @@ Use Cases
** Import a course as exam**
To start setting up a course or quiz form an existing LMS as e-assessment with SEB and SEB Server you have to find this course or quiz on the
SEB Server and import it as exam. Define a type and apply exam supporter.
- Login as an exam administrator and go to the "LMS Exam Lookup" page under the "Exam Administration" section.
- If you are not sure if the LMS that runs your course has already been setup within the SEB server, go first to the "LMS Setup" page and try to find the particular LMS in the list.
If you can't find it, please contact an institutional administrator or setup the LMS by yourself as described in :ref:`lms-setup-label`.
- Find your course or quiz by using the filter of the list and the list navigation as usual.
- Double click on the list entries to get all information about a particular course or quiz.
- Once you have found the course or quiz, select it on the list and use the "Import Exam" action on the right action pane.
- The system will lead you to the exam import page where you see all the details of the course or quiz and where you can set a type and apply exam supporter before importing.
- Choose a type for the imported exam in the "Exam Type" selection. The type of an exam is currently just informative hand will cause no restriction for the imported exam.
- Select as many exam supporter as you want to be able to support the running exam. Read above, how to find and select exam supporter with the drop down multi selection.
- When all is properly set, use the "Save Exam" action on the right action pane to save the exam and complete the task.

0
docs/exam_indicator
View file

89
docs/exam_indicator.rst Normal file
View file

@ -0,0 +1,89 @@
.. _exam-indicators-label:
Monitoring Indicators
---------------------
For monitoring connected SEB clients, SEB server supports some indicators that can be defined within an exam and that are shown and measured during an
exam. When you import, the application automatically creates a default ping-indicator for the exam. You are able to modify this default indicator and also
add some other indicators to the exam to be able to get notified while monitoring a exam session.
The type of indicators are pre-defined within the SEB Server and restricts the number of available indicators that can be used. Currently following
indicators are supported:
- Last Ping Time: This indicator measures the time that has passed since the last ping from a specified SEB client was received by the SEB Server in milliseconds.
This can be used to monitor constant SEB client connections and get notified when a SEB client connection gets lost for some defined
time or when a SEB client connection that has been list is back again.
This indicator is used as default indicator and automatically applied to the exam on import. You are able to modify this indicator
and also delete it but we recommend to have this basic indicator in place for every exam.
- Errors: This indicator measures the number of error-logs a specified SEB client is sending to the SEB Server.
- Warnings: This indicator measures the number of warning-logs a specified SEB client is sending to the SEB Server.
You can define thresholds for each indicator. A threshold is defined by an indication-color and by a threshold-value. On the monitoring side, the
indicator for each SEB client connection with change to the threshold color when the measured indicator value has reached the threshold-value.
To add a new indicator to the exam you can use the "Add Indicator" action from the right action pane. In the indicator edit page you are able to give the
new indicator a name. This name will be displayed in the SEB client connection table on monitoring section as column name for the column of this
indicator. Then you are able to choose a "Type" that specifies the type of indicator. Choose this from a drop-down selection of supported indicators.
If you have selected one indicator type, a description will be shown just below the "Type" attribute.
You can define a "Default Color" for the indicator. An indicator which measured value has not reached any defines threshold will be shown in this
color on the SEB client connection table of the monitoring section.
.. note::
To select a color click on the brush-palette icon of the color input field to open up a color chooser pop-up window. Within the color chooser
you can select one of the basic colors provided by the chooser or by defining the red, green and blue part of the color.
.. image:: images/exam/lmsExamLookup.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/editIndicator.png
Below the default color you see a list of thresholds. Use the plus sign icon to add a new threshold to the list and on an existing threshold use
the minus sign icon to remove a particular threshold form the list. A threshold has a threshold-value and a threshold-color. The threshold value
must be set in the format of the measured indicator value that is described within the type description. This is usually an integer or floating-point
number. The color for each threshold can be set using the color chooser tool by clicking on the brush-palette icon on the right side of each threshold.
The color chooser pop-up is the same as for the default color.
.. note::
In the monitoring section when the exam is running, an indicator will be shown within a column with given name of the indicator in the SEB connection
table. For each connection the measured indicator value will be displayed in the cell of the individual SEB client connection rows. If the measured
indicator value for a particular SEB client reaches a defined threshold, the cell will be displayed in the defined color of the threshold.
Use Cases
---------
**Add an indicator**
- Login as an exam administrator and go to the "Exam" page under the "Exam Administration" section.
- Use the filter to find the exam on that you have to change the supporter assignments.
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- Use the "Add Indicator" action from the right action pane to create a new indicator. This will lead you to the indicator edit page.
- Set a name for the indicator and choose the type of indicator you want to use. Read the description above to learn more about indicators and supported types of indicators.
- You can also define a default color for the indicator that is displayed on the monitoring page while the exam is running and a particular SEB client has no incidence as defined for this indicator.
- To select a color use the brush-palette icon on the right side of the color input field to open up a color chooser dialog.
- Now you can define some threshold for the indicator that will help you find incidents and get informed about on the monitoring while the exam is running.
To do so you can use the plus icon on the threshold list to add a new empty threshold to the list. You can choose a value for the threshold and a color
that would indicate an overflow of the given value from the measured value of the indicator.
- To remove a already defined threshold from the list of threshold, use the minus icon on the right side of the particular threshold.
- When everything is set up properly use the "Save Indicator" action to save the indicator and go back to the exam details page.
- Back in the exam details page, you can check if your indicator is in the list and all thresholds are correctly set by going down to the indicators list of the exam.
**Modify indicators**
- Login as an exam administrator and go to the "Exam" page under the "Exam Administration" section.
- Use the filter to find the exam on that you have to change the supporter assignments.
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- Scroll down to the indicator section of the exam details page and find the indicator you want to modify.
- Double click on the indicator entry from the list to open the indicator edit page.
- In the indicator edit page modify the indicator for your new needs. Add / remove thresholds or change the name or type of the indicator.
- To confirm your changes and save the indicator, use the "Save Indicator" action from the right action pane.
**Delete an indicator**
- Login as an exam administrator and go to the "Exam" page under the "Exam Administration" section.
- Use the filter to find the exam on that you have to change the supporter assignments.
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- Scroll down to the indicator section of the exam details page and find the indicator you want to delete.
- Select the indicator from the list ans use the "Delete Indicator" action from the right action pane to delete the indicator.

69
docs/exam_restriction Normal file
View file

@ -0,0 +1,69 @@
.. _seb_restriction-label:
Automated SEB Restriction
--------------------------
If the corresponding LMS of an exam supports the automated SEB restriction feature, the SEB restriction can be managed within the exam details page.
To navigate to the exam details page of an exam go to the "Exam" page under the "Exam Administration", find the specified exam in the list by using
the list filter and double click on the list entry of the exam you want to open the details page.
In the exam details page you will see two action related to the SEB restriction feature on the right action pane.
.. image:: images/exam/sebRestriction.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/sebRestriction.png
Use the "Apply SEB Lock" on an exam that has not already locked the course for SEB on the LMS to do apply the restriction and lock the course or quiz
for SEB access only. This will call the SEB course restriction API on the LMS and will send all information to lock the course on the LMS.
On an exam where the restriction lock is already in place, use the "Release SEB Lock" action to remove the restriction in the LMS and unlock the course.
.. note::
If the exam is already running on import the system will automatically restrict the course on the LMS with the available restriction details.
Use the "SEB Restriction Details" action to open up a dialog to define all SEB restriction details that the LMS of the exam and its SEB course
restriction API is supporting. There are two global restriction details that are SEB specific and should be supported by every LMS that serves
a course restriction API for SEB. The `Config Key <https://safeexambrowser.org/developer/seb-config-key.html>`_ and the `Browser Exam Key <https://safeexambrowser.org/developer/documents/SEB-Specification-BrowserExamKey.pdf>`_.
The Config Key is automatically generated by the exam configuration that is applied to the exam. And the Browser Exam Key can be applied within a
comma separated list if needed.
.. image:: images/exam/sebRestrictionDetails.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/sebRestrictionDetails.png
**SEB restriction on Open edX**
To be able to use the SEB restriction feature with a Open edX LMS, you need to install the `SEB Open edX plugin <https://seb-openedx.readthedocs.io/en/latest/index.html>`_
from eduNEXT. Please consult the documentation for installing the `SEB Open edX plugin <https://seb-openedx.readthedocs.io/en/latest/index.html>`_ as well as for the
use of all additional supported restriction attributes.
.. note::
If you change the attached exam configuration either by changing the attachment or by changing the attributes of a attached exam configuration
for an exam that has the SEB restriction in place, the Config Key generated from the exam config that is also changing, will automatically be
updated on the LMS. Therefore such an action that triggers an update may take some more time to complete as when the restriction is not in place.
Use Cases
---------
**Modify SEB restriction details (Open edX)**
- Login as an exam administrator and go to the "Exam" page under the "Exam Administration" section.
- Use the filter to find the exam on that you have to change the supporter assignments.
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- Use the "SEB Restriction Details" action from the right action pane to open the restriction details dialog.
- In the restriction details dialog you will see all supported restriction attributes and you can define the restriction for your needs.
- To apply the new restriction details use the "OK" action of the dialog or use the "Cancel" action to abort and close the dialog.
- When the SEB restriction is active on the LMS, the system will automatically update the SEB restriction with the new details on the LMS.
- If the SEB restriction is not active in this moment, the details will be saved and applied when the restriction is activated.
**Apply automated SEB restriction (Open edX)**
- Login as an exam administrator and go to the "Exam" page under the "Exam Administration" section.
- Use the filter to find the exam on that you have to change the supporter assignments.
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- Use the "Apply SEB Lock" action from the right action pane to activate the SEB restriction lock for this course on the LMS.
- Use the "Release SEB Lock" action from the right action pane to deactivate the SEB restriction lock for this course on the LMS.
.. note::
If a SEB restriction lock is active on the LMS, every change on the exam or related components that will affect a change on the restriction
details will automatically be updated on the LMS. You don't have to apply the SEB restriction lock again for update.

BIN
docs/images/exam/sebRestriction.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 55 KiB

BIN
docs/images/exam/sebRestrictionDetails.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 54 KiB

2
docs/lmssetup.rst
View file

@ -1,6 +1,6 @@
.. _lms-setup-label:
Leraning Management System Setup
Learning Management System Setup
================================
Overview

101
docs/overview.rst
View file

@ -4,35 +4,58 @@ 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 a centralized manner. 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.
Furthermore SEB Server can be setup and run within a cloud infrastructure by general service provider.
For an organization or institution that wants to 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.
Furthermore SEB Server can be setup and run within a cloud infrastructure by general service provider to offer e-assessments with
SEB and SEB Server as a service.
SEB Server comes with a built-in multi-tenancy functionality that allows to create and maintain 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 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
Since SEB Server is generally an administration tool, meaning used to do administration work and tasks to setup and maintain e-assessments,
there is yet just a built-in and lightweight 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.
party account and/or single sign on.
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>`_
The key features of SEB Server are:
- Built-in multi-tenancy capabilities. Create and manage institutions as separated clients.
- Lightweight 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.
- Track user activities within user-activity-logs for the whole SEB Server or the a client.
- Create, export and maintain SEB client configurations. Those are needed to startup a Safe Exam Browser client with and contain all information
to connect securely to the SEB Server.
- Create and maintain SEB exam configurations. Those are sent to a SEB client on connection setup and contain all SEB settings for a particular e-assessment.
- Setup and maintain Learning Management Systems (LMS) like Open edX or Moodle to be able to navigate and find courses or quizzes on the LMS and to push access-restrictions to the LMS if supported by the LMS
- Import and maintain courses or quizzes form a LMS. Setup everything that is needed for an e-assessment that is based on a course or quiz form the LMS
- Apply indicators to the exams to indicate incidences while monitoring running e-assessments.
- Monitor running e-assessment and have an overview of all connected SEB clients. Manage SEB client connections and view logs sent by individual SEB clients.
.. _roles_and_usecases:
Roles and Use-Cases
-----------------------
The SEB Server supports a simple role based privilege system where a role has 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.
The privileges for a role are pre-defined and cannot be changed by a user. But 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
Privileges for domain objects are categorized in read, modify and write where write includes creation and deletion grants as well as activation grants in addition to the more
restrict modify right that only allows to modify already created entities. They are also categorized in overall, institutional and owner privileges where
overall means for all entities, over all available institutions and institutional means only the entities that belongs to the own institution
and owner means the creator or assigned owner of an entity.
whereas owner-privilege means the creator or assigned owner of an entity.
There are four different roles. This reflect a good separation of concerns within the SEB Server application administration itself and the setup and
maintaining work that has to be done for e-assessments with SEB.
@ -42,73 +65,74 @@ below are the names and a short description of each role.
**SEB Server Administrator**
This role is primarily to administer the SEB Server application, create new and maintain available 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.
This role is primarily to administer the SEB Server application. Create new and maintain available institutions and user-accounts. In addition to that a
SEB Server administrator also has overall read privileges for the most domains 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.
Another use-case would be to maintain registered user accounts, to give more privileges or the entirely deactivate a exisitng user account.
A typical use-case for a SEB Server administrator would be to create a new institution and an institutional administrator for this institution.
Another use-case would be to maintain registered user accounts, to give more privileges. Or to entirely deactivate an existing user account.
**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 belonging institution. Furthermore an institutional administrator is able to create and maintain
learning management system setups and SEB client-configurations for the belonging institution.
learning management system (LMS) setups and SEB client-configurations for the belonging institution.
A typical use-case for a institutional administrator is to give the appropriate roles and privileges to newly registered users of the institution.
A typical use-case for a institutional administrator would be to give the appropriate roles and privileges to newly registered users of the institution.
Or another use-case would be to create and maintain SEB client configurations for the institutions and setup and maintain learning management systems
within the SEB Server and the belonging institution.
**Exam Administrator**
With this role a user is able to prepare an exam for an e-assessment with SEB. A exam administrator is able to view all courses form all
With this role a user is able to prepare an exam for an e-assessment with SEB. A exam administrator is able to view all courses from all
learning management systems that are setup for the belonging institution and find a particular course to import this course as an exam
within SEB Server. This role is also able to create and maintain SEB exam configurations that can then be assigned to an imported exam.
After setting importing an exam, the role is able to setup all aspects of an exam like automated restrictions, allowed supporter and
monitoring indicator, to name a few, and prepare the exam for an e-assessment.
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.
A typical use-case for an exam administrator would be to create a SEB exam configuration within the templating and configuration section.
Then to find a particular course or quiz from the learning management systems that is defined within the institution. This course or quiz
can then be imported by the administrator as an exam. After import an exam administrator is able to prepare this exam for run and monitoring by attaching
a exam configuration to it, prepare indicators to monitor incidences and specify the SEB access-restriction conditions for the course or quiz.
**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.
This role is to support a running exam within SEB Server. An exam supporter is able to see the running exams on that he/she has
an assignment and can open them either for monitoring or editing some exam attributes 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.
A typical use-case for an exam supporter would be when 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
What one will 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.
page to create a new user-account. The newly created user account will only have the Exam Supporter role assigned. If you need another
role or more privileges, this must be given and granted by an institutional administrator of the belonging 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.
Fill in the register form and create a new account. After the user account has been successfully created, 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.
With the "Time Zone" you can choose a specific time zone for your user-account. All dates and times will then be showed within this time zone.
.. _gui-label:
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
After successful login, you 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
the main content section will show the activity content and the action that are possible for this activity on the right hand side.
.. image:: images/overview/overview.png
:align: center
@ -120,17 +144,20 @@ The main content usually consist of a list or a form.
**Lists**
A list shows all the objects of a particular activity in a table page. A list has paging and if a list has more objects than it fit on one page,
a page navigation is shown at the bottom of the list with the information of the current page and the number of pages along with a page navigation
A list shows all the objects of a particular activity in a table page. A list has paging functionality and the list has more objects than fitting all on one page,
a page navigation is shown at the bottom of the list with the information of the current page and the number of pages along with the page navigation
that can be used to navigate forward and backward thought the list pages.
Almost all lists have the ability to filter the content by certain column filter that are right above the corresponding columns.
To filter a list one can use the column filter input to narrow down a specific collection of content. Accordingly to the value type of the column,
You can use the column filter input to filter the list and to narrow down a specific collection of content. Accordingly to the value type of the column,
there are different types of filter:
- Selection, to select one instance of a defined collection of values (drop-down).
- Text input, to write some text that a value must contain.
- Date selection, To select a from-date from a date-picker. A date selection can also have an additional time selection within separate input field
- Date range selection, To select a from- and a to-date within different inputs and a date-picker. A date range selection can also have an additional time range selection within separate input fields
.. image:: images/overview/list.png
@ -141,11 +168,11 @@ A list can be sorted within a column by clicking in the column header. The order
column header of the sorted column. If sorting functionality is available for a column depends on the column type. There are a few columns
that do not have a sort functionality yet.
Most columns have a short tool-tip description that pops up while the mouse pointer stays over the column header for a moment.
A column tool-tip usually also explains how to use the column-related filter
A column tool-tip usually also explains how to use the column-related filter.
**Forms**
Forms are used for object specific data input or presentation, like HTML Forms usually do. Forms appear in three
Forms are used for domain entity specific data input or presentation, like HTML Forms usually do. Forms appear in three
different ways within the SEB Server GUI:
- When a object is first created in edit mode
@ -164,8 +191,8 @@ The following images shows the same form, once in read-only mode and once edit m
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/overview/form_edit.png
There usually there is a tool-tip on a form field element that is activated either by going over and stay on the form field label or the input section.
If a form field is mandatory to either create or save an object, this is marked within a little red arrow just to the right of the form field label.
There may be more validation take place on saving the object. If a input needs a special form that is not given by the current input, the form-field
There usually is a tool-tip on a form field element for almost all attributes that can be activated by either going over and stay on the form field label or the input section.
If a form field is mandatory to either create or save an object, this is marked with a little red arrow just to the right of the form field label.
There may be more field validations takes place on saving the object. If a input needs a special form that is not given by the current input, the form-field
will be marked with a red border and a thin red explanation text is shown right below the input field. After correct the missing or wrong input and save again,
the SEB Server will accept and process the changes. If the user navigates away from a form in edit mode, the GUI will inform about possible data loss and asks for proceed or abort.