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

Some minor typos in docs and user dialogs.

Browse source
This commit is contained in:
Luca Bösch 2022-04-01 10:07:35 +02:00
parent 1aab22d267
commit 836322eb0c
15 changed files with 106 additions and 106 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/configurations.rst
View file

@ -14,13 +14,13 @@ information about exam configuration see :ref:`exam-configuration-label`
Within Configuration Templates, it is possible to create templates for exam configuration. Within the current version of SEB Server
there is the possibility to define different default value(s) for each exam configuration attribute and also to define if the attribute
is been shown in the exam configuration or not. This allows an Exam Administrator to create a exam configuration template for exams
is been shown in the exam configuration or not. This allows an Exam Administrator to create an exam configuration template for exams
with context defines default values and also to be able to only see change the attributes that are relevant for an exam configuration.
This feature is currently in an experimental state and may be changed and / or expanded within future releases of SEB Server. See
:ref:`config-template-label`
An new feature since SEB Server version 1.2 is the integrated certificate store where an administator is able to upload and register
certificates. The certificates can then be used to encrypt and secure a connection configuration for example. Or as planed for another
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.
@ -30,4 +30,4 @@ SEB Server release, to embed into an exam configuration for SEB to allow certifi
connection_config
exam_config
config_template
certificates
certificates

16
docs/exam.rst
View file

