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

docu

Browse source
This commit is contained in:
anhefti 2020-05-12 14:22:15 +02:00
parent f6039c97a9
commit 4a37b039fe
9 changed files with 224 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.rst
View file

@ -33,15 +33,20 @@ SEB Server provides a range of basic functionality:
SEB - SEB Server Compatibility
------------------------------
.. csv-table:: Compatible SEB Client Versions
The table below shows available and upcomming 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 oficial release date.
**SEB Server Version 1.0.X**
.. csv-table::
:header: "Platform / OS", "Beta/RC Version", "Release Version"
:widths: 15, 10, 30
"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
------------------

112
docs/exam.rst
View file

@ -109,87 +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 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.
- **: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
--------------------------
If the LMS and the LMS integration of an exam supports the automated SEB restriction feature, the SEB restriction
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