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

docu fixes

Browse source
This commit is contained in:
anhefti 2020-05-20 14:03:35 +02:00
parent 905cde08b8
commit f2b298e052
10 changed files with 90 additions and 144 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/client_config.rst
View file

@ -107,12 +107,8 @@ strategy where SEB clients uses the a given start URL in fallback case.
- Give a password to ensure security and to encrypt the client configuration on export. A SEB client will prompt for the password while loading this configuration.
- Check "With Fallback" to show all the fallback related attributes.
- Define a fallback URL that will be used by a SEB client as start URL in the fallback case.
- Define also fallback case, how many connection attempts on what interval a SEB client shall try before going into fallback mode.
You can also define a overall "Connection Timeout" if lapsed a SEB client will also go into the fallback mode.
A SEB client will fall-back on either the attempt or the timeout trigger.
- When a SEB client goes to fallback mode it will prompt the user as described in the case list above. To prevent further fallback options
with a password prompt, give a "Fallback Password" and / or a "Quit Password" that a SEB client will prompt on either the fallback- or the
quit-option.
- Define also fallback case, how many connection attempts on what interval a SEB client shall try before going into fallback mode. You can also define a overall "Connection Timeout" if lapsed a SEB client will also go into the fallback mode. A SEB client will fall-back on either the attempt or the timeout trigger.
- When a SEB client goes to fallback mode it will prompt the user as described in the case list above. To prevent further fallback options with a password prompt, give a "Fallback Password" and / or a "Quit Password" that a SEB client will prompt on either the fallback- or the quit-option.
- After all details are correctly been entered, use the "Save Client Configuration" action on the right action pane to save the new client configuration.
- Now the new client configuration is created but not active for now and therefore cannot be exported yet.
@ -123,11 +119,9 @@ Now we want to activate this client configuration and export it to make it acces
- Sign in as an Institutional Administrator and select the "Client Configuration" sub-menu of the "SEB Configuration" main-menu on the left.
- Use the list filter and / or the list navigation to find the needed client configuration.
- Double-click on the list entry or use the "View Client Configuration" action on the right for a selected list row, to show the details of a
specific Client configuration.
- Double-click on the list entry or use the "View Client Configuration" action on the right for a selected list row, to show the details of a specific Client configuration.
- Then either on the list or in the view mode of the form, use the "Activate Client Configuration" action on the right action pane to activate the client configuration
- Now there is a "Export Client Configuration" action in the detail view of the client configuration. Use the "Export Client Configuration" action
to start a download dialog. Choose "Save As" and download the file with the name "SEBServerSettings.seb".
- Now there is a "Export Client Configuration" action in the detail view of the client configuration. Use the "Export Client Configuration" action to start a download dialog. Choose "Save As" and download the file with the name "SEBServerSettings.seb".
- This file can now be published as download-link within a public server where SEB user can click and start the download and startup of the SEB client automatically.
**Deactivate a Client Configuration**

28
docs/exam.rst
View file