@ -10,10 +10,10 @@ see a list of all available exams. You are able to filter and sort the list as u
.. note::
The "Start-Time" filter is usually set to the date one year before now or to some other default date in the past. The list shows only
the courses that has a start-time after that time. If you have long running courses and it may possible that a course has been stated
a year or two ago, you habe to adapt this "Start-Time" filter to view those courses that has been started before.
a year or two ago, you have to adapt this "Start-Time" filter to view those courses that has been started before.
Double click on the list entry of the exam or select the list entry and use the "View Exam" action of the action pain 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 attribute, apply SEB exam configuration and
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.
.. note::
@ -36,7 +36,7 @@ At the beginning of the page - if there is no note - you see all the details of
- **LMS 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 pain on the right hand side to switch to the exam edit mode. In the exam edit mode you can modify
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
the type of the exam "Exam Type". The exam type has currently only informational character and has no implication on SEB Server side but may be
used in the future to apply to different exam scenarios for SEB Server and SEB. Here you can also manage the accounts that shall be able to
support and monitor the exam. To do so, use the multi combo selection within the "Exam Supporter" attribute. Click in the
@ -52,7 +52,7 @@ Apply SEB Exam Configuration
Just below the exam details you will find the list of applied SEB exam configurations. Currently the number of SEB exam configurations that can be applied
to an exam is restricted to one since it is not yet possible to apply a SEB exam configuration not just to the exam but also to a specific user or a
specific group of users. This feature may come with a future release of seb server. But for now you are able to apply just one SEB exam configuration
to the exam and this configuration gets delivered to all the SEB clients that connect to the SEB server and participate to the exam.
to the exam and this configuration gets delivered to all the SEB clients that connect to the SEB Server and participate to the exam.
To apply a SEB exam configuration to an exam use the "Add Exam Configuration" action on the right action pane. A pop-up will prompt you to select an
SEB exam configuration by a drop-down selection. The drop-down box will present you all SEB exam configurations that are in state "Ready To Use" and
@ -70,7 +70,7 @@ the pop-up shows the description and the status of the selected configuration.
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
additional encryption of the SEB exam configuration is not recommended. Anyways, if you decide the use the additional password encryption, the SEB
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.
.. note::
@ -89,8 +89,8 @@ the SEB restriction details with the generated Config-Key. See :ref:`sebRestrict
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/examWithConfig.png
When a SEB exam configuration is applied to the exam you are able to export the SEB exam configuration XML in plain text or the generated Config-Key for
testing purposes. Just select the SEB exam configuration in the list to activate the action on the action pain on the right side and use the
When a SEB exam configuration is applied to the exam, you are able to export the SEB exam configuration XML in plain text or the generated Config-Key for
testing purposes. Just select the SEB exam configuration in the list to activate the action on the action pane on the right side and use the
appropriate action. The SEB exam configuration export action will instruct the browser to open a download dialog. How the download is applied is up the
the browser of use. Usually you are able to either save the file or open it up with a application. If you have already installed the Safe Exam Browser on
your device, the browser probably associates the download file already with the SEB client application.

8
docs/exam_import.rst
View file

@ -8,21 +8,21 @@ an exam from the one of the available courses from a LMS that has been setup to
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`
You will find the list of available courses provided form all LMS that are bound within your institution by going to the "Exam Administration"
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
are able to filter and sort the list as usual to find to right course for import.
.. note::
The "Start-Time" filter is usually set to the date one year before now or to some other default date in the past. The list shows only
the courses that has a start-time after that time. If you have long running courses and it may possible that a course has been stated
a year or two ago, you habe to adapt this "Start-Time" filter to view those courses that has been started before.
a year or two ago, you have to adapt this "Start-Time" filter to view those courses that has been started before.
.. image:: images/exam/lmsExamLookup.png
: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"
action form the action pain on the right hand side. The application will open a pop-up with available detail information of the course.
action form the action pane on the right hand side. The application will open a pop-up with available detail information of the course.
To import a course as an exam find the specific course on the list by using the filter and select the list entry. Use the "Import As Exam" action
from the action pane on the right hand side.
@ -81,7 +81,7 @@ To start setting up a course or quiz form an existing LMS as e-assessment with S
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`.
- 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.

6
docs/exam_indicator.rst
View file

@ -3,9 +3,9 @@
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
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.
add some other indicators to the exam to be able to get notified while monitoring an 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:
@ -82,5 +82,5 @@ Use Cases
- 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.
- Select the indicator from the list and use the "Delete Indicator" action from the right action pane to delete the indicator.

10
docs/exam_proctoring.rst
View file

@ -23,15 +23,15 @@ Currently supported meeting services are:
- `Zoom meeting service <https://zoom.us/>`_ with an account plan that fits your need and supports the `Zoom API and Client SDKs <https://marketplace.zoom.us/docs/sdk/native-sdks/developer-accounts>`_.
To bind and setup a live proctoring service in SEB Server for an exam, go to the view page of the exam and use the "Proctoring Settings" action on the right action pain to open up the proctoring settings dialog.
To bind and setup a live proctoring service in SEB Server for an exam, go to the view page of the exam and use the "Proctoring Settings" action on the right action pane to open up the proctoring settings dialog.
.. image:: images/exam/proctoringSettings.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/proctoringSettings.png
Within the proctoring settings dialog you are able switch the service on and off by using the "Proctoring enabled" checkbox. You also see if the proctoring service is enabled within
Within the proctoring settings dialog you are able to switch the service on and off by using the "Proctoring enabled" checkbox. You also see if the proctoring service is enabled within
the action icon that is either an eye when active or a slashed eye when not active.
To define and bind a service you have to chose a service type from the available service types. And you need to give the API access credentials like "Application Key" and "Secret" for
To define and bind a service you have to choose a service type from the available service types. And you need to give the API access credentials like "Application Key" and "Secret" for
the external meeting service. SEB Server will then try to connect to the meeting service with these credentials to automatically create meetings/rooms for proctoring.
Within the "Collecting Room Size" field you can define the number of maximal participants that shall be collected within one proctoring room. SEB Server will automatically
create these collecting rooms while SEB clients are connecting to the running exam in the monitoring view.
@ -58,7 +58,7 @@ After you have all the settings done, use "OK" to confirm the settings. SEB Serv
.. note::
Once a proctoring service is integrated for an exam, it is currently not possible to switch it to another service anymore.
This is because different services needs different meeting reference data on SEB Server and there is no conversion supported.
In the future we will make it possible to at least delete a already existing proctoring setup and to start from scratch.
In the future we will make it possible to at least delete an already existing proctoring setup and to start from scratch.
The SEB client settings for proctoring can be found in the "Exam Configuration" "SEB Settings". There is a new tab with the name "Proctoring" where all SEB settings for proctoring are available.
These settings are directly used by a SEB client that supports the proctoring feature. SEB will initialize with this settings when connecting to SEB Server and also will use this settings as default settings during an exam.
@ -68,7 +68,7 @@ These settings are directly used by a SEB client that supports the proctoring fe
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam/proctoringSEBSettings.png
Since SEB Server version 1.2 there is also an Zoom service section that let you define the default SEB settings for a Zoom proctoring setup.
Please be aware that not all of the settings are functioning yet. Please refer to the the settings tool-tip to get a actual description of
Please be aware that not all of the settings are functioning yet. Please refer to the settings tool-tip to get a actual description of
a particular SEB feature setting
**Jitsi Meet**

