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 2021-03-31 12:21:08 +02:00
parent da783354a0
commit ee02140839
7 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/configurations.rst
View file

@ -23,6 +23,6 @@ This feature is currently in an experimental state and may be changed and / or e
.. toctree::
:maxdepth: 1
client_config
connection_config
exam_config
config_template

2
docs/connection_config.rst
View file

@ -1,4 +1,4 @@
.. _client-configuration-label:
.. _connection-configuration-label:
Connection Configuration
====================

6
docs/exam.rst
View file

@ -114,14 +114,14 @@ Other Features
Currently there are three other features that can be managed within the exam administration.
- **:ref:`exam-indicators-label`** : Define indicators to measure values for each connected SEB client when an exam is running. And
- :ref:`exam-indicators-label` Define indicators to measure values for each connected SEB client when an exam is running. And
define thresholds for the indicators to show incidences.
- **:ref:`seb_restriction-label`** : If this feature is supported within the underling LMS of the exam, you are able to automatically
- :ref:`seb_restriction-label` If this feature is supported within the underling LMS of the exam, you are able to automatically
restrict the course or quiz on the LMS for SEB only access and may also be able to set the conditions and attributes for the restriction
as defined by the LMS.
- **:ref:`seb_proctoringSettings-label`** : If the proctoring feature is available you are able to set and connect
- :ref:`seb_proctoringSettings-label` If the proctoring feature is available you are able to set and connect
to a proctoring service and setup proctoring for an specified exam that can be used during the examination within the monitoring.

2
docs/exam_config.rst
View file

@ -225,7 +225,7 @@ In the current version of SEB Server, there are some differences to some SEB set
**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.
- 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 Connection 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.

6
docs/lmssetup.rst
View file

@ -21,7 +21,8 @@ Usually this API comes as a REST or SOAP API with the core LMS implementation or
SEB Server supports this course API's so far:
- Open edX: The standard system `Open edX REST API <https://courses.edx.org/api-docs/>`_. The SEB Server uses the "courses" endpoints to get course data.
- Moodle (Course Access): The standard system `Moodle REST API <https://docs.moodle.org/dev/Web_service_API_functions>`_. The SEB Server uses the "core_course" endpoints to get course data. Note that a second Moodle integration part for SEB access restriction with Config-Key will follow together with a Moodle plugin in a future version of SEB Server
- Moodle (Course Access): The standard system `Moodle REST API <https://docs.moodle.org/dev/Web_service_API_functions>`_. The SEB Server uses the standard Moodle rest endpoints to get course data.
Please note that a second Moodle integration part for SEB access restriction with Config-Key will follow together with a Moodle plugin in a future version of SEB Server
**SEB restriction API**
@ -63,8 +64,7 @@ SEB Server internally. Use the "Type" selector to specify the type of the LMS to
- **: 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 binding is experimental in the current SEB Server version and there is no guarantee to work correctly or to work
with an upcoming full Moodle integration in newer version.
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

6
docs/overview.rst
View file

@ -26,7 +26,7 @@ The key features of SEB Server are:
- Built-in multi-tenancy capabilities. Create and manage institutions as separated clients.
- Lightweight user-account management where users can register itself and get needed privileges assigned by already registered administrator users that has the privileges to maintain user accounts.
- Track user activities within user-activity-logs for the whole SEB Server or the a client.
- Create, export and maintain SEB client configurations. Those are needed to startup a Safe Exam Browser client with and contain all information to connect securely to the SEB Server.
- Create, export and maintain SEB connection configurations. Those are needed to startup a Safe Exam Browser client with and contain all information to connect securely to the SEB Server.
- Create and maintain SEB exam configurations. Those are sent to a SEB client on connection setup and contain all SEB settings for a particular e-assessment.
- Setup and maintain Learning Management Systems (LMS) 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
@ -65,10 +65,10 @@ Another use-case would be to maintain registered user accounts, to give more pri
An institutional administrator has overall read access for its institution and is able to modify the institution properties as well as
create new or maintain existing user-accounts for the belonging institution. Furthermore an institutional administrator is able to create and maintain
learning management system (LMS) setups and SEB client-configurations for the belonging institution.
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.
Or another use-case would be to create and maintain SEB client configurations for the institutions and setup and maintain learning management systems
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.
**Exam Administrator**

6
docs/useraccount.rst
View file

@ -127,7 +127,7 @@ while all other users can only modify change its own password. The current passw
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/account/change_password.png
**Activate / Deactivate user-account
**Activate / Deactivate user-account**
Users with user-account write privileges (SEB Server administrator and institutional administrator) are able to activate/deactivate
user-accounts of others. A inactive user-account prevent a user to sign-in. There are several different ways or places where the status
@ -138,7 +138,7 @@ of a user-account can be changed
- 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.
**Delete a user-account
**Delete a user-account**
Users with user-account write privileges (SEB Server administrator and institutional administrator) are able to delete user-accounts of others.
@ -159,7 +159,7 @@ A user account can be deleted with all dependencies that belongs to the user-acc
:align: center
:target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/account/delete.png
- Within the delete dialog you are able to delete either:
- Within the delete dialog you are able to delete either
- Only the user-account with no dependencies at all (no selection)
- The user-account with all dependencies (Include all Dependencies)
- Or the user-account with only the exam dependencies, keeping the exam configurations (Include all Exams)