From 3d1cfe1e8697be4182cd19d7199d557d52311795 Mon Sep 17 00:00:00 2001 From: anhefti Date: Thu, 20 Apr 2023 12:01:42 +0200 Subject: [PATCH] docu LMS Setup --- README.rst | 2 +- docs/lmssetup.rst | 30 ++++++++++++++++++++++++++++-- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 2d58ef4d..15dd1c6e 100644 --- a/README.rst +++ b/README.rst @@ -42,7 +42,7 @@ SEB Server is a modern webservice with a REST API and a GUI service on top of it SEB Server provides a range of basic functionalities: - Built-in institutional multitenancy -- Linking of multiple Learning Management Systems (LMS). Currently supported LMS: `Open edX `_, `Moodle `_, `Open Olat `_, `Ans `_ +- Linking of multiple Learning Management Systems (LMS). Currently supported LMS: `Open edX `_, `Moodle `_, `Open Olat `_, `Ans Delft`_ - Accessing the Course/Exam-API of a linked LMS to import a courses or exams for managing with SEB Server - Creation and administration of SEB Client Configurations that can be used to startup a SEB and that contains SEB Server connection information for a SEB Client - Creation and administration of SEB Exam Configurations that can be bound to an imported Exam to automatically configure a SEB Client that connects to an exam that is managed by SEB Server diff --git a/docs/lmssetup.rst b/docs/lmssetup.rst index 448b55ab..9e942eb9 100644 --- a/docs/lmssetup.rst +++ b/docs/lmssetup.rst @@ -25,7 +25,7 @@ SEB Server supports this course API's so far: 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** +**SEB Restriction API** If the automated SEB restriction functionality is available for a LMS depends on the following requirements: @@ -62,10 +62,21 @@ SEB Server internally. Use the "Type" selector to specify the type of the LMS to .. note:: If you want to use the automated SEB restriction feature too, the `Open edX SEB Plugin `_ must be installed properly on the LMS. -- **Moodle**: This type is to bind an existing `Moodle `_ LMS system that is available on the Internet or intranet. The SEB +- **Moodle**: This type is to bind an existing `Moodle`_ 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 +- **Moodle with SEB Server Plugin**: The `SEB Server Plugin for Moodle`_ is new and supported by SEB Server since version 1.5. + With this plugin installed on Moodle side, SEB Server as able to more efficiently communicate with Moodle to fetch course data as well as restricting the quiz in Moodle side + For SEB only access, using a auto-generated Browser Exam Key (BEK) for SEB restriction. Also the Moodle user name resolving for SEB Server monitoring is less error prone especially + if SSO or other login provider for Moodle is involved. Furthermore the new SEB Server Plugin for Moodle is constantly extended and improved with new features in the future. + +- **Ans Delft**: This type is to bind SEB Server with an `Ans Delft`_ LMS instance. With the API credentials from an Ans Delft instance, SEB Server is able + to connect to the Ans LMS and provide the common features for Course-Access, SEB Restriction and LMS User Session resolving. + +- **Open Olat**: This type is to bind SEB Server with an `Open Olat `_ LMS instance. With the API credentials from an Open Olat instance, SEB Server is able + to connect to the Olat LMS and provide the common features for Course-Access, SEB Restriction and LMS User Session resolving. For more information please contact the Olat Development-Team at `OpenOLAT UZH`_ + 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" @@ -219,6 +230,10 @@ API account to be used with SEB Server. The role defines only the necessary priv Moodle role and account settings: :download:`XML ` +.. note:: + If you want to use Moodle with SEB Server, we recomend to install the new Moodle Plugin for SEB Server for better integration with Moodle. + This plugin comes with the common SEB Server integration features and improved Moodle bining. For more information see :ref:`lms-setup-moodle-plugin-label` + .. _lms-setup-rest-plugin-label: @@ -234,3 +249,14 @@ Install SEB restriction API plugin - `Documentation `_ - `Repository `_ + +.. _lms-setup-moodle-plugin-label: + +**Moodle Plugin for SEB Server** + + There is a new SEB Server integration plugin for Moodle available since SEB Server 1.5 that can be used with the LMS Setup type Moodle with SEB Server Plugin. + This Plugin supports and improves all common SEB Server LMS binding features such as Course-Access, SEB Restriction and LMS Session Name Resolving. + It is also planed to extend and improve this plugin with new Moodle specific feature for further releases of SEB Server. + - `Documentation `_ + - `Repository `_ +