@ -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
- **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
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
@ -136,8 +136,7 @@ Therefore you have to remove Eric from the exams supporter list while also addin
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- Use the "Edit Exam" action form the right action pane to go into the exam edit page.
- Find Eric's user account on the list of selected exam supporter and use the minus sign icon on the entry to remove Eric from the list of exam supporter
- Click into the input field of the exam supporter selector and start typing the name of Anie's account. The drop down will present you all matching entries.
select Anie's account to add it to the list of selected exam supporter.
- Click into the input field of the exam supporter selector and start typing the name of Anie's account. The drop down will present you all matching entries. Select Anie's account to add it to the list of selected exam supporter.
- Use the "Save Exam" action on the right action pane to save and confirm the task. This will lead you also back to the exam details page.
- Check again if all exam supporter are correctly assigned for the exam.
@ -158,16 +157,9 @@ your institution use the type information of the exam to set them into context.
- Login as an exam administrator and go to the "Exam" page under the "Exam Administration" section.
- Use the filter to find the exam on that you have to change the supporter assignments.
- Double click the list entry of the exam to go to the exam details page. Check if you are on the right exam.
- If the exam has already one exam configuration attached you have first to delete this attachment before being able to attach another exam configuration.
Use the "Delete Configuration" action from the right action pane to remove the attached exam configuration.
- If the exam has already one exam configuration attached you have first to delete this attachment before being able to attach another exam configuration. Use the "Delete Configuration" action from the right action pane to remove the attached exam configuration.
- Use the "Add Exam Configuration" action form the right action pane to open up the attachment dialog.
- If there is currently no exam configuration that can be attached to the exam, an information dialog will be shown instead of the attachment dialog.
- On the attachment dialog use the drop down selection to select the exam configuration you want to apply to the exam.
The drop down selection shows the names of the available exam configurations and you can filter this names by start typing the name of the exam configuration you
want to find in the input field of the selection.
- On the attachment dialog use the drop down selection to select the exam configuration you want to apply to the exam. The drop down selection shows the names of the available exam configurations and you can filter this names by start typing the name of the exam configuration you want to find in the input field of the selection.
- When you have selected a exam configuration the dialog shows you some additional information about the exam configuration.
- If you want or need to put an password protected encryption to the exam configuration for this exam you can do so by give the password for the encryption also within the attachment dialog.
Be aware that every SEB client that will receive an encrypted exam configuration from the SEB Server will prompt the user to give the correct password. In most cases an
encryption of the exam configuration is not needed, because a secure HTTPS connection form SEB client to SEB Server is already in place.
- If you want or need to put an password protected encryption to the exam configuration for this exam you can do so by give the password for the encryption also within the attachment dialog. Be aware that every SEB client that will receive an encrypted exam configuration from the SEB Server will prompt the user to give the correct password. In most cases an encryption of the exam configuration is not needed, because a secure HTTPS connection form SEB client to SEB Server is already in place.

43
docs/exam_config.rst
View file

