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

SEBSERV-496

Browse source
This commit is contained in:
anhefti 2024-03-27 14:40:54 +01:00
parent 96c403f12a
commit 9b930347f0
27 changed files with 254 additions and 163 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/certificates.rst
View file

@ -18,7 +18,7 @@ Once a certificate has been uploaded to SEB Server it can be used for various ot
One feature that also comes with the SEB Server version 1.2 is the ability to encrypt a connection configuration with a certificate
that has the right purpose (Identity) to do so. If you need this feature already, please have a look at: :ref:`connection-configuration-label`.
Other planed features are the import of certificate encrypted exam configurations as well as to embed certificates within an exam configuration
to allow certificate pinning between SEB and LMS.
to allow certificate pinning between SEB and LMS/Assessment Tool.
There is currently certificate upload support for two version of certificates:

2
docs/configurations.rst
View file

@ -21,7 +21,7 @@ This feature is currently in an experimental state and may be changed and / or e
An new feature since SEB Server version 1.2 is the integrated certificate store where an administrator is able to upload and register
certificates. The certificates can then be used to encrypt and secure a connection configuration for example. Or as planned for another
SEB Server release, to embed into an exam configuration for SEB to allow certificate pinning on SEB - LMS communication.
SEB Server release, to embed into an exam configuration for SEB to allow certificate pinning on SEB - LMS/Assessment Tool communication.
.. toctree::

42
docs/exam.rst
View file

@ -1,7 +1,7 @@
Prepare Exam
=============
This chapter is about setting up and prepare a already imported exam on SEB Server. If you don't have imported a course or quiz from LMS
This chapter is about setting up and prepare a already imported exam on SEB Server. If you don't have imported a course or quiz from LMS/Assessment Tool
as an exam into SEB Server, please see the previous chapter for detailed guidance about hot to import an exam.
To find a specific exam that has already been imported, go to "Exam Administration" / "Exam" on the navigation menu on the left hand side to
@ -14,7 +14,7 @@ see a list of all available exams. You are able to filter and sort the list as u
Double click on the list entry of the exam or select the list entry and use the "View Exam" action of the action pane on the right hand side to
open the exam in the detail view. Within the detail view of the exam you are able to edit the exam attributes, apply SEB exam configuration and
indicators for monitoring as well as defining details of the SEB restriction if this feature is available from the LMS.
indicators for monitoring as well as defining details of the SEB restriction if this feature is available from the LMS/Assessment Tool.
.. note::
If an exam is already running but is missing some essential setup, this is noted by the system. In the exam detail view the system
@ -28,12 +28,12 @@ indicators for monitoring as well as defining details of the SEB restriction if
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
- **End-Time**: Is the date and time when the exam ends. This is defined on the LMS
- **LMS Exam Identifier**: Is the identity of the course on the LMS (external identifier/primary key)
- **LMS Exam URL**: Is the start URL of the course/exam
- **Name**: Is the name of the course, defines on the LMS/Assessment Tool
- **LMS/Assessment Tool Setup**: Is the name of the LMS/Assessment Tool 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/Assessment Tool
- **End-Time**: Is the date and time when the exam ends. This is defined on the LMS/Assessment Tool
- **LMS/Assessment Tool Exam Identifier**: Is the identity of the course on the LMS/Assessment Tool (external identifier/primary key)
- **LMS/Assessment Tool Exam URL**: Is the start URL of the course/exam
To edit the SEB Server relevant attributes you can use
the "Edit Exam" action from the action pane on the right hand side to switch to the exam edit mode. In the exam edit mode you can modify
@ -73,9 +73,19 @@ the pop-up shows the description and the status of the selected configuration.
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/addExamConfig.png
There is also the possibility to encrypt the SEB exam configuration by a password. This is done before the SEB configuration is send to a connecting
SEB client. Since in the moste cases the SEB client connections are over HTTPS / TSL there is alrady a good protection in place and an
SEB client. Since in the most cases the SEB client connections are over HTTPS / TSL there is already a good protection in place and an
additional encryption of the SEB exam configuration is not recommended. Anyway, if you decide the use the additional password encryption, the SEB
client that receives the encrypted SEB exam configuration will prompt the user for the password to proceed and connect to the LMS.
client that receives the encrypted SEB exam configuration will prompt the user for the password to proceed and connect to the LMS/Assessment Tool.
With SEB Server Version 1.6 it is possible to change the Exam Configuration encryption password of an applied Exam Configuration.
The new action "Edit Encryption Password" can be used to open up the original apply dialog and to change the password:
.. note::
The Encryption Password for applied Exam Configuration can only be changes when there are no active SEB clients available for the exam.
.. image:: images/exam/editEncryptionPassword.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/editEncryptionPassword.png
.. 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
@ -86,19 +96,19 @@ client that receives the encrypted SEB exam configuration will prompt the user f
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.
Click the "OK" button on the pop-up to apply the selected SEB exam configuration. You will see the applied SEB exam configuration in the list.
If the automated SEB restriction feature is supported by the LMS of the exam, the application of a SEB exam configuration will automatically update
If the automated SEB restriction feature is supported by the LMS/Assessment Tool of the exam, the application of a SEB exam configuration will automatically update
the SEB restriction details with the generated Config-Key. See :ref:`sebRestriction-label` for more information.
.. image:: images/exam/examConfig.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examConfig.png
To just generate the Config-Key for testing purposes or to manually apply it on an LMS without the automated SEB restriction feature you can
To just generate the Config-Key for testing purposes or to manually apply it on an LMS/Assessment Tool without the automated SEB restriction feature you can
use the "Export Config-Key" action to generate the key. The Config-Key is presented by a pop-up and can be selected and copied to the clip-board.
For more information about the Config-Key its purpose and use, please visit the `SEB documentation <https://www.safeexambrowser.org/developer/seb-config-key.html>`_.
To remove an already applied SEB exam configuration from the exam, select the SEB exam configuration in the table and use the "Delete Exam Configuration"
action form the right action pane. If the automated SEB restriction feature is supported by the LMS of the exam, the removal of a SEB exam configuration will
action form the right action pane. If the automated SEB restriction feature is supported by the LMS/Assessment Tool of the exam, the removal of a SEB exam configuration will
automatically update the SEB restriction details and remove the Config-Key form the restriction details. See :ref:`sebRestriction-label` for more information.
Once you have removed a SEB exam configuration from the exam you are able to apply another one to the exam.
@ -152,7 +162,7 @@ your institution use the type information of the exam to set them into context.
**Archive an exam**
Since SEB Server version 1.4 it is possible to archive an exam that has been finished. An archived exam and all its data is still available
on the SEB Server but read only and the exam is not been updated from the LMS data anymore and it is not possible to run this exam again.
on the SEB Server but read only and the exam is not been updated from the LMS/Assessment Tool data anymore and it is not possible to run this exam again.
This is a good use-case to organize your exams since archived exam are not shown in the Exam list with the default filter anymore. They are
only shown if the status filter of the exam list is explicitly set to Archived status. An they are shown within the new "Finished Exam"
@ -162,8 +172,8 @@ section in the monitoring view.
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/archiveExamsFilter.png
This is also a good use-case if you want to remove an LMS and LMS Setup but still want to be able to access the exams data on the SEB Server.
In this case you can archive all exams from that LMS Setup before deactivating or deleting the respective LMS Setup.
This is also a good use-case if you want to remove an LMS/Assessment Tool and LMS/Assessment Tool Setup but still want to be able to access the exams data on the SEB Server.
In this case you can archive all exams from that LMS/Assessment Tool Setup before deactivating or deleting the respective LMS/Assessment Tool Setup.
To archive a finished exam you just have to use the "Archive Exam" action on the right action pane of the exam view:

