Zum Inhalt springen

Änderungen von Dokument 07 Schnittstelle ONYX Player

Zuletzt geändert von Carina Enke am 26.11.2025
Von Version 213.1
bearbeitet von Carina Enke
am 28.09.2020
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf 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.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,9 +1,7 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="single"}}
4 -{{layout-cell}}
5 -\\
6 -{{/layout-cell}}
4 +{{layout-cell}}{{/layout-cell}}
7 7  {{/layout-section}}
8 8  
9 9  {{layout-section ac:type="two_right_sidebar"}}
... ... @@ -18,26 +18,14 @@
18 18  {{/layout-cell}}
19 19  
20 20  {{layout-cell}}
21 -(% class="auto-cursor-target" %)
22 -\\
23 -
24 24  {{scroll-ignore}}
25 -(% class="auto-cursor-target" %)
26 -\\
27 -
28 28  {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
29 29  
30 30  
31 31  {{toc/}}
32 32  {{/panel}}
33 -
34 -(% class="auto-cursor-target" %)
35 -\\
36 36  {{/scroll-ignore}}
37 37  
38 -(% class="auto-cursor-target" %)
39 -\\
40 -
41 41  {{details hidden="true"}}
42 42  Diese Informationen werden nicht auf der Seite angezeigt.
43 43  
... ... @@ -116,9 +116,6 @@
116 116  (((
117 117  \\
118 118  )))
119 -
120 -(% class="auto-cursor-target" %)
121 -\\
122 122  {{/details}}
123 123  
124 124  \\
... ... @@ -174,7 +174,7 @@
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>>doc:ONYXintern.\.ONYX Player Interface v8\.12||anchor="AnmeldungeinesStudenten"]]).
160 +Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden (registerStudent).
178 178  
179 179  Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.
180 180  
... ... @@ -208,11 +208,8 @@
208 208  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.
209 209  {{/info}}
210 210  
211 -(% class="auto-cursor-target" %)
212 -\\
213 -
214 214  {{error}}
215 -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:
216 216  {{/error}}
217 217  
218 218  * showSolution [**true** |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)
... ... @@ -415,12 +415,11 @@
415 415  
416 416  Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen.
417 417  
398 +\\
399 +
418 418  {{error title="Sicherheit"}}
419 419  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.
420 420  {{/error}}
421 -
422 -(% class="auto-cursor-target" %)
423 -\\
424 424  {{/layout-cell}}
425 425  {{/layout-section}}
426 426  {{/layout}}
... ... @@ -456,7 +456,7 @@
456 456  
457 457  The ONYX Player defines a web service, which can be reached via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
458 458  
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"]]
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"]]
460 460  
461 461  == Registration of a test ==
462 462  
... ... @@ -475,6 +475,7 @@
475 475  
476 476  === Parameter registerTest ===
477 477  
457 +(% class="wrapped" %)
478 478  |(((
479 479  testSessionId
480 480  )))|(((
... ... @@ -493,11 +493,13 @@
493 493  |(((
494 494  parameters
495 495  )))|(((
476 +(% class="content-wrapper" %)
477 +(((
496 496  (% class="TableParagraph" %)
497 -List of parameters to control the test. Additional parameters can be set for individual participants ((% style="color: rgb(13,78,168);" %)registerStudent(%%)).
479 +List of parameters to control the test. Additional parameters can be set for individual participants ( registerStudent ).
498 498  
499 499  (% class="TableParagraph" %)
500 -All parameters are optional. The default setting is shown in bold.
482 +All parameters are optional. The default setting is shown in bold.
501 501  
502 502  {{info title="Note"}}
503 503  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"]]".
... ... @@ -529,15 +529,17 @@
529 529  {{/info}}
530 530  
531 531  {{error}}
532 -The following parameters are (% style="color: rgb(255,0,0);" %)**__no longer__**(%%)** **available since **ONYX** **version 5.15**:
514 +The following parameters are (% style="color: rgb(255,0,0);" %)**__no longer__ **(%%)available since **ONYX** **version 5.15**:
533 533  {{/error}}
534 534  
535 535  * showSolution [**true **|false] - Replaced by testShowScore, testShowPassed, itemShowSolution (including implications)
536 536  * showFeedback [**true **|false] - Replaced by testShowFeedback and itemShowFeedback
537 537  )))
520 +)))
538 538  
539 539  === ReturnValue registerTest ===
540 540  
524 +(% class="wrapped" %)
541 541  |(((
542 542  Long
543 543  )))|(((
... ... @@ -557,7 +557,7 @@
557 557  * OK(42) – OK
558 558  )))
559 559  |(((
560 -
544 +\\
561 561  )))|(((
562 562  **Error codes:**
563 563  
... ... @@ -588,6 +588,7 @@
588 588  
589 589  === Parameter registerStudent ===
590 590  
575 +(% class="wrapped" %)
591 591  |(((
592 592  testSessionId
593 593  )))|(((
... ... @@ -622,6 +622,7 @@
622 622  
623 623  === ReturnValue registerStudent ===
624 624  
610 +(% class="wrapped" %)
625 625  |(((
626 626  Long
627 627  )))|(((
... ... @@ -644,6 +644,7 @@
644 644  
645 645  === Parameter testControl ===
646 646  
633 +(% class="wrapped" %)
647 647  |(((
648 648  testSessionId
649 649  )))|(((
... ... @@ -669,6 +669,7 @@
669 669  
670 670  === ReturnValue testControl ===
671 671  
659 +(% class="wrapped" %)
672 672  |(((
673 673  Long
674 674  )))|(((
... ... @@ -690,6 +690,7 @@
690 690  
691 691  === Parameter deregisterTest ===
692 692  
681 +(% class="wrapped" %)
693 693  |(((
694 694  testSessionId
695 695  )))|(((
... ... @@ -708,6 +708,7 @@
708 708  
709 709  === ReturnValue deregisterTest ===
710 710  
700 +(% class="wrapped" %)
711 711  |(((
712 712  Long
713 713  )))|(((
... ... @@ -719,16 +719,14 @@
719 719  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:
720 720  
721 721  {{note title="URL"}}
722 -[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
712 +[[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
723 723  Only the URL in the lower part of the WSDL has to be adapted to the LMS.
724 724  {{/note}}
725 725  
726 726  == Configuration of the ONYX Player ==
727 727  
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:
718 +The ONYX Player uses a configuration file named onyxplugin.config.xml, which must be stored in the Java Classpath.
729 729  
730 -[[image:attach:SchnittstellePlayer.png]]
731 -
732 732  {{error title="Security"}}
733 733  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.
734 734  {{/error}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -372998366
1 +372998654
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/372998366/ONYX Player Interface
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/372998654/ONYX Player Interface