Zum Inhalt springen

Änderungen von Dokument 07 Schnittstelle ONYX Player

Zuletzt geändert von Carina Enke am 26.11.2025
Von Version 211.1
bearbeitet von Carina Enke
am 28.09.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 9.2.
Auf Version 217.1
bearbeitet von Carina Enke
am 31.07.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 9.1.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -157,7 +157,7 @@
157 157  )))|(((
158 158  (% class="content-wrapper" %)
159 159  (((
160 -Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden (registerStudent).
160 +Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden ([[registerStudent>>doc:||anchor="AnmeldungeinesStudenten"]]).
161 161  
162 162  Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.
163 163  
... ... @@ -192,7 +192,7 @@
192 192  {{/info}}
193 193  
194 194  {{error}}
195 -Folgende Parameter sind seit **ONYX Version 5.15 (% style="color: rgb(255,0,0);" %)__nicht mehr__ (%%)**verfügbar:
195 +Folgende Parameter sind seit **ONYX Version 5.15 (% style="color: rgb(255,0,0);" %)__nicht mehr__(%%)** verfügbar:
196 196  {{/error}}
197 197  
198 198  * showSolution [**true** |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)
... ... @@ -393,8 +393,10 @@
393 393  
394 394  == Konfiguration des ONYX Players ==
395 395  
396 -Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen.
396 +Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen. Sie ist wie folgt definiert:
397 397  
398 +[[image:attach:SchnittstellePlayer.png]]
399 +
398 398  \\
399 399  
400 400  {{error title="Sicherheit"}}
... ... @@ -435,7 +435,7 @@
435 435  
436 436  The ONYX Player defines a web service, which can be reached via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
437 437  
438 -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"]]
440 +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"]]
439 439  
440 440  == Registration of a test ==
441 441  
... ... @@ -454,7 +454,6 @@
454 454  
455 455  === Parameter registerTest ===
456 456  
457 -(% class="wrapped" %)
458 458  |(((
459 459  testSessionId
460 460  )))|(((
... ... @@ -473,13 +473,11 @@
473 473  |(((
474 474  parameters
475 475  )))|(((
476 -(% class="content-wrapper" %)
477 -(((
478 478  (% class="TableParagraph" %)
479 -List of parameters to control the test. Additional parameters can be set for individual participants ( registerStudent ).
478 +List of parameters to control the test. Additional parameters can be set for individual participants ((% style="color: rgb(13,78,168);" %)registerStudent(%%)).
480 480  
481 481  (% class="TableParagraph" %)
482 -All parameters are optional. The default setting is shown in bold.
481 +All parameters are optional. The default setting is shown in bold.
483 483  
484 484  {{info title="Note"}}
485 485  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"]]".
... ... @@ -511,17 +511,15 @@
511 511  {{/info}}
512 512  
513 513  {{error}}
514 -The following parameters are (% style="color: rgb(255,0,0);" %)**__no longer__ **(%%)available since **ONYX** **version 5.15**:
513 +The following parameters are (% style="color: rgb(255,0,0);" %)**__no longer__**(%%)** **available since **ONYX** **version 5.15**:
515 515  {{/error}}
516 516  
517 517  * showSolution [**true **|false] - Replaced by testShowScore, testShowPassed, itemShowSolution (including implications)
518 518  * showFeedback [**true **|false] - Replaced by testShowFeedback and itemShowFeedback
519 519  )))
520 -)))
521 521  
522 522  === ReturnValue registerTest ===
523 523  
524 -(% class="wrapped" %)
525 525  |(((
526 526  Long
527 527  )))|(((
... ... @@ -541,7 +541,7 @@
541 541  * OK(42) – OK
542 542  )))
543 543  |(((
544 -\\
541 +
545 545  )))|(((
546 546  **Error codes:**
547 547  
... ... @@ -572,7 +572,6 @@
572 572  
573 573  === Parameter registerStudent ===
574 574  
575 -(% class="wrapped" %)
576 576  |(((
577 577  testSessionId
578 578  )))|(((
... ... @@ -607,7 +607,6 @@
607 607  
608 608  === ReturnValue registerStudent ===
609 609  
610 -(% class="wrapped" %)
611 611  |(((
612 612  Long
613 613  )))|(((
... ... @@ -630,7 +630,6 @@
630 630  
631 631  === Parameter testControl ===
632 632  
633 -(% class="wrapped" %)
634 634  |(((
635 635  testSessionId
636 636  )))|(((
... ... @@ -656,7 +656,6 @@
656 656  
657 657  === ReturnValue testControl ===
658 658  
659 -(% class="wrapped" %)
660 660  |(((
661 661  Long
662 662  )))|(((
... ... @@ -678,7 +678,6 @@
678 678  
679 679  === Parameter deregisterTest ===
680 680  
681 -(% class="wrapped" %)
682 682  |(((
683 683  testSessionId
684 684  )))|(((
... ... @@ -697,7 +697,6 @@
697 697  
698 698  === ReturnValue deregisterTest ===
699 699  
700 -(% class="wrapped" %)
701 701  |(((
702 702  Long
703 703  )))|(((
... ... @@ -709,14 +709,16 @@
709 709  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:
710 710  
711 711  {{note title="URL"}}
712 -[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
703 +[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
713 713  Only the URL in the lower part of the WSDL has to be adapted to the LMS.
714 714  {{/note}}
715 715  
716 716  == Configuration of the ONYX Player ==
717 717  
718 -The ONYX Player uses a configuration file named onyxplugin.config.xml, which must be stored in the Java Classpath.
709 +The ONYX Player uses a configuration file named onyxplugin.config.xml, which must be stored in the Java Classpath. It is defined as follows:
719 719  
711 +[[image:attach:SchnittstellePlayer.png]]
712 +
720 720  {{error title="Security"}}
721 721  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.
722 722  {{/error}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -372998654
1 +363593815
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/372998654/ONYX Player Interface
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/363593815/ONYX Player Interface