10
docs/exam_config.rst
View file

@ -8,7 +8,7 @@ Overview
An exam configuration defines all the SEB settings for an exam. A SEB client that is connecting to SEB Server
and an exam defined by the SEB Server is downloading this exam configuration from SEB Server and reconfigure itself before accessing the
exam on the learning management system (LMS) and present it to the user.
exam on the learning management system (LMS/Assessment Tool) and present it to the user.
.. note::
For more information and detailed description of the SEB settings, see `SEB Configuration <https://www.safeexambrowser.org/windows/win_usermanual_en.html#configuration>`_.
@ -86,7 +86,7 @@ from the right action pane in the SEB settings view. This will start a usual bro
of the file of an exam configuration is "SEBExamSettings.seb".
SEB Server supports also the `SEB Config-Key <https://safeexambrowser.org/developer/seb-config-key.html>`_ that is used to validate the SEB configuration
on the LMS and adds a higher security level to the exam. This is supported if the specific type of LMS supports the automated SEB restriction feature. Anyways
on the LMS/Assessment Tool and adds a higher security level to the exam. This is supported if the specific type of LMS/Assessment Tool supports the automated SEB restriction feature. Anyways
sometimes it may be needed to manually extract the `SEB Config-Key <https://safeexambrowser.org/developer/seb-config-key.html>`_ for an exam configuration.
Therefore, one can use the "Export Client-Key" action from the right action pane to generate the Config-Key from the actual saved SEB settings revision
of the exam configuration. The key will be presented by a pop-up dialog where it can be copied for further use.
@ -223,8 +223,8 @@ to another exam that has to be configured for SEB.
**Generate and Export the Config-Key of an Exam Configuration**
Usually the `SEB Config-Key <https://safeexambrowser.org/developer/seb-config-key.html>`_ that is used to validate the SEB configuration
on the LMS is propagated automatically to a LMS by the SEB Server with the automated SEB restriction feature. But For testing purposes you need to generate and export the
`SEB Config-Key <https://safeexambrowser.org/developer/seb-config-key.html>`_ and set it manually on the LMS.
on the LMS/Assessment Tool is propagated automatically to a LMS/Assessment Tool by the SEB Server with the automated SEB restriction feature. But For testing purposes you need to generate and export the
`SEB Config-Key <https://safeexambrowser.org/developer/seb-config-key.html>`_ and set it manually on the LMS/Assessment Tool.
- Sign into SEB Server with your exam administrator role account.
- Navigate to the "Exam Configuration" menu within the SEB Configuration section on the left-hand side.
@ -281,7 +281,7 @@ In the current version of SEB Server, there are some differences to some SEB set
- Additional Dictionaries: There are only the SEB client default dictionaries available in the current SEB Server version.
- Additional Resources: Additional resources are currently not available in the current SEB Server version.
- Embedded Certificates: There is currently no certificate management possible on current SEB Server version.
- Browser Exam Key: There is currently no possibility to generate the Browser Exam Key on the SEB Server. But an already generated Browser Exam Key may be used within the SEB restriction feature on the exam configuration if this feature is supported by the LMS in use.
- Browser Exam Key: There is currently no possibility to generate the Browser Exam Key on the SEB Server. But an already generated Browser Exam Key may be used within the SEB restriction feature on the exam configuration if this feature is supported by the LMS/Assessment Tool in use.
**SEB settings that have a slightly different form or handling in SEB Server comparing to the SEB configuration tool**

42
docs/exam_import.rst
View file