@ -191,13 +191,14 @@ on the LMS is propagated automatically to a LMS by the SEB Server with the autom
There is an already fully configured exam within SEB Server that is currently running with a prepared exam configuration. You have now realized that
some SEB settings are missing or wrong and has to be changed for the exam. This is possible but under some restrictions. See the note below.
.. note:: When a exam configuration is applied to a currently running exam, the exam configuration is in "Used" state and the SEB settings of the exam configuration
are in read only mode. Changing the SEB settings of a exam configuration during a running exam that has already connected clients can lead to unexpected
behavior. SEB clients that has already been connected and are in a running session will work with the old configuration while SEB clients that are connecting
after a SEB settings change will work with the new configuration. Also the automated SEB restriction with the changed `SEB Config-Key <https://safeexambrowser.org/developer/seb-config-key.html>`_
will be updated immediately after saving / publishing the configuration changes. This may also lead to unexpected behavior and eventually blocking of already connected SEB clients.
Therefore SEB Server restricts the change of SEB settings for configurations that are attached to an exam that is currently running to be only possible if there are no
active SEB client connections for this exam at the moment when save / publish the SEB setting changes.
.. note::
When a exam configuration is applied to a currently running exam, the exam configuration is in "Used" state and the SEB settings of the exam configuration
are in read only mode. Changing the SEB settings of a exam configuration during a running exam that has already connected clients can lead to unexpected
behavior. SEB clients that has already been connected and are in a running session will work with the old configuration while SEB clients that are connecting
after a SEB settings change will work with the new configuration. Also the automated SEB restriction with the changed `SEB Config-Key <https://safeexambrowser.org/developer/seb-config-key.html>`_
will be updated immediately after saving / publishing the configuration changes. This may also lead to unexpected behavior and eventually blocking of already connected SEB clients.
Therefore SEB Server restricts the change of SEB settings for configurations that are attached to an exam that is currently running to be only possible if there are no
active SEB client connections for this exam at the moment when save / publish the SEB setting changes.
- Sign into SEB Server with your exam administrator role account
- To change the SEB Settings of an exam configuration that is attached to an currently running exam, make sure that there are no active SEB client connections.
@ -208,13 +209,10 @@ active SEB client connections for this exam at the moment when save / publish th
- Open the exam configuration either by double-click on the list entry or be selecting the list entry and using the "View Exam Configuration" action.
- See that you currently are not able to edit the SEB settings. There is only a "View SEB Settings" action that opens the SEB settings in read-only mode.
- Use the "Edit Exam Configuration" action from the right action pane to open the edit mode of the exam configuration.
- Change the status from "Used" to "Under Construction" to be able to edit the SEB settings again. There will be a message that tells you the implication with
changing SEB settings within a exam configuration that is already used by a running exam.
- Change the status from "Used" to "Under Construction" to be able to edit the SEB settings again. There will be a message that tells you the implication with changing SEB settings within a exam configuration that is already used by a running exam.
- After saving the exam configuration in "Under Construction" it is now possible to edit the SEB settings for this exam configuration.
- Use the "Edit SEB Settings" action from the right action pane to open the SEB settings form in the edit mode.
- Apply your changes to the settings and use "Save / Publish Settings" to make the settings take affect and trigger a configuration change to the exam.
This will check first if there are currently no active SEB clients connected within the running exam that uses this exam configuration.
If there is one or more active SEB client connected, the action will deny and inform you about the the active SEB clients.
- Apply your changes to the settings and use "Save / Publish Settings" to make the settings take affect and trigger a configuration change to the exam. This will check first if there are currently no active SEB clients connected within the running exam that uses this exam configuration. If there is one or more active SEB client connected, the action will deny and inform you about the the active SEB clients.
.. _setting-dif-label:
@ -227,20 +225,21 @@ available on the SEB Server.
**SEB settings currently not supported by the SEB Server**
- Start URL: Since SEB Server has already been contacted by a SEB client when downloading the exam configuration this is not used by the exam configuration on SEB Server. But this can be used as fallback URL in the Client Configuration.
- Embedded Resource: There is currently no embedding supported within exam configurations on SEB Server.
- 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.
- Start URL: Since SEB Server has already been contacted by a SEB client when downloading the exam configuration this is not used by the exam configuration on SEB Server. But this can be used as fallback URL in the Client Configuration.
- Embedded Resource: There is currently no embedding supported within exam configurations on SEB Server.
- 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.
**SEB settings that has a slightly different form or handling in SEB Server comparing to the SEB configuration tool**
- Download Directory OSX: Since it is not possible within a web-service to choose a local directory on a remote device this is just a text input where one has to give the full-path to the directory on the client device in text form.
- Log Directory OSX, Log Directory Win: Since it is not possible within a web-service to choose a local directory on a remote device this is just a text input where one has to give the full-path to the directory on the client device in text form.
- Permitted Processes / Executable: This is also just a text input field where one can give the name of the process in text form.
- Download Directory OSX: Since it is not possible within a web-service to choose a local directory on a remote device this is just a text input where one has to give the full-path to the directory on the client device in text form.
- Log Directory OSX, Log Directory Win: Since it is not possible within a web-service to choose a local directory on a remote device this is just a text input where one has to give the full-path to the directory on the client device in text form.
- Permitted Processes / Executable: This is also just a text input field where one can give the name of the process in text form.
**SEB settings from versions before 3.0 that are not supported anymore**
- Permitted Processes / Window Handling Process
- Permitted Processes / Window Handling Process

18
docs/exam_import.rst
View file

@ -36,14 +36,15 @@ This means, that the course data has to be modified on the LMS side as usual and
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
and are able to initially choose a type for the exam - "Exam Type" - that is currently only used
- **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
You are now able to initially choose a type for the exam - "Exam Type" - that is currently only used
for informational purpose and has no further restrictions or consequences on handling on in SEB Server.
.. image:: images/exam/lmsExamLookup.png
@ -80,8 +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.

13
docs/exam_indicator.rst
View file

