Änderungen von Dokument 07 Schnittstelle ONYX Player

Zuletzt geändert von Carina Enke am 26.11.2025

Von Version 205.1
bearbeitet von Carina Enke
am 01.10.2020
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 212.1
bearbeitet von Carina Enke
am 28.09.2020
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -174,137 +174,36 @@
174 174  )))|(((
175 175  (% class="content-wrapper" %)
176 176  (((
177 -Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden (registerStudent).
177 +Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden ([[registerStudent>>doc:ONYXintern.\.ONYX Player Interface v8\.12||anchor="AnmeldungeinesStudenten"]]).
178 178  
179 179  Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.
180 180  
181 -(% class="wrapped" %)
182 -|=(((
183 -Parameter
184 -)))|=(((
185 -Beschreibung
181 +{{info title="Hinweis"}}
182 +Seit der ONYX Version 5.15 lässt sich die Feedback- und Auswertungsanzeige für den Teilnehmer während der Testdurchführung genauer steuern. Für diese Funktionalität wurde die Schnittstelle angepasst. Eine detaillierte Beschreibung der Funktionalität aus Anwendersicht bietet der Abschnitt "[[doc:Konfiguration der Testdurchfuehrung]]"(% class="error" %) (%%).
183 +{{/info}}
184 +
185 +* showSolution [true|**false**] Soll dem Nutzer die korrekte Antwort anzeigbar sein?
186 +* isSynchronized [true|**false**] Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?
187 +* (((
188 +continuationAllowed [true|**false**] Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.
186 186  )))
187 -|(% colspan="1" %)(% colspan="1" %)
188 -(((
189 -showSolution [true|**false**]
190 -)))|(% colspan="1" %)(% colspan="1" %)
191 -(((
192 -Soll dem Nutzer die korrekte Antwort anzeigbar sein?
193 -)))
194 -|(% colspan="1" %)(% colspan="1" %)
195 -(((
196 -isSynchronized [true|**false**]
197 -)))|(% colspan="1" %)(% colspan="1" %)
198 -(((
199 -Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?
200 -)))
201 -|(% colspan="1" %)(% colspan="1" %)
202 -(((
203 -continuationAllowed [true|**false**]
204 -)))|(% colspan="1" %)(% colspan="1" %)
205 -(((
206 -Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.
207 -)))
208 -|(% colspan="1" %)(% colspan="1" %)
209 -(((
210 -suspendAllowed [true|**false**]
211 -)))|(% colspan="1" %)(% colspan="1" %)
212 -(((
213 -Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.
214 -)))
215 -|(% colspan="1" %)(% colspan="1" %)
216 -(((
217 -Templateid
218 -)))|(% colspan="1" %)(% colspan="1" %)
219 -(((
220 -Derzeit einzig unterstützt: onyxwithoutnav - führt zur Nichtanzeige des Navigationsbaumes.
221 -)))
222 -|(% colspan="1" %)(% colspan="1" %)
223 -(((
224 -dontShowItemTitles (% class="error" %)[true|**false**]
225 -)))|(% colspan="1" %)(% colspan="1" %)
226 -(((
227 -(% class="error" %)Sollen die Titel der Aufgaben nicht angezeigt werden?
228 -)))
190 +* suspendAllowed [true|**false**] Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.
191 +* Templateid: Derzeit einzig unterstützt: onyxwithoutnav – führt zur Nichtanzeige des Navigationsbaumes.
192 +* dontShowItemTitles (% class="error" %)[true|**false**]: Sollen die Titel der Aufgaben nicht angezeigt werden?
229 229  
230 -\\
231 231  
232 232  {{note}}
233 -Mit folgenden Parametern sst sich seit ONYX Version 5.15 die Feedback- und Auswertungsanzeige r den Teilnehmer während der Testdurchführung steuern. Eine detaillierte Beschreibung der Funktionalität aus Anwendersicht bietet der Abschnitt "Konfiguration der Testdurchführung".
196 +Folgende Parameter sind seit **ONYX Version** **5.15** verfügbar:
234 234  {{/note}}
235 235  
236 -Aufgabenauswertung:
199 +* testShowScore [**true**|false] Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche alle ermittelten Punktwerte, wie die Gesamtpunktzahl des Tests und ggf. Punkte pro Testabschnitt, (nicht) enthält.
200 +* testShowPassed (% class="error" %)[true|false](%%) Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, die die Information (nicht) enthält, ob der Test bestanden wurde. Standard ist der in testShowScore gegebene Wert bzw. dessen Standard.
201 +* testShowFeedback [**true**|false] Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.
202 +* itemShowFeedback [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.
203 +* itemShowScore [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat..
204 +* itemShowCorrect [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.
205 +* itemShowSolution [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.
237 237  
238 -(% class="wrapped" %)
239 -|=(((
240 -Parameter
241 -)))|=(((
242 -Beschreibung
243 -)))
244 -|(((
245 -itemShowFeedback [**true**|false]
246 -)))|(((
247 -Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.
248 -)))
249 -|(% colspan="1" %)(% colspan="1" %)
250 -(((
251 -itemShowMaxScore [**true**|false]
252 -)))|(% colspan="1" %)(% colspan="1" %)
253 -(((
254 -Dem Teilneher wird die maximal mögliche Punktzahl zur jeder Aufgabe angezeigt.
255 -)))
256 -|(% colspan="1" %)(% colspan="1" %)
257 -(((
258 -itemShowScore [**true**|false]
259 -)))|(% colspan="1" %)(% colspan="1" %)
260 -(((
261 -Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat.
262 -)))
263 -|(% colspan="1" %)(% colspan="1" %)
264 -(((
265 -itemShowCorrect [**true**|false]
266 -)))|(% colspan="1" %)(% colspan="1" %)
267 -(((
268 -Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.
269 -)))
270 -|(% colspan="1" %)(% colspan="1" %)
271 -(((
272 -itemShowSolution [**true**|false]
273 -)))|(% colspan="1" %)(% colspan="1" %)
274 -(((
275 -Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.
276 -)))
277 -
278 -Testauswertung:
279 -
280 -(% class="wrapped" %)
281 -|=(((
282 -Parameter
283 -)))|=(((
284 -Beschreibung
285 -)))
286 -|(((
287 -testShowFeedback [**true**|false]
288 -)))|(((
289 -Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.
290 -)))
291 -|(% colspan="1" %)(% colspan="1" %)
292 -(((
293 -testShowScore [**true**|false]
294 -)))|(% colspan="1" %)(% colspan="1" %)
295 -(((
296 -Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche alle ermittelten Punktwerte, wie die Gesamtpunktzahl des Tests und ggf. Punkte pro Testabschnitt, (nicht) enthält.
297 -)))
298 -|(% colspan="1" %)(% colspan="1" %)
299 -(((
300 -testShowPassed (% class="error" %)[**true**|false]
301 -)))|(% colspan="1" %)(% colspan="1" %)
302 -(((
303 -Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, die die Information (nicht) enthält, ob der Test bestanden wurde. Standard ist der in testShowScore gegebene Wert bzw. dessen Standard.
304 -)))
305 -
306 -\\
307 -
308 308  {{info title="Hinweis"}}
309 309  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.
310 310  {{/info}}
... ... @@ -313,7 +313,7 @@
313 313  \\
314 314  
315 315  {{error}}
316 -Folgende Parameter sind seit **ONYX Version 5.15 **(% style="color: rgb(255,0,0);" %)__nicht mehr__ (%%)verfügbar:
215 +Folgende Parameter sind seit **ONYX Version 5.15 (% style="color: rgb(255,0,0);" %)__nicht mehr__(%%)** verfügbar:
317 317  {{/error}}
318 318  
319 319  * showSolution [**true** |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)
... ... @@ -516,8 +516,6 @@
516 516  
517 517  Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen.
518 518  
519 -\\
520 -
521 521  {{error title="Sicherheit"}}
522 522  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 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 Players das entsprechende Zertifikat bekannt sein. Sonst ist die WebService-Kommunikation nicht möglich.
523 523  {{/error}}
... ... @@ -526,39 +526,6 @@
526 526  \\
527 527  {{/layout-cell}}
528 528  {{/layout-section}}
529 -
530 -{{layout-section ac:type="single"}}
531 -{{layout-cell}}
532 -----
533 -{{/layout-cell}}
534 -{{/layout-section}}
535 -
536 -{{layout-section ac:type="single"}}
537 -{{layout-cell}}
538 -\\
539 -
540 -{{column}}
541 -(% class="auto-cursor-target" %)
542 -Bei Fragen zur Konfiguration oder zum Einsatz der ONYX-Testsuite in anderen Plattformen helfen wir Ihnen gern weiter.
543 -
544 -{{panel title="BPS Bildungsportal Sachsen GmbH"}}
545 -**[[image:attach:BPS-Logo-web.png]]
546 -**
547 -
548 -**Tel.: **+49 (0) 371 666 2739 0(% style="color: rgb(89,89,89);" %)**
549 -E-Mail: **(%%)[[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]]
550 -
551 -Gern können Sie auch unser (% style="text-align: left;" %)**[[Kontaktformular>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]] **(%%)nutzen.
552 -{{/panel}}
553 -
554 -(% class="auto-cursor-target" %)
555 -\\
556 -{{/column}}
557 -
558 -(% class="auto-cursor-target" %)
559 -\\
560 -{{/layout-cell}}
561 -{{/layout-section}}
562 562  {{/layout}}
563 563  {{/sv-translation}}
564 564  
... ... @@ -592,7 +592,7 @@
592 592  
593 593  The ONYX Player defines a web service, which can be reached via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
594 594  
595 -Link to the WSDL of the public demo runtime: [[http:~~/~~/demo.bps-system.de/onyx/>>url:http://demo.bps-system.de/onyx/||shape="rect"]] [[onyxexamservices?wsdl>>url:http://demo.bps-system.de/onyx/onyxexamservices?wsdl||shape="rect"]]
459 +Link to the WSDL of the public demo runtime: [[http:~~/~~/demo.bps-system.de/onyx/>>url:http://demo.bps-system.de/onyx/||shape="rect"]][[onyxexamservices?wsdl>>url:http://demo.bps-system.de/onyx/onyxexamservices?wsdl||shape="rect"]]
596 596  
597 597  == Registration of a test ==
598 598  
... ... @@ -611,7 +611,6 @@
611 611  
612 612  === Parameter registerTest ===
613 613  
614 -(% class="wrapped" %)
615 615  |(((
616 616  testSessionId
617 617  )))|(((
... ... @@ -630,13 +630,11 @@
630 630  |(((
631 631  parameters
632 632  )))|(((
633 -(% class="content-wrapper" %)
634 -(((
635 635  (% class="TableParagraph" %)
636 -List of parameters to control the test. Additional parameters can be set for individual participants ( registerStudent ).
497 +List of parameters to control the test. Additional parameters can be set for individual participants ((% style="color: rgb(13,78,168);" %)registerStudent(%%)).
637 637  
638 638  (% class="TableParagraph" %)
639 -All parameters are optional. The default setting is shown in bold.
500 +All parameters are optional. The default setting is shown in bold.
640 640  
641 641  {{info title="Note"}}
642 642  Since ONYX version 5.15, the feedback and assessment display for the participant can be controlled more precisely during the test execution. The interface has been adapted for this functionality. For a more detailed description of the functionality from the user perspective, see section "[[Configuration of the test implementation>>url:https://www.bps-system.de/help/display/ONYXintern/.Konfiguration+der+Testdurchfuehrung+v1.11||shape="rect"]]".
... ... @@ -668,17 +668,15 @@
668 668  {{/info}}
669 669  
670 670  {{error}}
671 -The following parameters are (% style="color: rgb(255,0,0);" %)**__no longer__ **(%%)available since **ONYX** **version 5.15**:
532 +The following parameters are (% style="color: rgb(255,0,0);" %)**__no longer__**(%%)** **available since **ONYX** **version 5.15**:
672 672  {{/error}}
673 673  
674 674  * showSolution [**true **|false] - Replaced by testShowScore, testShowPassed, itemShowSolution (including implications)
675 675  * showFeedback [**true **|false] - Replaced by testShowFeedback and itemShowFeedback
676 676  )))
677 -)))
678 678  
679 679  === ReturnValue registerTest ===
680 680  
681 -(% class="wrapped" %)
682 682  |(((
683 683  Long
684 684  )))|(((
... ... @@ -698,7 +698,7 @@
698 698  * OK(42) – OK
699 699  )))
700 700  |(((
701 -\\
560 +
702 702  )))|(((
703 703  **Error codes:**
704 704  
... ... @@ -729,7 +729,6 @@
729 729  
730 730  === Parameter registerStudent ===
731 731  
732 -(% class="wrapped" %)
733 733  |(((
734 734  testSessionId
735 735  )))|(((
... ... @@ -764,7 +764,6 @@
764 764  
765 765  === ReturnValue registerStudent ===
766 766  
767 -(% class="wrapped" %)
768 768  |(((
769 769  Long
770 770  )))|(((
... ... @@ -787,7 +787,6 @@
787 787  
788 788  === Parameter testControl ===
789 789  
790 -(% class="wrapped" %)
791 791  |(((
792 792  testSessionId
793 793  )))|(((
... ... @@ -813,7 +813,6 @@
813 813  
814 814  === ReturnValue testControl ===
815 815  
816 -(% class="wrapped" %)
817 817  |(((
818 818  Long
819 819  )))|(((
... ... @@ -835,7 +835,6 @@
835 835  
836 836  === Parameter deregisterTest ===
837 837  
838 -(% class="wrapped" %)
839 839  |(((
840 840  testSessionId
841 841  )))|(((
... ... @@ -854,7 +854,6 @@
854 854  
855 855  === ReturnValue deregisterTest ===
856 856  
857 -(% class="wrapped" %)
858 858  |(((
859 859  Long
860 860  )))|(((
... ... @@ -866,14 +866,16 @@
866 866  After a test has been registered with the Player, it will be displayed to the user **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 are returned to the LMS. The LMS then needs to define a web service API that exactly matches the WSDL available under the following URL:
867 867  
868 868  {{note title="URL"}}
869 -[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
722 +[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
870 870  Only the URL in the lower part of the WSDL has to be adapted to the LMS.
871 871  {{/note}}
872 872  
873 873  == Configuration of the ONYX Player ==
874 874  
875 -The ONYX Player uses a configuration file named onyxplugin.config.xml, which must be stored in the Java Classpath.
728 +The ONYX Player uses a configuration file named onyxplugin.config.xml, which must be stored in the Java Classpath. It is defined as follows:
876 876  
730 +[[image:attach:SchnittstellePlayer.png]]
731 +
877 877  {{error title="Security"}}
878 878  Both the WSDL of the ONYX Player and the LMS should not be accessible/visible from the outside. This also applies to the respective web services. The web GUI of the LMS and the ONYX Player, in contrast, must be visible to and accessible for all users. If HTTPS is used during the test execution (recommended), the appropriate certificate must be known to the corresponding JVM of the LMS and the ONYX Player. Otherwise web service communication is not possible.
879 879  {{/error}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -374473243
1 +372998366
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/374473243/ONYX Player Interface
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/372998366/ONYX Player Interface