@ -1,15 +1,15 @@
Import LMS Course as Exam in SEB Server
Import LMS/Assessment Tool Course as Exam in SEB Server
=======================================
To be able to configure and manage a course or parts of a course existing on a LMS as an exam on SEB Server we first need to import
an exam from the one of the available courses from a LMS that has been setup to use within the SEB Server.
To be able to configure and manage a course or parts of a course existing on a LMS/Assessment Tool as an exam on SEB Server we first need to import
an exam from the one of the available courses from a LMS/Assessment Tool that has been setup to use within the SEB Server.
.. note::
If you don't have already set up a LMS binding within SEB Server and your institution, you have to do this first.
More information about setting up a LMS binding can be found in the chapter :ref:`lms-setup-label`
If you don't have already set up a LMS/Assessment Tool binding within SEB Server and your institution, you have to do this first.
More information about setting up a LMS/Assessment Tool binding can be found in the chapter :ref:`lms-setup-label`
You will find the list of available courses provided from all LMS that are bound within your institution by going to the "Exam Administration"
section on the left hand side and choosing "LMS Exam Lookup". The SEB Server will present you the list of all available courses and you
You will find the list of available courses provided from all LMS/Assessment Tool that are bound within your institution by going to the "Exam Administration"
section on the left hand side and choosing "LMS/Assessment Tool Exam Lookup". The SEB Server will present you the list of all available courses and you
are able to filter and sort the list as usual to find to right course for import.
.. note::
@ -22,10 +22,10 @@ are able to filter and sort the list as usual to find to right course for import
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/lmsExamLookup.png
You can view more details of a course by double-click on the specific list entry or by selecting the list entry and click the "Show LMS Exam Details"
You can view more details of a course by double-click on the specific list entry or by selecting the list entry and click the "Show LMS/Assessment Tool Exam Details"
action form the action pane on the right hand side. The application will open a pop-up with available detail information of the course.
Since SEB Server version 1.5 the data-fetching-process to get all course data from bounded LMSs works as a background task and
Since SEB Server version 1.5 the data-fetching-process to get all course data from bounded LMS/Assessment Tools works as a background task and
the UI request will return anyway no matter if all data has been fetched already and presents the already available data.
If the background task is still running and fetching data, SEB Server will indicate that with a message note on top of the page
with the ability to reload the page by clicking on the respective icon in the note. With this approach you can now see whether all data
@ -41,19 +41,19 @@ from the action pane on the right hand side.
.. note::
If a course has already ended (End-Time passed) it is not possible to import this course and an appropriate message is shown.
On import, the application is creating an exam on SEB Server with a reference to the imported course on the LMS. All course specific data
On import, the application is creating an exam on SEB Server with a reference to the imported course on the LMS/Assessment Tool. All course specific data
like name, description, start-, end-time and course-identifier will not be stored on the SEB Server but always be referenced by the underling course.
This means, that the course data has to be modified on the LMS side as usual and the SEB Server always takes the actual data from the LMS for the
This means, that the course data has to be modified on the LMS/Assessment Tool side as usual and the SEB Server always takes the actual data from the LMS/Assessment Tool for the
course. This has the advantages of the principle of single responsibility and prevents synchronization issues.
You will see the creation page of the new exam with additional information:
- **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
- **End-Time**: Is the date and time when the exam ends. This is defined on the LMS
- **LMS Exam Identifier**: Is the identity of the course on the LMS (external identifier/primary key)
- **LMS Exam URL**: Is the start URL of the course/exam
- **Name**: Is the name of the course, defines on the LMS/Assessment Tool
- **LMS/Assessment Tool Setup**: Is the name of the LMS/Assessment Tool 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/Assessment Tool
- **End-Time**: Is the date and time when the exam ends. This is defined on the LMS/Assessment Tool
- **LMS/Assessment Tool Exam Identifier**: Is the identity of the course on the LMS/Assessment Tool (external identifier/primary key)
- **LMS/Assessment Tool Exam URL**: Is the start URL of the course/exam
You are now able to either choose an existing :ref:`exam-template-label` to initialize the new exam with the settings defined within the template
or to set the needed settings only for this exam. If you choose a template, the settings from the template will automatically be added to the exam
@ -76,7 +76,7 @@ and select another user. To remove a selected user from the selection-list, doub
To confirm the import use the "Save Exam" action of the action pane on the right hand side or use "Cancel" if you want to abort the import of the
exam and go back to the course list. If you have confirmed and successfully imported the exam, you will see the exam overview page where you are able
to edit the details of the exam, apply SEB restrictions of supported by the LMS, apply a SEB exam configuration for the exam and define indicators
to edit the details of the exam, apply SEB restrictions of supported by the LMS/Assessment Tool, apply a SEB exam configuration for the exam and define indicators
for monitoring the exam later on.
.. image:: images/exam/examReady.png
@ -91,11 +91,11 @@ 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
To start setting up a course or quiz form an existing LMS/Assessment Tool 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`.
- Login as an exam administrator and go to the "LMS/Assessment Tool Exam Lookup" page under the "Exam Administration" section.
- If you are not sure if the LMS/Assessment Tool that runs your course has already been setup within the SEB Server, go first to the "LMS/Assessment Tool Setup" page and try to find the particular LMS/Assessment Tool in the list. If you can't find it, please contact an institutional administrator or setup the LMS/Assessment Tool 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.

6
docs/exam_list.rst
View file

@ -3,15 +3,15 @@ Exam List
The exam list is shown directly within the "Exam" entry of the "Exam Administration" menu. You will have the usual filter and sort functionality
of lists within SEB Server. You can see exams that are running but has not complete setup yet, marked in read in the list. Additionally you see
Exams that currently has no connection to its origin LMS grayed in the list. This exams are not available on the LMS either because they didn't
exists anymore on the LMS or the SEB Server cannot connect to the LMS anymore. As soon as the SEB Server is able to get the LMS data again for a
Exams that currently has no connection to its origin LMS/Assessment Tool grayed in the list. This exams are not available on the LMS/Assessment Tool either because they didn't
exists anymore on the LMS/Assessment Tool or the SEB Server cannot connect to the LMS/Assessment Tool anymore. As soon as the SEB Server is able to get the LMS/Assessment Tool data again for a
once unreachable exam, the respective exam would change back to normal and is not grayed anymore.
.. image:: images/exam/examList.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examList.png
Sometimes an entire LMS is not available and a lot of exams are grayed. In this case you can use the new filter "Show/Hide Missing Exams" from the
Sometimes an entire LMS/Assessment Tool is not available and a lot of exams are grayed. In this case you can use the new filter "Show/Hide Missing Exams" from the
action pane on the right to filter out this exams from the list.
.. image:: images/exam/examListHideMissing.png

10
docs/exam_proctoring.rst
View file

@ -1,17 +1,17 @@
.. _sebProctoringSettings-label:
Optional Live Proctoring
(Deprecated) Live Proctoring
========================
.. attention::
Deprecation
Deprecation Note:
The SEB Server live proctoring integration with Zoom and Jitsi Meet will be deprecated within the next upcoming version of SEB Server 1.6.
The SEB Server live proctoring integration with Zoom and Jitsi Meet is deprecated in SEB Server 1.6.
The upcoming version of SEB Server, targeted for August 2024, will remove the live proctoring integration with Zoom and Jitsi Meet.
This means live proctoring is still available for dedicated SEB versions, but not actively maintained and supported any more.
Live proctoring is a new and yet experimental feature of SEB and SEB Server. The feature is fully optional and not enabled by default.
Live proctoring is experimental feature of SEB and SEB Server. The feature is fully optional and not enabled by default.
The main goal of the live proctoring feature is to support the integration
of an external meeting service like Jitsi Meet or Zoom for example, within a SEB and SEB Server setup for an exam.
In this scenario a SEB client is able to join a meeting and send audio and video data to the meeting where a proctor can watch the students during

40
docs/exam_quit_password.rst Normal file
View file

@ -0,0 +1,40 @@
.. _sebExamQuitPassword-label:
(New) Exam Quit Password
========================
Since SEB Server Version 1.6 it is possible to set the quit-password (usually set in the Exam Configuration/SEB Settings) while
creating or importing an Exam as well as for an existing exam. This is convenient if you want to use a different quit password for each exam
and when using Exam Templates to create Exams.
The quit password within the exam corresponds with the quit-password of an applied Exam Configuration. Thies means, if you change the
password on either site, it will be reflected on the other site. And, in the case a new Exam Configuration is applied an already set
quit password in Exam will have prior order against the a quit password set in the Exam Configuration. In any case the there
is no different quit password in the Exam Configuration then in the Exam. SEB Server guarantees that the quit password is always synchronized
within the following rules:
- Exam has no Exam Configuration but defines the quit password
- An Exam Configuration that is applied to the Exam will get the quit password from the Exam in the SEB Settings.
- An Exam Configuration that already has a quit password set and gets applied to the Exam will also get the quit password from the Exam with notify the user about the change.
- Exam has no Exam Configuration and no quit password set
- The Exam will get the quit password from the Exam Configuration if the Exam Configuration has defined such
- Quit Password is changed in the Exam edit view
- On save of the exam the applied Exam Configuration also gets the new quit-password
- Quit Password is changed in the Exam Configuration SEB Settings
- On Save / Publish of the Exam Configuration SEB Settings, an applied Exam will get the newly set quit password from the configuration
The quit password can be set on Exam creation or import:
.. image:: images/exam/quitPasswordImport.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/quitPasswordImport.png
As well as in the Exam edit view:
.. image:: images/exam/quitPasswordEdit.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/quitPasswordEdit.png
If the Exam was created from an LMS/Assessment Tool with SEB Server integration that allows to send the quit-password
to the LMS/Assessment Tool for display, SEB Server sends a new quit-password as on save. The LMS/Assessment Tool should
therefore also display always the actual quit password.

28
docs/exam_restriction.rst
View file

@ -3,7 +3,7 @@
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.
If the corresponding LMS/Assessment Tool 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.
@ -13,15 +13,15 @@ In the exam details page you will see two action related to the SEB restriction
: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.
Use the "Apply SEB Lock" on an exam that has not already locked the course for SEB on the LMS/Assessment Tool 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/Assessment Tool and will send all information to lock the course on the LMS/Assessment Tool.
On an exam where the restriction lock is already in place, use the "Release SEB Lock" action to remove the restriction in the LMS/Assessment Tool 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.
If the exam is already running on import the system will automatically restrict the course on the LMS/Assessment Tool 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
Use the "SEB Restriction Details" action to open up a dialog to define all SEB restriction details that the LMS/Assessment Tool 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/Assessment Tool 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.
@ -32,14 +32,14 @@ comma separated list if needed.
**SEB restriction on Open edX**
To be able to use the SEB restriction feature with an Open edX LMS, you need to install the `SEB Open edX plugin <https://seb-openedx.readthedocs.io/en/latest/index.html>`_
To be able to use the SEB restriction feature with an Open edX LMS/Assessment Tool, 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.
updated on the LMS/Assessment Tool. 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
@ -53,7 +53,7 @@ Use Cases
- 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.
- When the SEB restriction is active on the LMS/Assessment Tool, the system will automatically update the SEB restriction with the new details on the LMS/Assessment Tool.
- If the SEB restriction is not active in this moment, the details will be saved and applied when the restriction is activated.
@ -62,9 +62,9 @@ Use Cases
- 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.
- Use the "Apply SEB Lock" action from the right action pane to activate the SEB restriction lock for this course on the LMS/Assessment Tool.
- Use the "Release SEB Lock" action from the right action pane to deactivate the SEB restriction lock for this course on the LMS/Assessment Tool.
.. 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.
If a SEB restriction lock is active on the LMS/Assessment Tool, every change on the exam or related components that will affect a change on the restriction
details will automatically be updated on the LMS/Assessment Tool. You don't have to apply the SEB restriction lock again for update.