@ -9,14 +9,13 @@ add some other indicators to the exam to be able to get notified while monitorin
The type of indicators are pre-defined within the SEB Server and restricts the number of available indicators that can be used. Currently following
indicators are supported:
- Last Ping Time: This indicator measures the time that has passed since the last ping from a specified SEB client was received by the SEB Server in milliseconds.
- **Last Ping Time**: This indicator measures the time that has passed since the last ping from a specified SEB client was received by the SEB Server in milliseconds.
This can be used to monitor constant SEB client connections and get notified when a SEB client connection gets lost for some defined
time or when a SEB client connection that has been list is back again.
This indicator is used as default indicator and automatically applied to the exam on import. You are able to modify this indicator
and also delete it but we recommend to have this basic indicator in place for every exam.
- Errors: This indicator measures the number of error-logs a specified SEB client is sending to the SEB Server.
- Warnings: This indicator measures the number of warning-logs a specified SEB client is sending to the SEB Server.
and also delete it but we recommend to have this basic indicator in place for every exam.
- **Errors**: This indicator measures the number of error-logs a specified SEB client is sending to the SEB Server.
- **Warnings**: This indicator measures the number of warning-logs a specified SEB client is sending to the SEB Server.
You can define thresholds for each indicator. A threshold is defined by an indication-color and by a threshold-value. On the monitoring side, the
indicator for each SEB client connection with change to the threshold color when the measured indicator value has reached the threshold-value.
@ -62,9 +61,7 @@ Use Cases
- Set a name for the indicator and choose the type of indicator you want to use. Read the description above to learn more about indicators and supported types of indicators.
- You can also define a default color for the indicator that is displayed on the monitoring page while the exam is running and a particular SEB client has no incidence as defined for this indicator.
- To select a color use the brush-palette icon on the right side of the color input field to open up a color chooser dialog.
- Now you can define some threshold for the indicator that will help you find incidents and get informed about on the monitoring while the exam is running.
To do so you can use the plus icon on the threshold list to add a new empty threshold to the list. You can choose a value for the threshold and a color
that would indicate an overflow of the given value from the measured value of the indicator.
- Now you can define some threshold for the indicator that will help you find incidents and get informed about on the monitoring while the exam is running. To do so you can use the plus icon on the threshold list to add a new empty threshold to the list. You can choose a value for the threshold and a color that would indicate an overflow of the given value from the measured value of the indicator.
- To remove a already defined threshold from the list of threshold, use the minus icon on the right side of the particular threshold.
- When everything is set up properly use the "Save Indicator" action to save the indicator and go back to the exam details page.
- Back in the exam details page, you can check if your indicator is in the list and all thresholds are correctly set by going down to the indicators list of the exam.

34
docs/institution.rst
View file

@ -25,10 +25,9 @@ would like to sort the list in.
Currently an institution has a name, an optional url-suffix and an optional logo upload attribute.
- 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 **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.
.. 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.
@ -64,14 +63,9 @@ access the application with a web-browser and have the own logo.
- A list of all existing and available institutions will be shown.
- Select "Add Institution" form the right hand side action pane to create a new institution.
- The creation form will be shown and the user is able to define a name, url-suffix and or upload a logo for the new institution.
- After giving all information, the new institution can either be saved and remains inactive until activation or can be saved and
automatically be activated within the same step. Use the "Save Institution" action on the right side to just save the institution
or the "Activate Institution" action the save and activate within the same step.
- In either case the form input will first be verified and if there is missing something or has wrong input, the save action will
be postponed and the edit form will present the missing input within a red box and some inform text right below the input field
for correction.
- If successfully saved, the application will show the form of the newly created institution in read only mode and if already activated
other user, that are allowed to, can see the institution now.
- After giving all information, the new institution can either be saved and remains inactive until activation or can be saved and automatically be activated within the same step. Use the "Save Institution" action on the right side to just save the institution or the "Activate Institution" action the save and activate within the same step.
- In either case the form input will first be verified and if there is missing something or has wrong input, the save action will be postponed and the edit form will present the missing input within a red box and some inform text right below the input field for correction.
- If successfully saved, the application will show the form of the newly created institution in read only mode and if already activated other user, that are allowed to, can see the institution now.
.. image:: images/institution/new.png
:align: center
@ -87,22 +81,16 @@ access the application with a web-browser and have the own logo.
- Login as a SEB Server administrator and select the "Institution" menu-item from the left hand side menu.
- A list of all existing and available institutions will be shown. Use the filter above to find the institution to change.
- Select the institution and use the "Edit Institution" action on the right side action pane to open the institution in edit mode.
- To upload a new logo, click on the upload-icon just beside the logo input field. The application will show a file-picker dialog.
Use the file-picker dialog to search and select the logo file. Use the "Upload" action-button to upload the selected file. The
selected logo should appear as an image within the image upload input field of the institution form.
- Apply the changes and save the institution. If all given information is correct and nothing is missing, the application will.
show the changed institution form in read only mode.
- To upload a new logo, click on the upload-icon just beside the logo input field. The application will show a file-picker dialog. Use the file-picker dialog to search and select the logo file. Use the "Upload" action-button to upload the selected file. The selected logo should appear as an image within the image upload input field of the institution form.
- Apply the changes and save the institution. If all given information is correct and nothing is missing, the application will. show the changed institution form in read only mode.
*As an institutional administrator*
- Login as an institutional administrator and select the "Institution" menu-item from the left hand side menu.
- The form of the own institution is shown in read-only mode. Use the "Edit Institution" action from the action pane.
- The form of the own institution is now shown in the edit mode and the name or logo of the institution can be modified.
- To upload a new logo, click on the upload-icon just beside the logo input field. The application will show a file-picker dialog.
Use the file-picker dialog to search and select the logo file. Use the "Upload" action-button to upload the selected file. The
selected logo should appear as an image within the image upload input field of the institution form.
- Apply the changes and save the institution. If all given information is correct and nothing is missing, the application will.
show the changed institution form in read only mode.
- To upload a new logo, click on the upload-icon just beside the logo input field. The application will show a file-picker dialog. Use the file-picker dialog to search and select the logo file. Use the "Upload" action-button to upload the selected file. The selected logo should appear as an image within the image upload input field of the institution form.
- Apply the changes and save the institution. If all given information is correct and nothing is missing, the application will show the changed institution form in read only mode.
.. image:: images/institution/view_institutional.png
:align: center
@ -123,7 +111,7 @@ To deactivate an institution one can use the "Deactivate Institution" action for
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
and will inform the administrator about the number of the affected entities and asks for confirmation.
After Confirm the deactivation the insitution and all affected entities will be deactivated. This means also the user-accounts that has
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.