2
docs/exam_restriction.rst
View file

@ -32,7 +32,7 @@ comma separated list if needed.
**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>`_
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>`_
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.

20
docs/exam_template.rst
View file

@ -7,9 +7,9 @@ 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 defines 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 setup that all has the same or similar settings. In such a case you can create an exam template that
used by an exam import from LMS 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.
Exam templates can be created and managed just like other SEB Server documents within its list/library. The list can be filtered by name and type of the exam template
@ -37,11 +37,11 @@ SEB Server will then present you the exam template creation view on that some in
- **Name** The name of the exam template to identify it in the list/library
- **Description** A short description ideally describing the purpose of the exam template
- **Institutional Default** This flag indicated if the exam template shall become the default exam template for the institution.
- **Exam Type** Here you can set the exam type that shall be used when a exam is imported within this template
- **Configuration Template** Select a existing exam configuration template. This template will be used to automatically create and map an exam configuration for an exam that is imported with this template
- **Exam Type** Here you can set the exam type that shall be used when an exam is imported within this template
- **Configuration Template** Select an existing exam configuration template. This template will be used to automatically create and map an exam configuration for an exam that is imported with this template
- **Exam Supporter** Add a list of available exam supporter to the template. These exam supporter will then be assigned to an exam that is imported with this template
After having done all the initial settings, the exam template can be created by saving the settings. SEB server will then present you the exam template administration
After having done all the initial settings, the exam template can be created by saving the settings. SEB Server will then present you the exam template administration
view that looks similar to the exam administration view.
.. image:: images/exam_template/view.png
@ -85,7 +85,7 @@ overview as a reference.
.. note::
A Change in a template is not reflected within already existing exams that used that template on import.
But will effect all future exams that this template on import.
But it will affect all future exams that use this template on import.
Use Cases
@ -107,14 +107,14 @@ a of great help while shorten the setup process and reduces the work that must b
- Now select the previously prepared "Configuration Template" that shall be used by this template. On import of an exam with this template, SEB Server will automatically create a Exam Configuration out of this template and assign it to the imported exam.
- After all initial settings are made correctly you can save the exam template with the "Save" action on the right action pane.
- Add additional indicators to the exam template just like you do in a usual exam administration. These indicators will be copied and applied to an exam that is imported with this template.
- You can change the initial settings any-time by edit the exam template. Use the "Edit" action form the right action pain to do so.
- You can change the initial settings any-time by edit the exam template. Use the "Edit" action form the right action pane to do so.
**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 pain to import that exam from the LMS as usual.
- In the exam import initialization step you new have a new selector to select an Exam Template that shall be applied.
- Use "Import as Exam" from the right action pane to import that exam from the LMS 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.
- Now you can still change the settings the shall differ to the one from the template.

6
docs/exams.rst
View file

@ -1,8 +1,8 @@
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 binded with a LMS Setup. An exam configuration that was formerly created can be attached to the exam by
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
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
on the exam management of SEB Server.
@ -17,4 +17,4 @@ We will go through all the steps to setting up an exam for Safe Exam Browser wit
exam_indicator
exam_restriction
exam_proctoring
exam_template
exam_template

12
docs/institution.rst
View file