12
docs/exam_template.rst
View file

@ -7,7 +7,7 @@ Overview
--------
Exam templates are a new, useful feature available since SEB Server version 1.3. Within exam templates it is possible to create specific named templates that can be
used by an exam import from LMS course/quiz and define default settings and indicators that are automatically be applied on the exam import.
used by an exam import from LMS/Assessment Tool course/quiz and define default settings and indicators that are automatically be applied on the exam import.
Furthermore, exam templates gives you the possibility to map exam configuration template to automatically create and map an exam configuration for an exam on import.
This is very convenient if you have a lot of exams to set up that all have the same or similar settings. In such a case you can create an exam template
with all the common settings for that exams and use it on exam import.
@ -67,8 +67,8 @@ look like the ones on the Exam and will get copied for an exam imported with the
Import Exam with Template
-------------------------
Once one or more exam template exists, you are able to select one while importing an exam from the LMS in the "LMS Exam Lookup" section. Just as usual
use the "Import as Exam" action for a LMS exam that you want to import.
Once one or more exam template exists, you are able to select one while importing an exam from the LMS/Assessment Tool in the "LMS/Assessment Tool Exam Lookup" section. Just as usual
use the "Import as Exam" action for a LMS/Assessment Tool exam that you want to import.
.. image:: images/exam_template/select1.png
:align: center
@ -119,9 +119,9 @@ a of great help while shorten the setup process and reduces the work that must b
**Use an existing Exam Template on Exam import**
- Sign in as an Exam Administrator and select the "LMS Exam Lookup" sub-menu of the "Exam Administration" section in the left menu pane.
- Here you can see all exams form the LMS that are bound to the SEB Server. Select the specific exam that you want to import.
- Use "Import as Exam" from the right action pane to import that exam from the LMS as usual.
- Sign in as an Exam Administrator and select the "LMS/Assessment Tool Exam Lookup" sub-menu of the "Exam Administration" section in the left menu pane.
- Here you can see all exams form the LMS/Assessment Tool that are bound to the SEB Server. Select the specific exam that you want to import.
- Use "Import as Exam" from the right action pane to import that exam from the LMS/Assessment Tool as usual.
- In the exam import initialization step you now have a new selector to select an Exam Template that shall be applied.
- If there is a default Exam Template defined for the institution, this is pre-selected and already applied. If not you have to select the template of your choice.
- By selecting an Exam Template the template attributes are already applied and you see the respective attributes in the exam settings.

4
docs/exam_with_url.rst Normal file
View file

@ -0,0 +1,4 @@
.. _sebExamWithURL-label:
(New) Exam With URL
========================

7
docs/exams.rst
View file

@ -2,9 +2,9 @@ Exams
=====
Within an exam in SEB Server all threads come together to set up a e-assessment with Safe Exam Browser and SEB Server. An exam can be imported
from a course that exists on an LMS that was bound with a LMS Setup. An exam configuration that was formerly created can be attached to the exam by
from a course that exists on an LMS/Assessment Tool that was bound with a LMS/Assessment Tool Setup. An exam configuration that was formerly created can be attached to the exam by
choosing one from the library. Indicators can be defined that are shown in the monitoring section while monitoring a running exam. And if
the API of the specified LMS integration supports individual SEB restriction attributes for a e-assessment, this can also be defined and managed
the API of the specified LMS/Assessment Tool integration supports individual SEB restriction attributes for a e-assessment, this can also be defined and managed
on the exam management of SEB Server.
We will go through all the steps to setting up an exam for Safe Exam Browser with SEB Server one by one.
@ -13,7 +13,9 @@ We will go through all the steps to setting up an exam for Safe Exam Browser wit
:maxdepth: 1
exam_import
exam_with_url
exam
exam_quit_password
exam_indicator
exam_clientgroups
exam_ask
@ -21,3 +23,4 @@ We will go through all the steps to setting up an exam for Safe Exam Browser wit
exam_proctoring
exam_list
exam_template

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

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 66 KiB

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

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 50 KiB

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

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 54 KiB

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

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 68 KiB

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

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 47 KiB

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

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 49 KiB

BIN
docs/images/monitoring/issueFilter1.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 78 KiB

BIN
docs/images/monitoring/issueFilter2.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 67 KiB

BIN
docs/images/monitoring/issueFilter3.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 77 KiB

2
docs/institution.rst
View file

@ -109,7 +109,7 @@ the form.
To deactivate an institution one can use the "Deactivate Institution" action form the action pane on the right side.
When an institution is been deactivated, also all existing and active entities that belongs to this institution are deactivated too.
This affects user-accounts, configurations and LMS Setups. On deactivation action, the application will search the affected entities
This affects user-accounts, configurations and LMS/Assessment Tool Setups. On deactivation action, the application will search the affected entities
and will inform the administrator about the number of the affected entities and asks for confirmation.
After Confirm the deactivation the institution and all affected entities will be deactivated. This means also the user-accounts that has
not an institutional role or the SEB Server administration role, will not be able to log in anymore.

150
docs/lmssetup.rst
View file

