Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- manual:qvaluation:moodle [2010/09/15 18:30] – admin
+++ manual:qvaluation:moodle [2022/01/16 15:10] (aktuell) – [Installation] admin
@@ Zeile 7: / Zeile 7: @@
 ===== Moodle Block Module =====
-This Moodle block module enables you to show up course evaluation links within a sidebar block in your Moodle courses. The given URL leads a student to a feedback questionnaire managed by your [[http://www.quamp.com|QUAMP]] instance.
+This Moodle block module enables you to show up course evaluation links within a sidebar block in your Moodle courses. The given URL leads a student to feedback questionnaires and results reports managed by your [[http://www.quamp.com|QUAMP]] instance.
 ==== System requirements ====
-  * Moodle 1.7.x to Moodle 1.9.x (other versions may work, but not tested)
+  * QUAMP Moodle-Plugin v1: Moodle 1.7.x to Moodle 1.9.x
+  * QUAMP Moodle-Plugin v2: Moodle 2.x, Moodle 3.x
   * PHP 5.x, enabled CURL module
 ==== Download ====
   - Log in to your QUAMP backend
-  - Select ''course evaluation'' from main menu and ''QUAMP Moodle Plugin''
+  - Select ''Course evaluation | Import & Export'' from main menu then ''QUAMP Moodle Plugin''
 ==== Installation ====
   - See Moodle installation instructions [[http://docs.moodle.org/en/Installing_contributed_modules_or_plugins#Block_installation|here]]
   - Unpack ZIP archive
-  - Put folder ''sl_quamp_course_evaluation'' under ''/moodle/blocks''
+  - Put folder ''sl_quamp_course_evaluation_vx'' under ''/moodle/blocks'' folder (x=1 for Moodle 1.x, x=2 for Moodle > 2.x) and rename it into ''sl_quamp_course_evaluation''
-  - Visit administration page and select ''Notifications'' once you have installed or updated the plugin
+  - Visit administration page and select ''Notifications'' once you have installed or updated the block plugin
   - Edit global block settings at: ''Site Administration Block'' | ''Modules'' | ''Blocks'' | ''Course evaluation'' | ''Settings''
+    - Use your QUAMP instance URL for ''QUAMP-Server'': ''https://evaluation.your-organisation.de''
+    - Find your QUAMP instance API key in QUAMP backend under ''CMS'' | ''Applications'' then  ''Edit application'' | ''System integration''
 ==== Global block settings ====
@@ Zeile 30: / Zeile 33: @@
-  * **QUAMP server URL.** Your QUAMP instance, e.g. yourname.quamp.de (no http)
+  * **QUAMP server URL.** Your QUAMP instance, e.g. https://evaluation.your-organisation.de (including protocol and host names)
+  * **Proxy-Server.** For using a proxy server, format: user:password@ip:port
   * **Connection timeout.** Timeout in seconds waiting for QUAMP response
   * **API key.** API key to get allowed connecting QUAMP instance
   * **Course key field.** Select
-    *  **manual mode.** lecturers set course key manual or
+    *  **manual mode.** lecturers set course key of counterpart's QUAMP course manually or
     *  **data base field.** field of Moodle db ''course'' table holding the course key
   * **Allow overwriting course key by lecturers.** Whether or not lecturers can overwrite course key at instance/course level
@@ Zeile 57: / Zeile 61: @@
 key given by the specified DB field (see global settings).
-==== Anonymous username transmission ====
+==== Anonymous user name transmission ====
 To ensure that no Moodle user (student) can fill in the questionnaire
-multiple times the user's username will be encoded (MD5 hash) and transmitted when requesting QUAMP for survey URLs. This user key is only used to check whether or not a user (student) has already been participated.
+multiple times the user's user name will be encoded (MD5 hash) and transmitted when requesting QUAMP for survey URLs. This user key is only used to check whether or not a user (student) has already been participated.
+==== Response (error) codes ====
+When Moodle is asking your QUAMP instance for a survey URL, QUAMP uses several error codes. The following codes are used:
+  * **access denied** No or incorrect API key was given.
+  * **no course** No or unknown course key was given. QUAMP is looking for courses using the following course table fields in the QUAMP database: (1) the course key, (2) the user editable moodle name and (3) the user editable course id in combination with the current semester.
+  * **out of time period** The survey period has not been reached or is over. The questionnaire is not yet or no longer available.
+  * **no user** No user name (any key) was given or user has already been participated. Use a hashed key. QUAMP stores the key as is.
+  * **not active** The course is not yet activated for course evaluation. Possible reasons are, the lecturer set course evaluation to finished or no questionnaire was defined.
+  * **paper** Paper&Pencil questionnaire set.
+Moodle shows up a customizable text message in case one of the error codes was received. Edit the translation files included in the plug in to change the default messages. English and German translations are shipped.
+In all other cases an URL is returned by your QUAMP instance containing information on the course, on the user and on the questionnaire's language setting. This URL leads either to the questionnaire or to the ''Student's report'' in case the lecturer has finished course evaluation and set "results for students too" manually.