@ -4,7 +4,7 @@ Institution
Overview
---------
The institution section within SEB Server is used to support built-in multi-tenancy functionality to allow using SEB server as a
The institution section within SEB Server is used to support built-in multi-tenancy functionality to allow using SEB Server as a
light-weight stand-alone server but with the possibility to separate operation completely within different institutions.
.. note::
@ -12,10 +12,10 @@ light-weight stand-alone server but with the possibility to separate operation c
Only the role of SEB Server administrator and institutional administrator are able to see and use this section.
A SEB Server administrator is able to see the whole list of all existing institutions and to create new and maintain every
institution within a SEB Server, while a institutional administrator is only able to see the belonging institution and
institution within a SEB Server, while an institutional administrator is only able to see the belonging institution and
is able to modify this institution but not to change activity or create new institutions.
If a SEB server administrator clicks on the "Institution" section on the left hand menu, the application will show the a list
If a SEB Server administrator clicks on the "Institution" section on the left hand menu, the application will show the a list
of all available institutions. The list can be filtered with the filter above and can be sorted by clicking on the column one
would like to sort the list in.
@ -27,7 +27,7 @@ Currently an institution has a name, an optional url-suffix and an optional logo
- The **Name** is mandatory and must be unique within the SEB Server application.
- The **URL-Suffix** is optional and defines a suffix that can be used within the browser URL to access the SEB Server within this institution. The institution logo and theme will then be shown.
- The **Logo** upload where a image can be uploaded to be used as logo for the institution.
- The **Logo** upload where an image can be uploaded to be used as logo for the institution.
.. note:: The logo ideally should have a dimension around 300 pixel width and 80 pixel height
to fit well into the logo section of the page. Currently only .png, .jpg and .jpeg image-files are supported.
@ -100,7 +100,7 @@ access the application with a web-browser and have the own logo.
**Activate / Deactivate an existing institution**
An institution is shown to other users and ready for applying user-accounts and other entities only if it is active. An inactive
institution can only be seen by a institutional administrator of this institution or by a SEB Server administrator that are able to
institution can only be seen by an institutional administrator of this institution or by a SEB Server administrator that are able to
see all institutions.
To activate an institution for the first Time one can either use the "Activate Institution" action form the action pane on the right side
@ -112,6 +112,6 @@ When an institution is been deactivated, also all existing and active entities t
This affects user-accounts, configurations and LMS 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 a institutional role or the SEB Server administration role, will not be able to login anymore.
not an institutional role or the SEB Server administration role, will not be able to log in anymore.

46
docs/lmssetup.rst
View file

@ -36,12 +36,12 @@ If the automated SEB restriction functionality is available for a LMS depends on
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 a exam
Regardless if a supported LMS is missing the SEB integration plugin installation, the LMS can be used with the Course API and an exam
setup will be possible but without automated SEB restriction feature.
To be able connect to an LMS from SEB Server, we need to create an API access-acount 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.
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.
.. image:: images/lmssetup/new.png
@ -56,19 +56,19 @@ SEB Server internally. Use the "Type" selector to specify the type of the LMS to
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
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 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.
- **: Moodle**: This type is to bind an existing `Moodle <https://moodle.org//>`_ LMS 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
- **Moodle**: This type is to bind an existing `Moodle <https://moodle.org//>`_ LMS 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
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 the URL that is
also used with the Browser to connect to the main page of the LMS system. And additionally the credentials that has 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 te LMS. The API credentials that consists of a client-name and a client-secret must be used with the "LMS Server Username"
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.
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.
@ -76,13 +76,13 @@ If the SEB Server running behind a proxy server or a firewall between SEB Server
.. 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.
After all the settings for a LMS Setup has 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 a intial test
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
was'nt successful the SEB Server will inform the user about a possible reason of failure. Otherwise SEB Server shows a success message and the created
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.
Use the "Activate / Deactivate LMS Setup" action to activate an inactive LMS Setup or the deactivate a active LMS Setup.
Use the "Activate / Deactivate LMS Setup" action to activate an inactive LMS Setup or the deactivate an active LMS 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
@ -103,14 +103,14 @@ you have to bind the LMS to the SEB Server.
- 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 the URL that is also used with the Browser to connect to the main page of the LMS system
- 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
- 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.
.. 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
the SEB Server will notify a error dialog to the user.
the SEB Server will notify an error dialog to the user.
**Change API Credentials of an Active LMS Setup**
@ -132,11 +132,11 @@ that has to be set on the existing LMS Setup on the SEB Server.
.. 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
the SEB Server will notify a error dialog to the user.
the SEB Server will notify an error dialog to the user.
**Deactivate LMS Setup**
A LMS system that was running on your campus to provide e-assessment with SEB and SEB Server has been shout-down and you need to also deactivate
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.
- Sign into SEB Server with your institutional administrator role account.
@ -204,17 +204,17 @@ 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 the the LMS.
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.
Since SEB Server uses some functions from the Moodles 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 Moodel with an administrator account and go to "Side Administration", scroll down to "Mobile App" and choose "Mobile Settings.
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.
.. image:: images/lmssetup/moodle_mobile.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/documentation/docs/images/lmssetup/moodle_mobile.png
If you have a restrictive Moodle setup and troubles with the Moodle API account to use with SEB Server, please try to import the following
Moodle role profile within youe Moodle instance. This profile will create a SEB Server role within Moodle that can be used to apply to an
Moodle role profile within your Moodle instance. This profile will create a SEB Server role within Moodle that can be used to apply to an
API account to be used with SEB Server. The role defines only the necessary privileges and functions needed for SEB Server communication.
Moodle role and account settings: :download:`XML <files/webservice_seb-server.xml>`