@ -6,18 +6,18 @@ Learning Management System Setup
Overview
--------
To be able to connect to a learning management system (LMS), to view and manage the courses provided by a LMS is an essential feature of the SEB Server.
To setup an exam or e-assessment for SEB on SEB Server that is based on a course from a LMS, we have to make a binding to the course on the LMS.
This is also used to always get the actual course data from LMS like start- end-time, name and others.
Another feature of SEB Server that needs a LMS communication is the SEB restriction. A SEB restriction will restrict course access on the LMS only
To be able to connect to a learning management system (LMS/Assessment Tool), to view and manage the courses provided by a LMS/Assessment Tool is an essential feature of the SEB Server.
To setup an exam or e-assessment for SEB on SEB Server that is based on a course from a LMS/Assessment Tool, we have to make a binding to the course on the LMS/Assessment Tool.
This is also used to always get the actual course data from LMS/Assessment Tool like start- end-time, name and others.
Another feature of SEB Server that needs a LMS/Assessment Tool communication is the SEB restriction. A SEB restriction will restrict course access on the LMS/Assessment Tool only
for connection with Safe Exam Browser and will also check if a Safe Exam Browser of trust is used and the right configuration is used by the
Safe Exam Browser that was defines for the exam on the SEB Server.
**Course API**
This API, provided by the LMS, is used by the SEB Server to query the available courses and the needed data for each course. This API
is needed to be able to import a course from the LMS as an exam into SEB Server and configure the course as an e-assessment with SEB.
Usually this API comes as a REST or SOAP API with the core LMS implementation or a plugin.
This API, provided by the LMS/Assessment Tool, is used by the SEB Server to query the available courses and the needed data for each course. This API
is needed to be able to import a course from the LMS/Assessment Tool as an exam into SEB Server and configure the course as an e-assessment with SEB.
Usually this API comes as a REST or SOAP API with the core LMS/Assessment Tool implementation or a plugin.
SEB Server supports this course API's so far:
- Open edX: The standard system `Open edX REST API <https://courses.edx.org/api-docs/>`_. The SEB Server uses the "courses" endpoints to get course data.
@ -27,42 +27,42 @@ SEB Server supports this course API's so far:
**SEB Restriction API**
If the automated SEB restriction functionality is available for a LMS depends on the following requirements:
If the automated SEB restriction functionality is available for a LMS/Assessment Tool depends on the following requirements:
- There must exist a SEB integration plugin that offers an API to put and pull SEB restrictions in the form of Config-Keys and/or Browser-Exam-Keys
To the LMS and a specific course on the LMS to restrict the access. Such a plugin may also offer additional restriction features like restricting
To the LMS/Assessment Tool and a specific course on the LMS/Assessment Tool to restrict the access. Such a plugin may also offer additional restriction features like restricting
on course section or course components or only for specified user roles.
- The SEB integration plugin must be installed on the LMS that is used by the SEB Server.
- The SEB integration plugin must be installed on the LMS/Assessment Tool that is used by the SEB Server.
For more information about known SEB integration plugins that are supported by the SEB Server see :ref:`lms-setup-rest-plugin-label`
Regardless if a supported LMS is missing the SEB integration plugin installation, the LMS can be used with the Course API and an exam
Regardless if a supported LMS/Assessment Tool is missing the SEB integration plugin installation, the LMS/Assessment Tool can be used with the Course API and an exam
setup will be possible but without automated SEB restriction feature.
To be able to connect to an LMS from SEB Server, we need to create an API access account on the LMS side that can be used by the SEB Server to
access the API of the LMS. How to do this for the different supported types of LMS see :ref:`lms-api-account-label`.
After such an account was created, the account credentials, username and password, can be used by the SEB Server to connect to the LMS.
Therefore we need to create a LMS Setup on the SEB Server.
To be able to connect to an LMS/Assessment Tool from SEB Server, we need to create an API access account on the LMS/Assessment Tool side that can be used by the SEB Server to
access the API of the LMS/Assessment Tool. How to do this for the different supported types of LMS/Assessment Tool see :ref:`lms-api-account-label`.
After such an account was created, the account credentials, username and password, can be used by the SEB Server to connect to the LMS/Assessment Tool.
Therefore we need to create a LMS/Assessment Tool Setup on the SEB Server.
.. image:: images/lmssetup/new.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/lmssetup/new.png
A SEB Server administrator role will be able to see the institution to which the LMS Setup belongs to while an institutional administrator
is only able to see and create LMS Setup for its own institution. The name of the LMS Setup should be unique and is to identify a LMS
SEB Server internally. Use the **"Type"** selector to specify the type of the LMS to bind to the SEB Server within the LMS Setup. Currently supported are:
A SEB Server administrator role will be able to see the institution to which the LMS/Assessment Tool Setup belongs to while an institutional administrator
is only able to see and create LMS/Assessment Tool Setup for its own institution. The name of the LMS/Assessment Tool Setup should be unique and is to identify a LMS/Assessment Tool
SEB Server internally. Use the **"Type"** selector to specify the type of the LMS/Assessment Tool to bind to the SEB Server within the LMS/Assessment Tool Setup. Currently supported are:
- **Testing**: This is for testing purposes only and can be used to mock a LMS to test exam settings. This type provides some mock-up courses within the
LMS API of the SEB Server that can be seen in the LMS Exam Lookup once the LMS text setup is active. This mock-up courses can be imported and configured
as exams like they would exist. But note the a SEB client that is trying to connect to such a course would not be able to connect to the LMS since it
- **Testing**: This is for testing purposes only and can be used to mock a LMS/Assessment Tool to test exam settings. This type provides some mock-up courses within the
LMS/Assessment Tool API of the SEB Server that can be seen in the LMS/Assessment Tool Exam Lookup once the LMS/Assessment Tool text setup is active. This mock-up courses can be imported and configured
as exams like they would exist. But note the a SEB client that is trying to connect to such a course would not be able to connect to the LMS/Assessment Tool since it
is not existing. But a SEB client is able to download the defined exam configuration for testing.
- **Open edX**: This type is to bind an existing `Open edX <https://open.edx.org/>`_ LMS system that is available on the Internet or intranet. The SEB
- **Open edX**: This type is to bind an existing `Open edX <https://open.edx.org/>`_ LMS/Assessment Tool system that is available on the Internet or intranet. The SEB
Server tries to make use of the above described API's of the Open edX system.
.. note::
If you want to use the automated SEB restriction feature too, the `Open edX SEB Plugin <https://seb-server.readthedocs.io/en/latest/lmssetup.html#lms-setup-rest-plugin-label>`_ must be installed properly on the LMS.
If you want to use the automated SEB restriction feature too, the `Open edX SEB Plugin <https://seb-server.readthedocs.io/en/latest/lmssetup.html#lms-setup-rest-plugin-label>`_ must be installed properly on the LMS/Assessment Tool.
- **Moodle**: This type is to bind an existing `Moodle <https://moodle.org//>`_ LMS system that is available on the Internet or intranet. The SEB
- **Moodle**: This type is to bind an existing `Moodle <https://moodle.org//>`_ LMS/Assessment Tool system that is available on the Internet or intranet. The SEB
Server tries to make use of the described API's of the Moodle system but there is currently no SEB restriction plugin available that works
with SEB Server. Note that Moodle integration is implemented partially within SEB Server version 1.1.x. Only the course access feature is implemented and the course restriction feature will come with a future SEB Server release
@ -71,101 +71,101 @@ SEB Server internally. Use the **"Type"** selector to specify the type of the LM
For SEB only access, using a auto-generated Browser Exam Key (BEK) for SEB restriction. Also the Moodle user name resolving for SEB Server monitoring is less error prone especially
if Single Sign On some kind of login provider for Moodle is involved. Furthermore the new SEB Server Plugin for Moodle will be constantly extended and improved with new features in the future.
- **Ans Delft**: This type is to bind SEB Server with an `Ans Delft <https://ans.app/>`_ LMS. With the API credentials from an Ans Delft instance, SEB Server is able
to connect to the Ans LMS and provide the common features for Course-Access, SEB Restriction and LMS User Session resolving.
- **Ans Delft**: This type is to bind SEB Server with an `Ans Delft <https://ans.app/>`_ LMS/Assessment Tool. With the API credentials from an Ans Delft instance, SEB Server is able
to connect to the Ans LMS/Assessment Tool and provide the common features for Course-Access, SEB Restriction and LMS/Assessment Tool User Session resolving.
- **Open Olat**: This type is to bind SEB Server with an `Open Olat <https://www.openolat.com/>`_ LMS. With the API credentials from an Open Olat instance, SEB Server is able
to connect to the Olat LMS and provide the common features for Course-Access, SEB Restriction and LMS User Session resolving. For more information please contact the Olat Development-Team at `OpenOLAT UZH <https://www.zi.uzh.ch/en/teaching-and-research/software-elearning/olat.html>`_
- **Open Olat**: This type is to bind SEB Server with an `Open Olat <https://www.openolat.com/>`_ LMS/Assessment Tool. With the API credentials from an Open Olat instance, SEB Server is able
to connect to the Olat LMS/Assessment Tool and provide the common features for Course-Access, SEB Restriction and LMS/Assessment Tool User Session resolving. For more information please contact the Olat Development-Team at `OpenOLAT UZH <https://www.zi.uzh.ch/en/teaching-and-research/software-elearning/olat.html>`_
The **"LMS Server Address"** is the root URL to connect to the LMS server with HTTP over the Internet or intranet. This is usually the URL that is
also used with the Browser to connect to the main page of the LMS system. And additionally the credentials that have been created with the creation of the :ref:`lms-api-account-label` has to be set in the LMS Setup the make the SEB Server
able to securely connect to the LMS. The API credentials that consists of a client-name and a client-secret must be used with the **"LMS Server Username"**
and the **"LMS Server Password"** fields of the LMS Setup form on SEB Server.
The **"LMS/Assessment Tool Server Address"** is the root URL to connect to the LMS/Assessment Tool server with HTTP over the Internet or intranet. This is usually the URL that is
also used with the Browser to connect to the main page of the LMS/Assessment Tool system. And additionally the credentials that have been created with the creation of the :ref:`lms-api-account-label` has to be set in the LMS/Assessment Tool Setup the make the SEB Server
able to securely connect to the LMS/Assessment Tool. The API credentials that consists of a client-name and a client-secret must be used with the **"LMS/Assessment Tool Server Username"**
and the **"LMS/Assessment Tool Server Password"** fields of the LMS/Assessment Tool Setup form on SEB Server.
Alternatively to **"LMS Server Username"** and **"LMS Server Password"** you can use a direct **Access Token** to connect to the LMS API if the respective LMS allows to
Alternatively to **"LMS/Assessment Tool Server Username"** and **"LMS/Assessment Tool Server Password"** you can use a direct **Access Token** to connect to the LMS/Assessment Tool API if the respective LMS/Assessment Tool allows to
generate and use an access token directly.
If the SEB Server running behind a proxy server or a firewall between SEB Server den LMS, the additional proxy settings can be used to setup the proxy-connection.
If the SEB Server running behind a proxy server or a firewall between SEB Server den LMS/Assessment Tool, the additional proxy settings can be used to setup the proxy-connection.
.. note::
To Setup a Test LMS Setup (of type "Test") only a correct URL pattern must be set like "http://test" for example. And API credentials can be anything but must be set.
To Setup a Test LMS/Assessment Tool Setup (of type "Test") only a correct URL pattern must be set like "http://test" for example. And API credentials can be anything but must be set.
After all the settings for a LMS Setup have been set, one can use either the "Save LMS Setup" action to save the LMS Setup without activation or the
"Activate LMS Setup" action to also activate the settings right after they has been successfully saved. Anyway, for both action there is an initial test
that, additionally to the usual field validation that takes place first, tries to connect to the LMS with the given API details. If the connection
After all the settings for a LMS/Assessment Tool Setup have been set, one can use either the "Save LMS/Assessment Tool Setup" action to save the LMS/Assessment Tool Setup without activation or the
"Activate LMS/Assessment Tool Setup" action to also activate the settings right after they has been successfully saved. Anyway, for both action there is an initial test
that, additionally to the usual field validation that takes place first, tries to connect to the LMS/Assessment Tool with the given API details. If the connection
wasn't successful, the SEB Server will inform the user about a possible reason of failure. Otherwise SEB Server shows a success message and the created
LMS Setup can be used.
LMS/Assessment Tool Setup can be used.
Use the "Activate / Deactivate LMS Setup" action to activate an inactive LMS Setup or the deactivate an active LMS Setup.
Use the "Activate / Deactivate LMS/Assessment Tool Setup" action to activate an inactive LMS/Assessment Tool Setup or the deactivate an active LMS/Assessment Tool Setup.
.. note::
On deactivation of an LMS Setup, the system checks on depending object and will show a confirmation to the user asking that all depending
objects will also been deactivated. Depending objects of an LMS Setup are exams that has been imported from the specified LMS Setup in the past.
On deactivation of an LMS/Assessment Tool Setup, the system checks on depending object and will show a confirmation to the user asking that all depending
objects will also been deactivated. Depending objects of an LMS/Assessment Tool Setup are exams that has been imported from the specified LMS/Assessment Tool Setup in the past.
Use Cases
---------
**Create a new LMS Setup for Open edX**
**Create a new LMS/Assessment Tool Setup for Open edX**
A new Open edX system has been installed within your institution and to be able to use the system also for e-assessments with SEB and SEB Server,
you have to bind the LMS to the SEB Server.
you have to bind the LMS/Assessment Tool to the SEB Server.
- If not already done, install the `Open edX SEB Plugin <https://seb-server.readthedocs.io/en/latest/lmssetup.html#lms-setup-rest-plugin-label>`_ on the Open edX system first.
- If you don't already have an API access account on Open edX side, `create one <https://seb-server.readthedocs.io/en/latest/lmssetup.html#lms-api-account-edx-label>`_
- Sign into SEB Server with your institutional administrator role account.
- Navigate to "Exam Administration" / "LMS Setup" within the navigation on the left hand side.
- Use the "Add LMS Setup" action from the right action pane to open a LMS Setup creation form.
- Give a unique name to the new LMS Setup for internally identification.
- Set the main URL that points to the new LMS system. This is usually the URL that is also used with the Browser to connect to the main page of the LMS system
- Navigate to "Exam Administration" / "LMS/Assessment Tool Setup" within the navigation on the left hand side.
- Use the "Add LMS/Assessment Tool Setup" action from the right action pane to open a LMS/Assessment Tool Setup creation form.
- Give a unique name to the new LMS/Assessment Tool Setup for internally identification.
- Set the main URL that points to the new LMS/Assessment Tool system. This is usually the URL that is also used with the Browser to connect to the main page of the LMS/Assessment Tool system
- Set the API credentials that has been creates within step two (client-id, secret).
- Use the "Activate LMS Setup" action on the right action pane to test, save and activate the new LMS Setup within one step.
- Use the "Activate LMS/Assessment Tool Setup" action on the right action pane to test, save and activate the new LMS/Assessment Tool Setup within one step.
.. note::
If some form attributes are missing or not correct, the SEB Server system will respond with the usual form validation errors.
If the connection to the LMS is failing because of missing or wrong credentials or for any other reason the system is not able to connect to the LMS
If the connection to the LMS/Assessment Tool is failing because of missing or wrong credentials or for any other reason the system is not able to connect to the LMS/Assessment Tool
the SEB Server will notify an error dialog to the user.
**Change API Credentials of an Active LMS Setup**
**Change API Credentials of an Active LMS/Assessment Tool Setup**
The API access account on the LMS has been expired and you have to create a new one or update the old one which both result in new API access credentials
that has to be set on the existing LMS Setup on the SEB Server.
The API access account on the LMS/Assessment Tool has been expired and you have to create a new one or update the old one which both result in new API access credentials
that has to be set on the existing LMS/Assessment Tool Setup on the SEB Server.
.. image:: images/lmssetup/list.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/lmssetup/list.png
- Sign into SEB Server with your institutional administrator role account.
- Navigate to "Exam Administration" / "LMS Setup" within the navigation on the left hand side.
- Use the Filter above the list to find the specified LMS Setup.
- Select the LMS Setup from the list and use the "Edit LMS Setup" action from the right action pane to open the LMS Setup in edit mode.
- Set the new credentials and make sure, the LMS Setup is still active.
- Use the "Save LMS Setup" action form the right action pane to save the changes and test the connection.
- Navigate to "Exam Administration" / "LMS/Assessment Tool Setup" within the navigation on the left hand side.
- Use the Filter above the list to find the specified LMS/Assessment Tool Setup.
- Select the LMS/Assessment Tool Setup from the list and use the "Edit LMS/Assessment Tool Setup" action from the right action pane to open the LMS/Assessment Tool Setup in edit mode.
- Set the new credentials and make sure, the LMS/Assessment Tool Setup is still active.
- Use the "Save LMS/Assessment Tool Setup" action form the right action pane to save the changes and test the connection.
.. note::
If some form attributes are missing or not correct, the SEB Server system will respond with the usual form validation errors.
If the connection to the LMS is failing because of missing or wrong credentials or for any other reason the system is not able to connect to the LMS
If the connection to the LMS/Assessment Tool is failing because of missing or wrong credentials or for any other reason the system is not able to connect to the LMS/Assessment Tool
the SEB Server will notify an error dialog to the user.
**Deactivate LMS Setup**
**Deactivate LMS/Assessment Tool Setup**
A LMS system that was running on your campus to provide e-assessment with SEB and SEB Server has been shut down and you need to also deactivate
the setup and exams on the SEB Server for this LMS.
A LMS/Assessment Tool system that was running on your campus to provide e-assessment with SEB and SEB Server has been shut down and you need to also deactivate
the setup and exams on the SEB Server for this LMS/Assessment Tool.
- Sign into SEB Server with your institutional administrator role account.
- Navigate to "Exam Administration" / "LMS Setup" within the navigation on the left hand side.
- Use the Filter above the list to find the specified LMS Setup.
- Select the specified LMS Setup from the list and use the "Deactivate LMS Setup" action from the right action pane.
- Alternatively you can also double-click on the LMS Setup to fist go into the detailed view of the LMS setup and use the "Deactivate LMS Setup" action there.
- The system informs you about the number of depending exams that also will be deactivated within the deactivation of the LMS Setup.
- Confirm the deactivation and notify that the LMS Setup now is listed as "Inactive" in the list.
- Navigate to "LMS Exam Lookup" to make sure the courses form the deactivated LMS Setup are not available anymore.
- Navigate also to "Exam" and make sure that all previously imported exams from the deactivated LMS Setup are not available anymore.
- Navigate to "Exam Administration" / "LMS/Assessment Tool Setup" within the navigation on the left hand side.
- Use the Filter above the list to find the specified LMS/Assessment Tool Setup.
- Select the specified LMS/Assessment Tool Setup from the list and use the "Deactivate LMS/Assessment Tool Setup" action from the right action pane.
- Alternatively you can also double-click on the LMS/Assessment Tool Setup to fist go into the detailed view of the LMS/Assessment Tool setup and use the "Deactivate LMS/Assessment Tool Setup" action there.
- The system informs you about the number of depending exams that also will be deactivated within the deactivation of the LMS/Assessment Tool Setup.
- Confirm the deactivation and notify that the LMS/Assessment Tool Setup now is listed as "Inactive" in the list.
- Navigate to "LMS/Assessment Tool Exam Lookup" to make sure the courses form the deactivated LMS/Assessment Tool Setup are not available anymore.
- Navigate also to "Exam" and make sure that all previously imported exams from the deactivated LMS/Assessment Tool Setup are not available anymore.
.. _lms-api-account-label:
API Access Account on LMS
API Access Account on LMS/Assessment Tool
--------------------------
.. _lms-api-account-edx-label:
@ -176,7 +176,7 @@ To be able to create an API access-account on Open edX you need a user-account w
**For Open edX Hawthorn and Ironwood versions following the steps below::**
- Login to Open edX LMS Administration with an appropriate user-account that has administration rights. And find the Users section:
- Login to Open edX LMS/Assessment Tool Administration with an appropriate user-account that has administration rights. And find the Users section:
.. image:: images/lmssetup/openEdxAPIAccess1.bmp
:align: center
@ -218,7 +218,7 @@ Once the client registration was successful the client id and client secret can
**Create Moodle API Access Account**
To be able to create an LMS Setup for Moodle you need a Moodle administrator or manager account. You can then use this account in the LMS Setup to connect to the LMS.
To be able to create an LMS/Assessment Tool Setup for Moodle you need a Moodle administrator or manager account. You can then use this account in the LMS/Assessment Tool Setup to connect to the LMS/Assessment Tool.
Since SEB Server uses some functions from the Moodle's mobile API, you have to make sure the web services for mobile apps are enabled within your Moodle setup.
To do so please login to Moodle with an administrator account and go to "Side Administration", scroll down to "Mobile App" and choose "Mobile Settings.
@ -257,8 +257,8 @@ Install SEB restriction API plugin
**Moodle Plugin for SEB Server**
There is a new SEB Server integration plugin for Moodle available since SEB Server 1.5 that can be used with the LMS Setup type Moodle with SEB Server Plugin.
This Plugin supports and improves all common SEB Server LMS binding features such as Course-Access, SEB Restriction and LMS Session Name Resolving.
There is a new SEB Server integration plugin for Moodle available since SEB Server 1.5 that can be used with the LMS/Assessment Tool Setup type Moodle with SEB Server Plugin.
This Plugin supports and improves all common SEB Server LMS/Assessment Tool binding features such as Course-Access, SEB Restriction and LMS/Assessment Tool Session Name Resolving.
It is also planed to extend and improve this plugin with new Moodle specific feature for further releases of SEB Server.
- `Documentation <https://github.com/ethz-let/moodle-quizzaccess_sebserver>`_
- `Repository <https://github.com/ethz-let/moodle-quizzaccess_sebserver>`_

