Zum Inhalt springen

Änderungen von Dokument 07 Schnittstelle ONYX Player

Zuletzt geändert von Carina Enke am 26.11.2025
Von Version 206.1
bearbeitet von Carina Enke
am 01.10.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 9.3.
Auf Version 214.1
bearbeitet von Carina Enke
am 26.08.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 9.1.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -157,145 +157,42 @@
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  
164 -(% class="wrapped" %)
165 -|=(((
166 -Parameter
167 -)))|=(((
168 -Beschreibung
164 +{{info title="Hinweis"}}
165 +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" %) (%%).
166 +{{/info}}
167 +
168 +* showSolution [true|**false**] Soll dem Nutzer die korrekte Antwort anzeigbar sein?
169 +* isSynchronized [true|**false**] Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?
170 +* (((
171 +continuationAllowed [true|**false**] Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.
169 169  )))
170 -|(% colspan="1" %)(% colspan="1" %)
171 -(((
172 -showSolution [true|**false**]
173 -)))|(% colspan="1" %)(% colspan="1" %)
174 -(((
175 -Soll dem Nutzer die korrekte Antwort anzeigbar sein?
176 -)))
177 -|(% colspan="1" %)(% colspan="1" %)
178 -(((
179 -isSynchronized [true|**false**]
180 -)))|(% colspan="1" %)(% colspan="1" %)
181 -(((
182 -Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?
183 -)))
184 -|(% colspan="1" %)(% colspan="1" %)
185 -(((
186 -continuationAllowed [true|**false**]
187 -)))|(% colspan="1" %)(% colspan="1" %)
188 -(((
189 -Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.
190 -)))
191 -|(% colspan="1" %)(% colspan="1" %)
192 -(((
193 -suspendAllowed [true|**false**]
194 -)))|(% colspan="1" %)(% colspan="1" %)
195 -(((
196 -Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.
197 -)))
198 -|(% colspan="1" %)(% colspan="1" %)
199 -(((
200 -Templateid
201 -)))|(% colspan="1" %)(% colspan="1" %)
202 -(((
203 -Derzeit einzig unterstützt: onyxwithoutnav - führt zur Nichtanzeige des Navigationsbaumes.
204 -)))
205 -|(% colspan="1" %)(% colspan="1" %)
206 -(((
207 -dontShowItemTitles (% class="error" %)[true|**false**]
208 -)))|(% colspan="1" %)(% colspan="1" %)
209 -(((
210 -(% class="error" %)Sollen die Titel der Aufgaben nicht angezeigt werden?
211 -)))
173 +* suspendAllowed [true|**false**] Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.
174 +* Templateid: Derzeit einzig unterstützt: onyxwithoutnav – führt zur Nichtanzeige des Navigationsbaumes.
175 +* dontShowItemTitles (% class="error" %)[true|**false**]: Sollen die Titel der Aufgaben nicht angezeigt werden?
212 212  
213 -\\
214 214  
215 215  {{note}}
216 -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".
179 +Folgende Parameter sind seit **ONYX Version** **5.15** verfügbar:
217 217  {{/note}}
218 218  
219 -Aufgabenauswertung:
182 +* 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.
183 +* 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.
184 +* testShowFeedback [**true**|false] Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.
185 +* itemShowFeedback [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.
186 +* itemShowScore [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat..
187 +* itemShowCorrect [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.
188 +* itemShowSolution [**true**|false] Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.
220 220  
221 -\\
222 -
223 -(% class="wrapped" %)
224 -|=(((
225 -Parameter
226 -)))|=(((
227 -Beschreibung
228 -)))
229 -|(((
230 -itemShowFeedback [**true**|false]
231 -)))|(((
232 -Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.
233 -)))
234 -|(% colspan="1" %)(% colspan="1" %)
235 -(((
236 -itemShowMaxScore [**true**|false]
237 -)))|(% colspan="1" %)(% colspan="1" %)
238 -(((
239 -Dem Teilneher wird die maximal mögliche Punktzahl zur jeder Aufgabe angezeigt.
240 -)))
241 -|(% colspan="1" %)(% colspan="1" %)
242 -(((
243 -itemShowScore [**true**|false]
244 -)))|(% colspan="1" %)(% colspan="1" %)
245 -(((
246 -Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat.
247 -)))
248 -|(% colspan="1" %)(% colspan="1" %)
249 -(((
250 -itemShowCorrect [**true**|false]
251 -)))|(% colspan="1" %)(% colspan="1" %)
252 -(((
253 -Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.
254 -)))
255 -|(% colspan="1" %)(% colspan="1" %)
256 -(((
257 -itemShowSolution [**true**|false]
258 -)))|(% colspan="1" %)(% colspan="1" %)
259 -(((
260 -Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.
261 -)))
262 -
263 -Testauswertung:
264 -
265 -(% class="wrapped" %)
266 -|=(((
267 -Parameter
268 -)))|=(((
269 -Beschreibung
270 -)))
271 -|(((
272 -testShowFeedback [**true**|false]
273 -)))|(((
274 -Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.
275 -)))
276 -|(% colspan="1" %)(% colspan="1" %)
277 -(((
278 -testShowScore [**true**|false]
279 -)))|(% colspan="1" %)(% colspan="1" %)
280 -(((
281 -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.
282 -)))
283 -|(% colspan="1" %)(% colspan="1" %)
284 -(((
285 -testShowPassed (% class="error" %)[**true**|false]
286 -)))|(% colspan="1" %)(% colspan="1" %)
287 -(((
288 -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.
289 -)))
290 -
291 -\\
292 -
293 293  {{info title="Hinweis"}}
294 294  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.
295 295  {{/info}}
296 296  
297 297  {{error}}
298 -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:
299 299  {{/error}}
300 300  
301 301  * showSolution [**true** |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)
... ... @@ -496,8 +496,10 @@
496 496  
497 497  == Konfiguration des ONYX Players ==
498 498  
499 -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:
500 500  
398 +[[image:attach:SchnittstellePlayer.png]]
399 +
501 501  \\
502 502  
503 503  {{error title="Sicherheit"}}
... ... @@ -505,33 +505,6 @@
505 505  {{/error}}
506 506  {{/layout-cell}}
507 507  {{/layout-section}}
508 -
509 -{{layout-section ac:type="single"}}
510 -{{layout-cell}}
511 -----
512 -{{/layout-cell}}
513 -{{/layout-section}}
514 -
515 -{{layout-section ac:type="single"}}
516 -{{layout-cell}}
517 -\\
518 -
519 -{{column}}
520 -(% class="auto-cursor-target" %)
521 -Bei Fragen zur Konfiguration oder zum Einsatz der ONYX-Testsuite in anderen Plattformen helfen wir Ihnen gern weiter.
522 -
523 -{{panel title="BPS Bildungsportal Sachsen GmbH"}}
524 -**[[image:attach:BPS-Logo-web.png]]
525 -**
526 -
527 -**Tel.: **+49 (0) 371 666 2739 0(% style="color: rgb(89,89,89);" %)**
528 -E-Mail: **(%%)[[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]]
529 -
530 -Gern können Sie auch unser (% style="text-align: left;" %)**[[Kontaktformular>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]] **(%%)nutzen.
531 -{{/panel}}
532 -{{/column}}
533 -{{/layout-cell}}
534 -{{/layout-section}}
535 535  {{/layout}}
536 536  {{/sv-translation}}
537 537  
... ... @@ -565,7 +565,7 @@
565 565  
566 566  The ONYX Player defines a web service, which can be reached via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
567 567  
568 -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"]]
569 569  
570 570  == Registration of a test ==
571 571  
... ... @@ -584,7 +584,6 @@
584 584  
585 585  === Parameter registerTest ===
586 586  
587 -(% class="wrapped" %)
588 588  |(((
589 589  testSessionId
590 590  )))|(((
... ... @@ -603,13 +603,11 @@
603 603  |(((
604 604  parameters
605 605  )))|(((
606 -(% class="content-wrapper" %)
607 -(((
608 608  (% class="TableParagraph" %)
609 -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(%%)).
610 610  
611 611  (% class="TableParagraph" %)
612 -All parameters are optional. The default setting is shown in bold.
481 +All parameters are optional. The default setting is shown in bold.
613 613  
614 614  {{info title="Note"}}
615 615  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"]]".
... ... @@ -641,17 +641,15 @@
641 641  {{/info}}
642 642  
643 643  {{error}}
644 -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**:
645 645  {{/error}}
646 646  
647 647  * showSolution [**true **|false] - Replaced by testShowScore, testShowPassed, itemShowSolution (including implications)
648 648  * showFeedback [**true **|false] - Replaced by testShowFeedback and itemShowFeedback
649 649  )))
650 -)))
651 651  
652 652  === ReturnValue registerTest ===
653 653  
654 -(% class="wrapped" %)
655 655  |(((
656 656  Long
657 657  )))|(((
... ... @@ -671,7 +671,7 @@
671 671  * OK(42) – OK
672 672  )))
673 673  |(((
674 -\\
541 +
675 675  )))|(((
676 676  **Error codes:**
677 677  
... ... @@ -702,7 +702,6 @@
702 702  
703 703  === Parameter registerStudent ===
704 704  
705 -(% class="wrapped" %)
706 706  |(((
707 707  testSessionId
708 708  )))|(((
... ... @@ -737,7 +737,6 @@
737 737  
738 738  === ReturnValue registerStudent ===
739 739  
740 -(% class="wrapped" %)
741 741  |(((
742 742  Long
743 743  )))|(((
... ... @@ -760,7 +760,6 @@
760 760  
761 761  === Parameter testControl ===
762 762  
763 -(% class="wrapped" %)
764 764  |(((
765 765  testSessionId
766 766  )))|(((
... ... @@ -786,7 +786,6 @@
786 786  
787 787  === ReturnValue testControl ===
788 788  
789 -(% class="wrapped" %)
790 790  |(((
791 791  Long
792 792  )))|(((
... ... @@ -808,7 +808,6 @@
808 808  
809 809  === Parameter deregisterTest ===
810 810  
811 -(% class="wrapped" %)
812 812  |(((
813 813  testSessionId
814 814  )))|(((
... ... @@ -827,7 +827,6 @@
827 827  
828 828  === ReturnValue deregisterTest ===
829 829  
830 -(% class="wrapped" %)
831 831  |(((
832 832  Long
833 833  )))|(((
... ... @@ -839,14 +839,16 @@
839 839  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:
840 840  
841 841  {{note title="URL"}}
842 -[[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"]]
843 843  Only the URL in the lower part of the WSDL has to be adapted to the LMS.
844 844  {{/note}}
845 845  
846 846  == Configuration of the ONYX Player ==
847 847  
848 -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:
849 849  
711 +[[image:attach:SchnittstellePlayer.png]]
712 +
850 850  {{error title="Security"}}
851 851  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.
852 852  {{/error}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -374473242
1 +372998253
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/374473242/ONYX Player Interface
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/372998253/ONYX Player Interface