Zum Inhalt springen

ONYX Player Interface

Version 356.1 von Carina Enke am 19.12.2023
Warnung: Aus Sicherheitsgründen wird das Dokument in einem eingeschränkten Modus angezeigt, da es sich nicht um die aktuelle Version handelt. Dadurch kann es zu Abweichungen und Fehlern kommen.

Die Schnittstelle zwischen ONYX Player und der Lernplattform besteht aus folgenden Komponenten:

  • Anmeldung eines Tests durch die Lernplattform beim ONYX Player
  • Anmeldung eines Teilnehmers durch die Lernplattform beim ONYX Player
  • Teststeuerung
  • Ergebnisrückgabe der Testresultate durch den ONYX Player an die Lernplattform
  • Abmeldung des Tests

Unbekanntes Makro: scroll-ignore. Klicke auf diese Nachricht, um Details zu erfahren.

Allgemeines

Der ONYX Player definiert einen WebService. Dieser ist über die URL <ONYXWebPlayer-URL>/onyx/onyxexamservices erreichbar.

Link zur WSDL der öffentlichen Demo-Runtime: http://demo.bps-system.de/onyx/onyxexamservices?wsdl

Anmeldung eines Tests

Bevor Teilnehmer Tests belegen können, müssen diese zuerst bei ONYX angemeldet werden.

Anmeldung
@WebMethod(operationName = „registerTest")
public Long registerTest(
@WebParam(name = „testSessionId") final Long testSessionId,
@WebParam(name = „providerId") final String providerId,
@WebParam(name = „contentPackage") final byte[] contentPackage,
@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
}

Parameter registerTest

testSessionId

Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für diesen Test darstellt.

providerId

Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.

contentPackage

Das IMS QTI v2.1 CP (ZIP-File als byte-Array).

parameters

Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden (registerStudent).

Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.

Parameter

Beschreibung

showSolution [true|false]

Soll dem Nutzer die korrekte Antwort anzeigbar sein?

isSynchronized [true|false]

Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?

continuationAllowed [true|false]

Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.

suspendAllowed [true|false]

Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.

Templateid

Derzeit einzig unterstützt: onyxwithoutnav - führt zur Nichtanzeige des Navigationsbaumes.

dontShowItemTitles [true|false]

Sollen die Titel der Aufgaben nicht angezeigt werden?


Warning

Mit folgenden Parametern lässt sich seit ONYX Version 5.15 die Feedback- und Auswertungsanzeige für den Teilnehmer während der Testdurchführung steuern. Eine detaillierte Beschreibung der Funktionalität aus Anwendersicht bietet der Abschnitt "Konfiguration der Testdurchführung".

Aufgabenauswertung:

Parameter

Beschreibung

itemShowFeedback [true|false]

Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.

itemShowMaxScore [true|false]

Dem Teilnehmer wird die maximal mögliche Punktzahl zu jeder Aufgabe angezeigt.

itemShowScore [true|false]

Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat.

itemShowCorrect [true|false]

Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.

itemShowSolution [true|false]

Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.

Testauswertung:

Parameter

Beschreibung

testShowFeedback [true|false]

Dem Teilnehmer wird nach Testabgabe eine Testabschlussseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.

testShowScore [true|false]

Dem Teilnehmer wird nach Testabgabe eine Testabschlussseite angezeigt, welche alle ermittelten Punktwerte wie die Gesamtpunktzahl des Tests und ggf. die Punkte pro Testabschnitt (nicht) enthält.

testShowPassed [true|false]

Dem Teilnehmer wird nach Testabgabe eine Testabschlussseite angezeigt, welche die Information (nicht) enthält, ob der Test bestanden wurde. Standard ist der in testShowScore gegebene Wert bzw. dessen Standard.


Information
Hinweis

Werden keine Auswertungsinformationen auf Aufgaben-Ebene angezeigt (itemShowFeedback = false, itemShowScore = false, itemShowCorrect = false, itemShowSolution = false), wird dem Teilnehmer während der Testdurchführung kein Button zur Aufgaben-Abgabe angezeigt. Die Antworten werden zu jeder Zeit gespeichert und nach Test-Abgabe ausgewertet.

Error

Folgende Parameter sind seit ONYX Version 5.15 nicht mehr verfügbar:

  • showSolution [true |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)
  • showFeedback [true |false] - Ersetzt durch testShowFeedback sowie itemShowFeedback

ReturnValue registerTest

Long

Einer der folgenden Werte:

  • WAITING(0) – warten auf Teststart
  • WORKING(1) – bearbeitet Test
  • FINISHED(2) – hat Test abgegeben
  • RESUME_ALLOWED(3) – Fortsetzen erlaubt
  • NOT_ENTERED(4) – hat Test noch nicht betreten
  • CANCELED(5) – hat Testbearbeitung abgebrochen
  • RESUME_REQUESTED(6) – möchte fortsetzen
  • RESUMED(7) – hat fortgesetzt
  • DISCONNECTED(8) – Client nicht (mehr) erreichbar
  • SUSPENDED(9) – Testbearbeitung unterbrochen
  • RESUME_SUSPENDED(10) – unterbrochene Bearbeitung fortgesetzt
  • OK(42) – OK


Fehlercodes:

  • ERROR_RETURN_RESULTS(0xFF01)
  • ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)
  • ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)
  • ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)
  • ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)
  • ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)
  • ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)
  • UNKNOWN(-1)