28
docs/monitoring.rst
View file

@ -3,8 +3,8 @@ Exam Monitoring
A key feature of the SEB Server is the ability to overview and monitor SEB clients that are connected to the SEB Server and participate in a running exam.
It is also possible to interact with individual SEB clients that are connected and send them instructions, e.g.: to quit and reload for example.
But the main focus lies on monitoring and the SEB Server don't take automated actions but always only shows incidents as they are defined by
indicators to a exam supporter. A exam supporter then can take action.
But the main focus lies on monitoring and the SEB Server does not take automated actions but always only shows incidents as they are defined by
indicators to an exam supporter. A exam supporter then can take action.
As an exam supporter you see all running exams where you have been assigned to by an exam administrator in a list.
@ -13,7 +13,7 @@ As an exam supporter you see all running exams where you have been assigned to b
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/runningExams.png
To navigate to this list click on the "Running Exams" menu within the "Monitoring" category. And you will see the list with the name of the
exam, the type and start- and end-time of the exam. If the exam you looking for is not on the list, please check the start-time filter
exam, the type and start- and end-time of the exam. If the exam you are looking for is not on the list, please check the start-time filter
and make sure that it is set before the start-time of the exam. If not, use the filter to set the date before the exams start-date and
use the lens-symbol on the right to apply the new filter. If the exam you are looking for is still not on the list, please contact a
exam administrator of your institution to get help and check if you are correctly assigned to the exam as an exam supporter.
@ -21,7 +21,7 @@ exam administrator of your institution to get help and check if you are correctl
To monitor an exam either double-click on the list entry of the exam or select the list entry and use the "Monitoring" action form the
right action pane to navigate into the main page of exam monitoring.
On the the main page of exam monitoring you find a heat-map list of all SEB client connections that are connected to the exam since the
On the main page of exam monitoring you find a heat-map list of all SEB client connections that are connected to the exam since the
exam is running. There are state filter switches on the right action pane that allows to show/hide SEB client connection of specified states.
As default you should see at least all active connections instantly.
@ -40,7 +40,7 @@ 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
- **Missing** This state appears when a SEB connection is currently in active state but has missing ping (last ping last longer then the highest ping threshold of the ping indicator).
- **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.
@ -52,7 +52,7 @@ the cell is tinted in the color of the reached threshold also defined for each i
Since the monitoring heat-map list is automatically sorted and cannot be filtered except on connection status, there is a search feature to find a
particular connection or a set of connections. To search connection on a running exam, please use the "Search" action from the right action pane.
A search pop-pup will appear with all connection is a usual list with the possibility to filter and sort the entires.
A search pop-pup will appear with all connection is a usual list with the possibility to filter and sort the entries.
Double-click on an entry to go to the detail view of the specified SEB client connection.
.. image:: images/monitoring/search.png
@ -62,8 +62,8 @@ Double-click on an entry to go to the detail view of the specified SEB client co
**Instructions**
Instructions are actions applied to one or more SEB client connections that also can apply a signal to a active SEB Client connection to
instruct the SEB client to do a particular action on client side. In the monitoring view you can select one ore more list entries
Instructions are actions applied to one or more SEB client connections that also can apply a signal to an active SEB Client connection to
instruct the SEB client to do a particular action on client side. In the monitoring view you can select one or more list entries
with usual list (multi)selection by holding Ctrl or Shift key plus right mouse click(s). Currently there are two instructions.
- **Quit SEB Client** Sends a quit instruction to the SEB Client to quit the session. This can be applied to all active SEB client connection with the "Quit all SEB Clients" action from the right action pane or to all selected SEB client connections with the "Quit Selected SEB Clients" action.
@ -128,7 +128,7 @@ SEB Server will then open a proctoring window and join the proctor to the meetin
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/proctoringExam.png
A proctor is also able to view the names of all participants of a room by right-clicking on the specified room action.
SEB server will then open a dialog with a list of all participants. Double-clicking on a particular participant will automatically
SEB Server will then open a dialog with a list of all participants. Double-clicking on a particular participant will automatically
load the detailed monitoring view of that participant.
.. note::
@ -137,7 +137,7 @@ load the detailed monitoring view of that participant.
**Town-Hall Feature**
Beside the usual collecting room, there is a town-hall room feature. By using the "Open Townhall" action from the right action pane, SEB Server enforce all SEB clients that
Besides the usual collecting room, there is a town-hall room feature. By using the "Open Townhall" action from the right action pane, SEB Server enforce all SEB clients that
are in collecting rooms as well as new connecting SEB clients to leave their current meeting and join the town-hall meeting for as long as the town-hall is active.
Within the town-hall a proctor has the same features as in the collecting room but can connect to all participants at the same time.
When the town-hall is closed all connected SEB clients are enforced to leave the town-room and go back to its collecting room meetings again.
@ -160,9 +160,9 @@ When the single room is closed the connected SEB clients is enforced to leave th
.. note::
This feature is only available if it is enabled within the exam proctoring settings in the exam administration.
**Boradcast Features**
**Broadcast Features**
Within a live proctoring window a proctor can use the enabled features of the integrated meeting service. And is able to communicate with the SEB clients by using one
Within a live proctoring window a proctor can use the enabled features of the integrated meeting service and is able to communicate with the SEB clients by using one
of the following features if available for the service:
- **Start Audio Broadcast** Will enforce the SEB clients within the particular room to enable receive audio and a proctor can speak to the students that are in the meeting.
@ -170,7 +170,7 @@ of the following features if available for the service:
- **Enable Chat** Will enforce the SEB clients within the particular room to enable the chat feature and a proctor is able to chat with all students in the meeting.
While a broadcast feature is enabled by a proctor, the SEB Server sends an instruction to each SEB client that is within the same meeting to display the meeting client.
A Student as well as a proctor is then able to use all the features of the meeting client of the integrated meeting service.
A student as well as a proctor is then able to use all the features of the meeting client of the integrated meeting service.
.. image:: images/monitoring/proctoringWindow.png
:align: center
@ -208,7 +208,7 @@ action form the right action pane to open up a pop-up containing all related inf
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/sebClientLogDetail.png
Currently there is no export functionality to export all interessting SEB client logs to a CSV table for example. But such a feature will probably come
Currently there is no export functionality to export all interesting SEB client logs to a CSV table for example. But such a feature will probably come
with a next version of SEB Server.
**Export filtered client logs**