50
docs/monitoring.rst
View file

@ -32,14 +32,18 @@ As default you should see at least all active connections instantly.
The list is automatically sorted in the way that SEB connections with incidents came to the top of the list and are then sorted by the
"User Name or Session" identifier criteria. The general SEB client connection attributes are:
- **User Name or Session** The user account or user session identifier sent by the LMS to the SEB client and from SEB client to the SEB Server. This identifier may vary depending on the LMS that is involved. For Open edX it is the user account identifier (username).
- **User Name or Session** This shows the the available user identification as soon as it is available in the following order:
- The IP Address of the device of the SEB client as long as the SEB has sent any user authentication yet.
- The machine name of the client device as soon as the SEB has sent it to SEB Server.
- The user login on the client machine as soon as the SEB has sent it to SEB Server.
- The user login on the LMS/Assessment Tool as soon as the SEB has sent it to SEB Server and SEB Server was able to resolve the login name via LMS/Assessment Tool
- **Connection Info** The IP address of the device the connected SEB client is running plus some additional information about the operating system and the SEB version.
- **Status** The status of the SEB client connection.
The following SEB connection states are defined:
- **Connection Requested** This state appears from when a SEB client contacted to SEB Server the first time until the SEB client has finished up the hand-shake protocol with the SEB Server and the student has logged into the LMS.
- **Active** This state appears after successful hand-shake and login into LMS and stays as long as the SEB connection is available and not closed or terminated
- **Connection Requested** This state appears from when a SEB client contacted to SEB Server the first time until the SEB client has finished up the hand-shake protocol with the SEB Server and the student has logged into the LMS/Assessment Tool.
- **Active** This state appears after successful hand-shake and login into LMS/Assessment Tool and stays as long as the SEB connection is available and not closed or terminated
- **Missing** This state appears when a SEB connection is currently in active state but has missing ping (last ping last longer than the highest ping threshold of the ping indicator).
- **Closed** This state marks a closed SEB connection that was once active.
- **Canceled** This state marks a SEB connection that has been canceled.
@ -87,6 +91,37 @@ are there for an exam and in which state.
.. note::
When a certain state filter is set to hide, and a particular SEB client connection switches into that state, it will automatically disappear from the list.
**New Issue and Group Filter**
A new SEB client group filter was added in SEB Server Version 1.6 to filter out certain configured SEB client groups. And since SEB Server Version 1.6
there is a new Issue filter for ASK (Application Security Key) checks as well as vor SEB client Version checks if they are enabled for an exam.
- For more information about SEB client groups, go to: :ref:`examClientgroups-label`
- For more information about ASK (Application Security Key), go to: :ref:`examASK-label`
- for more information about SEB client version restriction, please have a look into the :ref:`exam-configuration-label` SEB Settings
With the new Issue Filter it is possible to quickly filter out all SEB connections that do not have a certain issue. Or the other way
around, if you quickly want to show only the SEB client connections with a certain issue, you can use this filter.
- **ASK Issue Filter** This issue filter can be used to show only the SEB clients that has an ASK grant deny.
This is also possible for already closed SEB connections where you don's see the state of ASK grant within the status column anymore.
The image below shows active and inactive filter for active SEB connection as well as for inactive SEB connections.
.. image:: images/monitoring/issueFilter2.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/issueFilter2.png
.. image:: images/monitoring/issueFilter3.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/issueFilter3.png
- **SEB Client Group Filter** This issue filter filter all SEB client connection that are attached to a certain SEB client group.
.. image:: images/monitoring/issueFilter1.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/issueFilter1.png
Detailed View
-------------
@ -105,16 +140,15 @@ overview temporary network latency or other irregularities, when those two time
In the detail view you are also able to use the instructions "Quit SEB Client" and "Mark as Canceled" for the selected SEB client connection.
Optional Live Proctoring
(Deprecated) Live Proctoring
------------------------
.. attention::
Deprecation
Deprecation Note:
The SEB Server live proctoring integration with Zoom and Jitsi Meet will be deprecated within the next upcoming version of SEB Server 1.6.
This means live proctoring is still available for dedicated SEB versions, but not actively maintained and supported any more.
The SEB Server live proctoring integration with Zoom and Jitsi Meet is deprecated in SEB Server 1.6.
The upcoming version of SEB Server, targeted for August 2024, will remove the live proctoring integration with Zoom and Jitsi Meet.
Live proctoring is a new and yet experimental feature of SEB and SEB Server. The feature is fully optional and not enabled by default.
This section is about the live proctoring on monitoring a running exam and using the optional live proctoring within.