Anmeldung eines Studenten

Nach Anmeldung eines Tests können Studenten diesen nutzen. Dazu müssen auch diese angemeldet werden.

Anmeldung
@WebMethod(operationName = „registerStudent")
public Long registerStudent(
@WebParam(name = „testSessionId", partName = „testSessionId") final Long test
SessionId,
@WebParam(name = „studentId", partName = „studentId") final Long studentId,
@WebParam(name = „payload", partName = „payload") final byte[] payload,
@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
}

Parameter registerStudent

testSessionId

Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).

studentId

Eindeutige Kennung für Testteilnehmer. Diese wird von ONYX zurückgemeldet, wenn Statusänderungen oder Ergebnisse übertragen werden.

payload

Optional. Resultate für den Teilnehmer (bspw. im Fall der Fortsetzung unterbrochener Tests)

parameters

Liste von Parametern zur Teststeuerung (alle optional, fett gedruckt = Standard):

  • language [de|en|fr|es]: Sprache des Benutzer-Interfaces von ONYX.
  • status: Initialer Status des Teilnehmers (aktuell wird nur RESUME_SUSPENDED(10) unterstützt).

ReturnValue registerStudent

Long

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

Teststeuerung

Für registrierte Testteilnehmer kann der Status durch die Lernplattform kontrolliert werden, bspw. um nach der Freigabe durch den Betreuer für alle den Test zu starten, am Ende zu beenden oder fortzusetzen.

Teststeuerung
@WebMethod(operationName = „testControl")
public Long testControl(
@WebParam(name = „testSessionId") final Long testSessionId,
@WebParam(name = „studentIds") final StudentIdsWrapper students,
@WebParam(name = „status") final Integer status,
@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
}

Parameter testControl

testSessionId

Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).

studentIds

Liste eindeutiger Kennungen für Testteilnehmer.

status

Neu zu setzender Status für die gegebenen Testteilnehmer.

parameters

Liste von Parametern zur Teststeuerung (alle optional):

  • addTime: Time in minutes to add to the test session.

ReturnValue testControl

Long

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

Speicher aufräumen

Haben alle Teilnehmer den Test durchgeführt, so kann die Lernplattform ONYX mitteilen, dass dieses den Test deregistrieren und den Speicher aufräumen kann.

Teststeuerung
@WebMethod(operationName = „deregisterTest")
public Long deregisterTest(
@WebParam(name = „testSessionId") final Long testSessionId,
@WebParam(name = „providerId") final String providerId,
@WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
}

Parameter deregisterTest

testSessionId

Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).

providerId

Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.

parameters

Aktuell nicht verwendet.

ReturnValue deregisterTest

Long

Einer der Werte wie unter Anmeldung eines Tests beschrieben.

Anzeige des Tests

Nachdem ein Test beim Player angemeldet wurde, kann er vom Nutzer exakt ein Mal angezeigt werden. Dazu muss er von der Lernplattform im Browserfenster einen IFrame mit der Ziel-URL <ONYXWebPlayer-URL>/onyx/onyxrun?id=<UID> angezeigt bekommen, wobei <UID> die bei der Testanmeldung verwendete eindeutige studentId sein muss. Der Test wird dann wiedergegeben. Beendet der Nutzer den Test, so erfolgt eine Rückgabe der Resultate an die Lernplattform. Diese muss dazu eine Webservice-Schnittstelle definieren, welche exakt der unter der folgenden URL verfügbaren WSDL entspricht:

Warning

URL

http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl
Lediglich die URL im unteren Teil der WSDL muss an die Lernplattform angepasst werden.

Konfiguration des ONYX Players

Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen.


Error
Sicherheit

Sowohl die WSDL des ONYX Player als auch die der Lernplattform sollten „nach außen“ nicht erreichbar/sichtbar sein. Dies gilt ebenso für die jeweiligen WebServices. Die Web-GUI der Lernplattform und des ONYX Player hingegen müssen unabhängig davon für alle Nutzer sichtbar und zugreifbar sein. Kommt bei der Testdurchführung HTTPS zum Einsatz (wozu unbedingt zu raten ist), muss der jeweiligen Java VM der Lernplattform und des ONYX Player das entsprechende Zertifikat bekannt sein. Sonst ist die WebService-Kommunikation nicht möglich.


Bei Fragen zur Konfiguration oder zum Einsatz der ONYX-Testsuite in anderen Plattformen helfen wir Ihnen gern weiter.

BPS Bildungsportal Sachsen GmbH

BPS-Logo-web.png

Tel.: +49 (0) 371 666 2739 0
E-Mail: support@bps-system.de

Gern können Sie auch unser Kontaktformular nutzen.

Unbekanntes Makro: sv-translation. Klicke auf diese Nachricht, um Details zu erfahren.