Änderungen von Dokument 07 Schnittstelle ONYX Player

Zuletzt geändert von Carina Enke am 26.11.2025

Von 360.2 nach 360.1 Von 362.2 nach 362.1

Von Version 362.1

bearbeitet von Carina Enke
am 13.02.2024

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 360.2

bearbeitet von Carina Enke
am 06.02.2024

Änderungskommentar: Update document after refactoring.

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Titel

@@ -1,1 +1,1 @@
--07 Schnittstelle ONYX Player
++Schnittstelle ONYX Player

Inhalt

@@ -1,6 +1,455 @@
++
  {{layout}}
++{{layout-section ac:type="single"}}
++{{layout-cell}}{{/layout-cell}}
++{{/layout-section}}
++
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
++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
++{{/layout-cell}}
++
++{{layout-cell}}
++
++{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
++
++
++{{toc/}}
++{{/panel}}
++
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
++== Allgemeines ==
++
++Der ONYX Player definiert einen WebService. Dieser ist über die URL **<ONYXWebPlayer-URL>/onyx/onyxexamservices** erreichbar.
++
++Link zur WSDL der öffentlichen Demo-Runtime: (% class="nolink" %)**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.
++
++{{code language="xml" title="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 {
++}
++{{/code}}
++
++=== Parameter registerTest ===
++
++(% class="wrapped" %)
++|(((
++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
++)))|(((
++(% class="content-wrapper" %)
++(((
++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.
++
++(% class="wrapped" %)
++|=(((
++Parameter
++)))|=(((
++Beschreibung
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++showSolution [true|**false**]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Soll dem Nutzer die korrekte Antwort anzeigbar sein?
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++isSynchronized [true|**false**]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++continuationAllowed [true|**false**]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++suspendAllowed [true|**false**]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++Templateid
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Derzeit einzig unterstützt: onyxwithoutnav - führt zur Nichtanzeige des Navigationsbaumes.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++dontShowItemTitles (% class="error" %)[true|**false**]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++(% class="error" %)Sollen die Titel der Aufgaben nicht angezeigt werden?
++)))
++
++\\
++
++{{note}}
++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".
++{{/note}}
++
++Aufgabenauswertung:
++
++(% class="wrapped" %)
++|=(((
++Parameter
++)))|=(((
++Beschreibung
++)))
++|(((
++itemShowFeedback [**true**|false]
++)))|(((
++Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++itemShowMaxScore [**true**|false]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Dem Teilnehmer wird die maximal mögliche Punktzahl zu jeder Aufgabe angezeigt.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++itemShowScore [**true**|false]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++itemShowCorrect [**true**|false]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++itemShowSolution [**true**|false]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.
++)))
++
++Testauswertung:
++
++(% class="wrapped" %)
++|=(((
++Parameter
++)))|=(((
++Beschreibung
++)))
++|(((
++testShowFeedback [**true**|false]
++)))|(((
++Dem Teilnehmer wird nach Testabgabe eine Testabschlussseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++testShowScore [**true**|false]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++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.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++testShowPassed (% class="error" %)[**true**|false]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++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.
++)))
++
++\\
++
++{{info title="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.
++{{/info}}
++
++{{error}}
++Folgende Parameter sind seit **ONYX Version 5.15 **(% style="color: rgb(255,0,0);" %)__nicht mehr__ (%%)verfügbar:
++{{/error}}
++
++* showSolution [**true** |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)
++* showFeedback [**true** |false] - Ersetzt durch testShowFeedback sowie itemShowFeedback
++)))
++)))
++
++=== ReturnValue registerTest ===
++
++(% class="wrapped" %)
++|(((
++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.
++
++{{code title="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 {
++}
++{{/code}}
++
++=== Parameter registerStudent ===
++
++(% class="wrapped" %)
++|(((
++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.
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++payload
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Optional. Resultate für den Teilnehmer (bspw. im Fall der Fortsetzung unterbrochener Tests)
++)))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++parameters
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++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 ===
++
++(% class="wrapped" %)
++|(((
++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.
++
++{{code title="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 {
++}
++{{/code}}
++
++=== Parameter testControl ===
++
++(% class="wrapped" %)
++|(((
++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 ===
++
++(% class="wrapped" %)
++|(((
++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.
++
++{{code title="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 {
++}
++{{/code}}
++
++=== Parameter deregisterTest ===
++
++(% class="wrapped" %)
++|(((
++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 ===
++
++(% class="wrapped" %)
++|(((
++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:
++
++{{note title="URL"}}
++[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
++Lediglich die URL im unteren Teil der WSDL muss an die Lernplattform angepasst werden.
++{{/note}}
++
++== Konfiguration des ONYX Players ==
++
++Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen.
++
++\\
++
++{{error title="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.
++{{/error}}
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
++----
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
++\\
++
++{{column}}
++(% class="auto-cursor-target" %)
++Bei Fragen zur Konfiguration oder zum Einsatz der ONYX-Testsuite in anderen Plattformen helfen wir Ihnen gern weiter.
++
++{{panel title="BPS Bildungsportal Sachsen GmbH"}}
++**[[image:attach:BPS-Logo-web.png]]
++**
++
++**Tel.: **+49 (0) 371 666 2739 0(% style="color: rgb(89,89,89);" %)**
++E-Mail: **(%%)[[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]]
++
++Gern können Sie auch unser (% style="text-align: left;" %)**[[Kontaktformular>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]] **(%%)nutzen.
++{{/panel}}
++{{/column}}
++{{/layout-cell}}
++{{/layout-section}}
++{{/layout}}
++
++
++
++{{layout}}
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
  The API between the ONYX Player and the LMS consists of the following components:
  * Registration of a test with the ONYX Player through the LMS
@@ -11,9 +11,13 @@
  {{/layout-cell}}
  {{layout-cell}}
++
  {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
--{{toc start="2"/}}
++
++
++{{toc/}}
  {{/panel}}
++
  {{/layout-cell}}
  {{/layout-section}}
@@ -63,10 +63,10 @@
  (% class="content-wrapper" %)
  (((
  (% class="TableParagraph" %)
--List of parameters to control the test. It is also possible to set additional parameters for the individual participant (registerStudent).
++List of parameters to control the test. It is also possible to set additional parameters for the individual participant (registerStudent).
  (% class="TableParagraph" %)
--All parameters are optional. The default setting is shown in bold.
++All parameters are optional. The default setting is shown in bold.
  (% class="wrapped" %)
  |=(((
@@ -111,6 +111,8 @@
  Should the titles of the questions not be displayed?
  )))
++\\
++
  {{note}}
  Since ONYX version 5.15, the following parameters can be used to control the feedback and evaluation display for the participant while taking the test. A detailed description of the functionality from the user's perspective is provided in the section "Test procedure configuration".
  {{/note}}
@@ -179,6 +179,8 @@
  After submitting the test, the participant is shown a test completion page, which does (not) contain information about whether or not the test was passed. The default is the value given in testShowScore or its default.
  )))
++\\
++
  {{info title="Note"}}
  If no evaluation information is displayed on question level (itemShowFeedback = false, itemShowScore = false, itemShowCorrect = false, itemShowSolution = false), then the participant will not be shown the button to submit questions while taking the test. Instead, the answers are saved at any time and assessed after test submission.
  {{/info}}
@@ -214,7 +214,7 @@
  * OK(42) – OK
  )))
  |(((
--
++\\
  )))|(((
  **Error codes:**
@@ -382,7 +382,7 @@
  After a test has been registered with the Player, the user can display it **exactly once**. For this reason, the LMS will show an IFrame with the target URL <ONYXWebPlayer-URL>/onyx/onyxrun?id=<UID> in the browser window. The <UID> must be the unique studentId used in the test registration. The test will then be started. If the user finishes the test, the results will be returned to the LMS. The LMS then needs to define a web service API that exactly matches the WSDL available under the following URL:
  {{note title="URL"}}
--[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
++[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
  Only the URL in the lower part of the WSDL has to be adapted to the LMS.
  {{/note}}
@@ -409,14 +409,16 @@
  If you have any questions about the configuration or the use of the ONYX Testsuite in other platforms, we will be happy to help you.
  {{panel title="BPS Bildungsportal Sachsen GmbH"}}
--**[[image:attach:BPS-Logo-web.png]]**
++**[[image:attach:BPS-Logo-web.png]]
++**
--**Phone: **+49 (0) 371 666 2739 0
--(% style="color:#595959" %)**Email: **(%%)[[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]]
++**Phone: **+49 (0) 371 666 2739 0(% style="color: rgb(89,89,89);" %)**
++Email: **(%%)[[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]]
--You are also welcome to use our (% style="text-align:left" %)**[[Contact form>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]]**(%%).
++You are also welcome to use our (% style="text-align: left;" %)**[[Contact form>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]]**(%%).
  {{/panel}}
  {{/column}}
  {{/layout-cell}}
  {{/layout-section}}
  {{/layout}}
++

Änderungen von Dokument 07 Schnittstelle ONYX Player

Zusammenfassung

Details

Suchen

ONYXGlobal

ONYXMenü