6
docs/overview.rst
View file

@ -27,8 +27,8 @@ The key features of SEB Server are:
- Track user activities within user-activity logs for the whole SEB Server or a client.
- Create, export, and maintain SEB connection 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) and e-assessment systems like Open edX, Moodle, OpenOlat or ANS to be able to navigate and find courses or quizzes on the system and to push access restrictions to it if supported by the particular LMS/e-assessment suite.
- Import and maintain courses or quizzes from an LMS. Setup everything that is needed for an e-assessment that is based on a course or quiz from the LMS
- Setup and maintain Learning Management Systems (LMS/Assessment Tool) and e-assessment systems like Open edX, Moodle, OpenOlat or ANS to be able to navigate and find courses or quizzes on the system and to push access restrictions to it if supported by the particular LMS/Assessment Tool.
- Import and maintain courses or quizzes from an LMS/Assessment Tool. Setup everything that is needed for an e-assessment that is based on a course or quiz from the LMS/Assessment Tool
- 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.
@ -64,7 +64,7 @@ Another use-case would be to maintain registered user accounts and to give more
An institutional administrator has overall read access for its institution and can modify the institution properties as well as
create new or maintain existing user accounts for the belonging institution. Furthermore, an institutional administrator can create and maintain
learning management system (LMS) setups and SEB connection configurations for the belonging institution.
learning management system (LMS/Assessment Tool) setups and SEB connection configurations for the belonging institution.
A typical use-case for an 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 connection configurations for the institutions and set up and maintain learning management systems