8
docs/lmssetup.rst
View file

@ -50,14 +50,14 @@ A SEB Server administrator role will be able to see the institution to which the
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:
- 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
- **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 configuraed
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 described API's of the Open edX system and if the automated SEB restriction feature wanted to be used the
:ref:`lms-setup-edx-plugin-label` must be installed properly within 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
- **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.
@ -134,7 +134,7 @@ that has to be set on the existing LMS Setup on the SEB Server.
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
the setup and exams on the SEB Server for this LMS.
Sign into SEB Server with your institutional administrator role account.
- 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.

12
docs/monitoring.rst
View file

@ -32,8 +32,7 @@ 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** 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).
- **IP Address** The IP address of the device the connected SEB client is running.
- **Status** The status of the SEB client connection.
@ -47,13 +46,8 @@ Instructions are actions applied to one or more SEB client connections that also
instruct the SEB client to do a particular action on client side. In the monitoring view you can select one ore 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.
- **Mark As Canceled** Can be applied to all inactive SEB client connections to enforce the inactive SEB client connection to "Canceled" state.
This can be used to mark and remove inactive SEB client connection you don't want to have on the main monitoring board anymore when the filter
for canceled SEB client connections is set to hide.
- **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.
- **Mark As Canceled** Can be applied to all inactive SEB client connections to enforce the inactive SEB client connection to "Canceled" state. This can be used to mark and remove inactive SEB client connection you don't want to have on the main monitoring board anymore when the filter for canceled SEB client connections is set to hide.
**Filter**

14
docs/overview.rst
View file