14
docs/overview.rst
View file

@ -10,7 +10,7 @@ Furthermore SEB Server can be setup and run within a cloud infrastructure by gen
SEB and SEB Server as a service.
SEB Server comes with a built-in multi-tenancy functionality that allows to create and maintain institutions that are separated
by each other. This is most convenient for smaller groups of organizations or institutions that want to have one self maintained
by each other. This is most convenient for smaller groups of organizations or institutions that want to have one self-maintained
SEB Server instance but need internal separation of institutions.
Since SEB Server is generally an administration tool, meaning used to do administration work and tasks to setup and maintain e-assessments,
@ -67,7 +67,7 @@ An institutional administrator has overall read access for its institution and i
create new or maintain existing user-accounts for the belonging institution. Furthermore an institutional administrator is able to create and maintain
learning management system (LMS) setups and SEB connection-configurations for the belonging institution.
A typical use-case for a institutional administrator would be to give the appropriate roles and privileges to newly registered users of the institution.
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 setup and maintain learning management systems
within the SEB Server and the belonging institution.
@ -91,18 +91,18 @@ This role is to support a running exam within SEB Server. An exam supporter is a
an assignment and can open them either for monitoring or editing some exam attributes during the exam.
A typical use-case for an exam supporter would be when the time an exam is running, to overview the connecting SEB clients and manage them.
While SEB server shows incidences or irregularities, a exam supporter can act on them and take the appropriate actions if needed.
While SEB Server shows incidences or irregularities, an exam supporter can act on them and take the appropriate actions if needed.
Sign Up / Sign In
-----------------
What one will see first when applying to a SEB server application is the login-screen
What one will see first when applying to a SEB Server application is the login-screen
.. image:: images/overview/login.png
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/overview/login.png
If you are already registered you can use your username and password to log in. Or use the "Register" button to go the the register
If you are already registered you can use your username and password to log in. Or use the "Register" button to go the register
page to create a new user-account. The newly created user account will only have the Exam Supporter role assigned. If you need another
role or more privileges, this must be given and granted by an institutional administrator of the belonging institution.
@ -186,8 +186,8 @@ field label or the input section.
If a form field is mandatory to either create or save an entity, this is marked with a little red arrow just to the right of the form field label.
There may also be more field validation takes place on saving the object. If a input needs a special form that is not given by the current input, the form-field
will be marked with a red border around the input field and a thin red explanation text is shown right below the input field.
After correcting the missing or wrong input and saveing the form again, the SEB Server will accept and process the changes.
After correcting the missing or wrong input and saving the form again, the SEB Server will accept and process the changes.
.. note::
If you navigate away from a form in edit mode, the GUI will inform you about possible data loss on this action and will prompt you to
proceed or abort the action.
proceed or abort the action.