2
src/main/resources/config/application-dev-ws.properties
View file

@ -72,7 +72,7 @@ springdoc.swagger-ui.oauth.clientSecret=${sebserver.password}
springdoc.paths-to-exclude=/exam-api,/exam-api/discovery,/sebserver/error,/sebserver/check,/oauth,/exam-api/v1/*
# features
sebserver.feature.exam.seb.screenProctoring.enabled=true
sebserver.feature.exam.seb.screenProctoring.enabled=false
sebserver.feature.exam.seb.screenProctoring.bundled=true
sebserver.feature.exam.seb.screenProctoring.bundled.url=http://localhost:8090
sebserver.feature.exam.seb.screenProctoring.bundled.clientId=sebserverClient

2
src/main/resources/messages.properties
View file

@ -832,7 +832,7 @@ sebserver.exam.proctoring.form.collect.strategy.tooltip=This specifies the strat
sebserver.exam.proctoring.form.collectingRoomSize=Collecting Room Size
sebserver.exam.proctoring.form.collectingRoomSize.tooltip=The size of proctor rooms to collect connecting SEB clients into.
sebserver.exam.proctoring.deprecation.title=Deprecation Note:
sebserver.exam.proctoring.deprecation.message=The SEB Server live proctoring integration with Zoom and Jitsi Meet is deprecated in SEB Server 1.6.</br></br>The upcoming version of SEB Server, targeted for August 2024, will remove the live proctoring integration with Zoom and Jitsi Meet.
sebserver.exam.proctoring.deprecation.message=The SEB Server live proctoring integration with Zoom and Jitsi Meet is deprecated in SEB Server 1.6.<br/>The upcoming version of SEB Server, targeted for August 2024, will remove the live proctoring integration with Zoom and Jitsi Meet.
sebserver.exam.proctoring.form.appkey.jitsi=App Key
sebserver.exam.proctoring.form.appkey.jitsi.tooltip=The application key of the proctoring service server