@ -24,23 +24,13 @@ please go to `SEB Server Installation Guide <https://seb-server-setup.readthedoc
The key features of SEB Server are:
- Built-in multi-tenancy capabilities. Create and manage institutions as separated clients.
- Lightweight user-account management where users can register itself and get needed privileges assigned by already registered
administrator users that has the privileges to maintain user accounts.
- Lightweight user-account management where users can register itself and get needed privileges assigned by already registered administrator users that has the privileges to maintain user accounts.
- Track user activities within user-activity-logs for the whole SEB Server or the a client.
- Create, export and maintain SEB client configurations. Those are needed to startup a Safe Exam Browser client with and contain all information
to connect securely to the SEB Server.
- Create, export and maintain SEB client configurations. Those are needed to startup a Safe Exam Browser client with and contain all information to connect securely to the SEB Server.
- Create and maintain SEB exam configurations. Those are sent to a SEB client on connection setup and contain all SEB settings for a particular e-assessment.
- Setup and maintain Learning Management Systems (LMS) like Open edX or Moodle to be able to navigate and find courses or quizzes on the LMS and to push access-restrictions to the LMS if supported by the LMS
- Import and maintain courses or quizzes form a LMS. Setup everything that is needed for an e-assessment that is based on a course or quiz form the LMS
- Apply indicators to the exams to indicate incidences while monitoring running e-assessments.
- Monitor running e-assessment and have an overview of all connected SEB clients. Manage SEB client connections and view logs sent by individual SEB clients.

50
docs/useraccount.rst
View file

@ -12,16 +12,15 @@ user account and changing the password. This section differs most for the differ
A user account always belongs to one institution and has some basic attributes;
- Institution: A combo- or single-selection to choose the institution the user account belongs to. This is mandatory
and one user-account can only belong to one institution.
- First Name: The first name of the user
- Surname: The surname of the user
- Username: The username within SEB Server. This name is used to login.
- E-Mail: The E-Mail address for the user. This currently has only informational purpose and is neither used to confirm an account or to send automated mails.
- Time Zone: The time zone the user belongs to and to which the dates and times are converted to for display it to the user in the GUI. See also the note about time zone below.
- User Roles: A multi-selection input to define all roles a user account has. See also the note about roles below.
- Password: This password input field appears only while creating a new user-account or while self-register a user-account.
- Confirm Password: This password input field appears only while creating a new user-account or while self-register a user-account.
- **Institution**: A combo- or single-selection to choose the institution the user account belongs to. This is mandatory and one user-account can only belong to one institution.
- **First Name**: The first name of the user
- **Surname**: The surname of the user
- **Username**: The username within SEB Server. This name is used to login.
- **E-Mail**: The E-Mail address for the user. This currently has only informational purpose and is neither used to confirm an account or to send automated mails.
- **Time Zone**: The time zone the user belongs to and to which the dates and times are converted to for display it to the user in the GUI. See also the note about time zone below.
- **User Roles**: A multi-selection input to define all roles a user account has. See also the note about roles below.
- **Password**: This password input field appears only while creating a new user-account or while self-register a user-account.
- **Confirm Password**: This password input field appears only while creating a new user-account or while self-register a user-account.
.. note::
The date and time values within the SEB Server are always stored in universal time (UTC) and converted
@ -36,12 +35,12 @@ A user account always belongs to one institution and has some basic attributes;
By selecting the "User Account" section on the left side menu, a SEB Server administrator will see a list of all user-accounts
of all institution within a SEB Server instance. The filter above the list can be used to search a certain user account. Use the:
- "Institution" filter to select a certain institution and show only the user-accounts that belongs to this institution.
- "First Name" filter to search for user-accounts with the given occurrence of text in the First Name.
- "Surname" filter to search for user-accounts with the given occurrence of text in the Surname.
- "User Name" filter to search for user-accounts with the given occurrence of text in the Username.
- "Mail" filter to find an user-account by e-mail address
- "Status" filter to select the either and see either only active, only inactive or all user-accounts
- **Institution** filter to select a certain institution and show only the user-accounts that belongs to this institution.
- **First Name** filter to search for user-accounts with the given occurrence of text in the First Name.
- **Surname** filter to search for user-accounts with the given occurrence of text in the Surname.
- **User Name** filter to search for user-accounts with the given occurrence of text in the Username.
- **Mail** filter to find an user-account by e-mail address
- **Status** filter to select the either and see either only active, only inactive or all user-accounts
.. image:: images/account/list_serveradmin.png
:align: center
@ -103,11 +102,9 @@ As a user with user-account write privileges (SEB Server administrator and insti
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.
- 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
- 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 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.
- 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.
@ -124,8 +121,7 @@ while all other users can only modify change its own password. The current passw
- No you must fist 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.
- 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.
.. image:: images/account/change_password.png
:align: center
@ -137,12 +133,8 @@ 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 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.
- The same situation appears for inactive user-accounts in edit mode.