2
docs/troubleshooting.rst
View file

@ -1,7 +1,7 @@
Troubleshooting
===============
This page's purpose is to collect frequently ask questions, problems and workarounds that are reported and known.
This page's purpose is to collect frequently asked questions, problems and workarounds that are reported and known.
There shall be at least a problem description, an optional explanation if needed, a solution description and the SEB Server version and domain information. For Example:
Please also have a look at `Open Issues <https://https://github.com/SafeExamBrowser/seb-server/issues>`_ and/or `Ongoing Discussions <https://github.com/SafeExamBrowser/seb-server/discussions>`_ on the Git-Hub page.

30
docs/useraccount.rst
View file

@ -47,18 +47,18 @@ of all institution within a SEB Server instance. The filter above the list can b
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/account/list_serveradmin.png
To view all information of a user-account, double-click in a certain user-account entry from the list or select an entry from the list and
use the "View User Account" action on the right action pain. The user account form will be shown in read only mode with all account information.
use the "View User Account" action on the right action pane. The user account form will be shown in read only mode with all account information.
To edit this user-account use the "Edit User Account" action on the right action pane. To change the password of the user
Use Cases
---------
**Register as a exam supporter**
**Register as an exam supporter**
Registering as a new user is possible only within the SEB Server form-registration yet. Since the SEB Server is mainly a service for administrative work,
there is no third party registration and login in place so far. A self-registered user-account has the single role of an
Exam Supporter and since this user-account is not applied to an exiting exam and running, the user is only able to see and edit its own account settings.
Exam Supporter and since this user-account is not applied to an existing exam and running, the user is only able to see and edit its own account settings.
Another user with Exam Administrator role can then assign the new user-account to an exam for support and monitoring. Or one other user-account with
Institution Administrator role can edit the new user-account and give it more privileges.
@ -76,7 +76,7 @@ To register a new user-account follow the steps below
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/overview/register.png
Once signed in, the user can see all sections for a Exam Administrator as shown in the image below. Because the user is not assigned to any
Once signed in, the user can see all sections for an Exam Administrator as shown in the image below. Because the user is not assigned to any
Exam as a supporter yet, the "Exam Administration" and "Monitoring" sections are empty. The user is only able to change the account settings.
.. image:: images/account/registered.png
@ -86,10 +86,10 @@ Exam as a supporter yet, the "Exam Administration" and "Monitoring" sections are
**Create new user-account**
As a user with user-account write privileges (SEB Server administrator and institutional administrator) one can create new user-account for
others. This must usually be done if a particular user is not able to register itself for whatever reason or if internal policies prefere
this kind of registration. A a user with with user-account write privileges you can create a new user-account as follows;
others. This must usually be done if a particular user is not able to register itself for whatever reason or if internal policies prefer
this kind of registration. A user with user-account write privileges you can create a new user-account as follows;
- Login to SEB Server application with your own account an click the "User Account" section on the left side menu.
- Login to SEB Server application with your own account and click the "User Account" section on the left side menu.
- Use the "Add User Account" action from the action pane on the right hand-side to create a new user-account.
- Enter all mandatory account data within the form and use the "Register" action to confirm.
- If there is missing or wrong data, the registration form will highlight the concerned input fields with a red border and information text just below the field.
@ -101,10 +101,10 @@ this kind of registration. A a user with with user-account write privileges you
As a user with user-account write privileges (SEB Server administrator and institutional administrator) one can modify user-accounts of others
while all other users can only modify its own account settings.
- Login to SEB Server application with your own account an click the "User Account" section on the left side menu.
- Login to SEB Server application with your own account and click the "User Account" section on the left side menu.
- As a user with user-account write privileges one will see the list of all available user-accounts. Find the user-account that must be modified by using the filter above and double-click on the respective list entry to open the user-account form in view mode
- Without user-account write privileges, a user will just see its own user-account form in view mode.
- Use the "Edit User Account" action from the action pain on the right to change to edit mode. Apply all needed modifications and save the user-account by using the "Save User Account" action from the action pane.
- Use the "Edit User Account" action from the action pane on the right to change to edit mode. Apply all needed modifications and save the user-account by using the "Save User Account" action from the action pane.
- If there is missing or wrong data, the registration form will highlight the concerned input fields with a red border and information text just below the field.
- If everything is accepted the user-account is created and the application shows the user-account form in view mode.
@ -113,12 +113,12 @@ while all other users can only modify its own account settings.
As a user with user-account write privileges (SEB Server administrator and institutional administrator) one can change the password also for others
while all other users can only modify change its own password. The current password must be known to change the password.
- Login to SEB Server application with your own account an click the "User Account" section on the left side menu.
- Login to SEB Server application with your own account and click the "User Account" section on the left side menu.
- As a user with user-account write privileges will see the list of all available user-accounts. Find the user-account that must be modified
by using the filter above and double-click on the respective list entry to open the user-account form in view mode
- Without user-account write privileges, a user will just see its own user-account form in view mode.
- Use the "Change Password" action on the right action pane to open the change password form.
- No you must fist give the correct old password and the new password then with confirmation.
- No you must first give the correct old password and the new password then with confirmation.
- Use the "Save New Password action form the right action pane to save the new password settings.
- If you are changing your own password and everything is correct, the application will automatically log you out and prompt you to sign in with the new password.
- If you are changing the password of another user-account the application and everything is correct, the application direct you back to the user-account form in view mode and show a confirmation message.
@ -133,9 +133,9 @@ Users with user-account write privileges (SEB Server administrator and instituti
user-accounts of others. A inactive user-account prevent a user to sign-in. There are several different ways or places where the status
of a user-account can be changed
- On the list view while one list entry is selected, by using the "Activate User Account" or "Deactivate User Account" action from the action pain at the right side. There will be automatically appear the proper action in relation to the selected list entry and whether it is already active or inactive.
- In the user-account form in view mode by using the "Activate User Account" or "Deactivate User Account" action from the action pain at the right side. There will be automatically appear the proper action in relation to the current user-account.
- If one creates a new user-account there is the possibility to create and activate the user-account by using the "Activate User Account" action from the action pain on the right side.
- On the list view while one list entry is selected, by using the "Activate User Account" or "Deactivate User Account" action from the action pane at the right side. There will be automatically appear the proper action in relation to the selected list entry and whether it is already active or inactive.
- In the user-account form in view mode by using the "Activate User Account" or "Deactivate User Account" action from the action pane at the right side. There will be automatically appear the proper action in relation to the current user-account.
- If one creates a new user-account there is the possibility to create and activate the user-account by using the "Activate User Account" action from the action pane on the right side.
- The same situation appears for inactive user-accounts in edit mode.
**Delete a user-account**
@ -150,7 +150,7 @@ A user account can be deleted with all dependencies that belongs to the user-acc
- All exam configuration the user has created and is owner of
- All exams the user has created and is owner of and all dependencies of an exam to like indicators, configuration mappings and all monitoring data if present
- Login to SEB Server application with your own account an click the "User Account" section on the left side menu.
- Login to SEB Server application with your own account and click the "User Account" section on the left side menu.
- As a user with user-account write privileges will see the list of all available user-accounts. Find the user-account that must be deleted
by using the filter above and double-click on the respective list entry to open the user-account form in view mode.
- Use the "Delete User Account" action from the right action pane to open the deletion dialog.

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

@ -107,8 +107,8 @@ sebserver.form.confirm.label=confirm {0}
sebserver.form.tablefilter.label={0} table-column filter
sebserver.table.column.sort.default.tooltip=Click on the column header to sort the table within this column
sebserver.dialog.confirm.deactivation=Note that there are {0} other entities that belong to this entity.<br/>Those will also be deactivated by deactivating this entity.<br/><br/>Are You sure to deactivate this entity?
sebserver.dialog.confirm.deactivation.noDependencies=Are You sure you want to deactivate?
sebserver.dialog.confirm.deactivation=Note that there are {0} other entities that belong to this entity.<br/>Those will also be deactivated by deactivating this entity.<br/><br/>Are you sure to deactivate this entity?
sebserver.dialog.confirm.deactivation.noDependencies=Are you sure you want to deactivate?
sebserver.error.action.unexpected.message=Failed to process action. There was an unexpected error.<br/> Please try again or contact a system administrator if this error persists
sebserver.error.get.entity=Failed to load {0}.<br/> Please try again or contact a system administrator if this error persists