Wiki-Quellcode von ONYX Player Interface

Version 207.1 von Carina Enke am 01.10.2020

Zeige letzte Bearbeiter
1 {{sv-translation language="de"}}
2 {{layout}}
3 {{layout-section ac:type="single"}}
4 {{layout-cell}}{{/layout-cell}}
5 {{/layout-section}}
6
7 {{layout-section ac:type="two_right_sidebar"}}
8 {{layout-cell}}
9 Die Schnittstelle zwischen ONYX Player und der Lernplattform besteht aus folgenden Komponenten:
10
11 * Anmeldung eines Tests durch die Lernplattform beim ONYX Player
12 * Anmeldung eines Teilnehmers durch die Lernplattform beim ONYX Player
13 * Teststeuerung
14 * Ergebnisrückgabe der Testresultate durch den ONYX Player an die Lernplattform
15 * Abmeldung des Tests
16 {{/layout-cell}}
17
18 {{layout-cell}}
19 {{scroll-ignore}}
20 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
21
22
23 {{toc/}}
24 {{/panel}}
25 {{/scroll-ignore}}
26
27 {{details hidden="true"}}
28 Diese Informationen werden nicht auf der Seite angezeigt.
29
30 (% class="wrapped" %)
31 |=(% colspan="1" %)(% colspan="1" %)
32 (((
33 Beteiligte
34 )))|(% colspan="1" %)(% colspan="1" %)
35 (((
36 (% class="content-wrapper" %)
37 (((
38 {{contributors order="name"/}}
39 )))
40 )))
41 |=(% colspan="1" %)(% colspan="1" %)
42 (((
43 Deadline
44 )))|(% colspan="1" %)(% colspan="1" %)
45 (((
46 ~/~/
47 )))
48 |=(((
49 Verantwortlicher
50 )))|(((
51 (% class="task-list" %)
52 (((
53 {{task reference="/Tasks/Task_8" status="InProgress"}}
54
55 {{/task}}
56 )))
57 )))
58 |=(% colspan="1" %)(% colspan="1" %)
59 (((
60 Status
61 )))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
62 (((
63 (% class="content-wrapper" %)
64 (((
65 {{sv-metadata default-text="Workflow Status" type="workflow-status"/}}
66 )))
67 )))
68 |=(% colspan="1" %)(% colspan="1" %)
69 (((
70 Varianten
71 )))|(% colspan="1" %)(% colspan="1" %)
72 (((
73 (% class="content-wrapper" %)
74 (((
75 {{sv-metadata default-text="Varianten" type="variants"/}}
76 )))
77 )))
78 |=(% colspan="1" %)(% colspan="1" %)
79 (((
80 Attribute
81 )))|(% colspan="1" %)(% colspan="1" %)
82 (((
83 (% class="content-wrapper" %)
84 (((
85 {{sv-metadata default-text="Attribute" type="attributes"/}}
86 )))
87 )))
88 |=(% colspan="1" %)(% colspan="1" %)
89 (((
90 Pagekey
91 )))|(% colspan="1" %)(% colspan="1" %)
92 (((
93 (% class="content-wrapper" %)
94 (((
95 {{sv-metadata default-text="Pagekey" type="pagekey"/}}
96 )))
97 )))
98 |=(% colspan="1" %)(% colspan="1" %)
99 (((
100 Autorenbemerkung
101 )))|(% colspan="1" %)(% colspan="1" %)
102 (((
103 \\
104 )))
105 {{/details}}
106
107 \\
108
109 \\
110 {{/layout-cell}}
111 {{/layout-section}}
112
113 {{layout-section ac:type="single"}}
114 {{layout-cell}}
115 == Allgemeines ==
116
117 Der ONYX Player definiert einen WebService. Dieser ist über die URL **<ONYXWebPlayer-URL>/onyx/onyxexamservices** erreichbar.
118
119 Link zur WSDL der öffentlichen Demo-Runtime: (% class="nolink" %)**http:~/~/demo.bps-system.de/onyx/onyxexamservices?wsdl**
120
121 == Anmeldung eines Tests ==
122
123 Bevor Teilnehmer Tests belegen können, müssen diese zuerst bei ONYX angemeldet werden.
124
125 {{code language="xml" title="Anmeldung"}}
126 @WebMethod(operationName = „registerTest")
127 public Long registerTest(
128 @WebParam(name = „testSessionId") final Long testSessionId,
129 @WebParam(name = „providerId") final String providerId,
130 @WebParam(name = „contentPackage") final byte[] contentPackage,
131 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
132 }
133 {{/code}}
134
135 === Parameter registerTest ===
136
137 (% class="wrapped" %)
138 |(((
139 testSessionId
140 )))|(((
141 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für diesen Test
142
143 darstellt.
144 )))
145 |(((
146 providerId
147 )))|(((
148 Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.
149 )))
150 |(((
151 contentPackage
152 )))|(((
153 Das IMS QTI v2.1 CP (ZIP-File als byte-Array).
154 )))
155 |(((
156 parameters
157 )))|(((
158 (% class="content-wrapper" %)
159 (((
160 Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden (registerStudent).
161
162 Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.
163
164 (% class="wrapped" %)
165 |=(((
166 Parameter
167 )))|=(((
168 Beschreibung
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 )))
212
213 \\
214
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".
217 {{/note}}
218
219 Aufgabenauswertung:
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 {{info title="Hinweis"}}
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 {{/info}}
296
297 {{error}}
298 Folgende Parameter sind seit **ONYX Version 5.15 (% style="color: rgb(255,0,0);" %)__nicht mehr__ (%%)**verfügbar:
299 {{/error}}
300
301 * showSolution [**true** |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)
302 * showFeedback [**true** |false] - Ersetzt durch testShowFeedback sowie itemShowFeedback
303 )))
304 )))
305
306 === ReturnValue registerTest ===
307
308 (% class="wrapped" %)
309 |(((
310 Long
311 )))|(((
312 **Einer der folgenden Werte:**
313
314 * WAITING(0) – Warten auf Teststart
315 * WORKING(1) – bearbeitet Test
316 * FINISHED(2) – hat Test abgegeben
317 * RESUME_ALLOWED(3) – Fortsetzen erlaubt
318 * NOT_ENTERED(4) – hat Test noch nicht betreten
319 * CANCELED(5) – hat Testbearbeitung abgebrochen
320 * RESUME_REQUESTED(6) – möchte fortsetzen
321 * RESUMED(7) – hat fortgesetzt
322 * DISCONNECTED(8) – Client nicht (mehr) erreichbar
323 * SUSPENDED(9) – Testbearbeitung unterbrochen
324 * RESUME_SUSPENDED(10) – unterbrochene Bearbeitung fortgesetzt
325 * OK(42) – OK
326 )))
327 |(((
328 \\
329 )))|(((
330 **Fehlercodes:**
331
332 * ERROR_RETURN_RESULTS(0xFF01)
333 * ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)
334 * ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)
335 * ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)
336 * ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)
337 * ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)
338 * ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)
339 * UNKNOWN(-1)
340 )))
341
342 == Anmeldung eines Studenten ==
343
344 Nach Anmeldung eines Test können Studenten diesen nutzen. Dazu müssen auch diese angemeldet werden.
345
346 {{code title="Anmeldung"}}
347 @WebMethod(operationName = „registerStudent")
348 public Long registerStudent(
349 @WebParam(name = „testSessionId", partName = „testSessionId") final Long test
350 SessionId,
351 @WebParam(name = „studentId", partName = „studentId") final Long studentId,
352 @WebParam(name = „payload", partName = „payload") final byte[] payload,
353 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
354 }
355 {{/code}}
356
357 === Parameter registerStudent ===
358
359 (% class="wrapped" %)
360 |(((
361 testSessionId
362 )))|(((
363 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).
364 )))
365 |(((
366 studentId
367 )))|(((
368 Eindeutige Kennung für Testteilnehmer. Diese wird von ONYX zurück gemeldet, wenn Statusänderungen oder Ergebnisse übertragen werden.
369 )))
370 |(% colspan="1" %)(% colspan="1" %)
371 (((
372 payload
373 )))|(% colspan="1" %)(% colspan="1" %)
374 (((
375 Optional. Resultate für den Teilnehmer (bspw. im Fall der Fortsetzung von unterbrochenen Tests)
376 )))
377 |(% colspan="1" %)(% colspan="1" %)
378 (((
379 parameters
380 )))|(% colspan="1" %)(% colspan="1" %)
381 (((
382 Liste von Parametern zur Teststeuerung (alle optional, fett gedruckt = Standard):
383
384 * language [**de**|en|fr|es] Sprache des Benutzerinterfaces von ONYX.
385 * status: Initialer Status des Teilnehmers (aktuell wird nur RESUME_SUSPENDED(10) unterstützt).
386 )))
387
388 === ReturnValue registerStudent ===
389
390 (% class="wrapped" %)
391 |(((
392 Long
393 )))|(((
394 Einer der Werte wie unter Anmeldung eines Tests beschrieben.
395 )))
396
397 == Teststeuerung ==
398
399 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.
400
401 {{code title="Teststeuerung"}}
402 @WebMethod(operationName = „testControl")
403 public Long testControl(
404 @WebParam(name = „testSessionId") final Long testSessionId,
405 @WebParam(name = „studentIds") final StudentIdsWrapper students,
406 @WebParam(name = „status") final Integer status,
407 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
408 }
409 {{/code}}
410
411 === Parameter testControl ===
412
413 (% class="wrapped" %)
414 |(((
415 testSessionId
416 )))|(((
417 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).
418 )))
419 |(((
420 studentIds
421 )))|(((
422 Liste eindeutiger Kennungen für Testteilnehmer.
423 )))
424 |(((
425 status
426 )))|(((
427 Neu zu setzender Status für die gegebenen Testteilnehmer.
428 )))
429 |(((
430 parameters
431 )))|(((
432 Liste von Parametern zur Teststeuerung (alle optional):
433
434 * addTime: Time in minutes to add to the test session.
435 )))
436
437 === ReturnValue testControl ===
438
439 (% class="wrapped" %)
440 |(((
441 Long
442 )))|(((
443 Einer der Werte wie unter Anmeldung eines Tests beschrieben.
444 )))
445
446 == Speicher aufräumen ==
447
448 Haben alle Teilnehmer den Test durchgeführt, so kann die Lernplattform ONYX mitteilen, dass dieses den Test deregistrieren und den Speicher aufräumen kann.
449
450 {{code title="Teststeuerung"}}
451 @WebMethod(operationName = „deregisterTest")
452 public Long deregisterTest(
453 @WebParam(name = „testSessionId") final Long testSessionId,
454 @WebParam(name = „providerId") final String providerId,
455 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
456 }
457 {{/code}}
458
459 === Parameter deregisterTest ===
460
461 (% class="wrapped" %)
462 |(((
463 testSessionId
464 )))|(((
465 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).
466 )))
467 |(((
468 providerId
469 )))|(((
470 Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.
471 )))
472 |(((
473 parameters
474 )))|(((
475 Aktuell nicht verwendet.
476 )))
477
478 === ReturnValue deregisterTest ===
479
480 (% class="wrapped" %)
481 |(((
482 Long
483 )))|(((
484 Einer der Werte wie unter Anmeldung eines Tests beschrieben.
485 )))
486
487 == Anzeige des Tests ==
488
489
490 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 wieder gegeben. 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:
491
492 {{note title="URL"}}
493 [[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
494 Lediglich die URL im unteren Teil der WSDL muss an die Lernplattform angepasst werden.
495 {{/note}}
496
497 == Konfiguration des ONYX Players ==
498
499 Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen.
500
501 \\
502
503 {{error title="Sicherheit"}}
504 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.
505 {{/error}}
506 {{/layout-cell}}
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 {{/layout}}
536 {{/sv-translation}}
537
538 {{sv-translation language="en"}}
539 {{layout}}
540 {{layout-section ac:type="two_right_sidebar"}}
541 {{layout-cell}}
542 The API between the ONYX Player and the LMS consists of the following components:
543
544 * Registration of a test in the ONYX Player through the LMS
545 * Registration of a participant in the ONYX Player through the LMS
546 * Test control
547 * Return of test results to the LMS by the ONYX Player
548 * Deregistration of the test
549 {{/layout-cell}}
550
551 {{layout-cell}}
552 {{scroll-ignore}}
553 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
554
555
556 {{toc/}}
557 {{/panel}}
558 {{/scroll-ignore}}
559 {{/layout-cell}}
560 {{/layout-section}}
561
562 {{layout-section ac:type="single"}}
563 {{layout-cell}}
564 == General information ==
565
566 The ONYX Player defines a web service, which can be reached via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
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"]]
569
570 == Registration of a test ==
571
572
573 Before participants can take tests, the tests need to be registered with ONYX.
574
575 {{code language="xml" title="Registration"}}
576 @WebMethod(operationName = „registerTest")
577 public Long registerTest(
578 @WebParam(name = „testSessionId") final Long testSessionId,
579 @WebParam(name = „providerId") final String providerId,
580 @WebParam(name = „contentPackage") final byte[] contentPackage,
581 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
582 }
583 {{/code}}
584
585 === Parameter registerTest ===
586
587 (% class="wrapped" %)
588 |(((
589 testSessionId
590 )))|(((
591 Unique ID assigned by the LMS, which serves as an identifier for this test.
592 )))
593 |(((
594 providerId
595 )))|(((
596 Identification under which the requesting LMS is registrated with ONYX.
597 )))
598 |(((
599 contentPackage
600 )))|(((
601 The IMS QTI v2.1 CP (zip file as byte array).
602 )))
603 |(((
604 parameters
605 )))|(((
606 (% class="content-wrapper" %)
607 (((
608 (% class="TableParagraph" %)
609 List of parameters to control the test. Additional parameters can be set for individual participants ( registerStudent ).
610
611 (% class="TableParagraph" %)
612 All parameters are optional. The default setting is shown in bold.
613
614 {{info title="Note"}}
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"]]".
616 {{/info}}
617
618 * showSolution [true|**false**] Should the correct answer be displayed to the user?
619 * isSynchronized [true|**false**] Is it a test in the exam mode for which the test start is synchronised for all users?
620 * continuationAllowed [true|**false**] Is it allowed to continue the test session at any time? If not, each test start must be performed via the LMS.
621 * suspendAllowed [true|f**alse**] Is it is allowed to interrupt the test? If this is the case, the additional button "Suspend" will be displayed.
622 * Templateid: Currently only supported: onyxwithoutnav - hides the navigation tree.
623 * dontShowItemTitles [true|**false**]: Are the titles of the tasks supposed to be displayed?
624 \\
625
626 {{note}}
627 The following parameters are available since **version 5.15:**
628 {{/note}}
629
630 * testShowScore [**true**|false] A test completion page is displayed to the participant after the submission of the test, which can contain all determined point values, such as the total test score and the points per test section.
631 * testShowPassed [**true**|false] A test completion page is displayed to the participant after the submission of the test, which can contain information about the passed status of this test. Default is the value given in testShowScore or its default.
632 * testShowFeedback [**true**|false] A test completion page is displayed to the participant after the submission of the test, which can contain the test feedback defined by the author.
633 * itemShowFeedback [**true**|false] The task feedback defined by the author is displayed to the participant after the task has been answered.
634 * itemShowScore [**true**|false] The participant is shown the number of points achieved for the task after the submission of their answer.
635 * itemShowCorrect [**true**|false] The participant is shown whether their answer was correct or wrong after the submission of their answer. Implies itemShowScore=true.
636 * itemShowSolution [**true**|false] The participant is shown the correct solution after the submission of their answer. Implies itemShowCorrect=true and itemShowScore=true.
637 \\
638
639 {{info title="Note"}}
640 If no evaluation information is displayed on task level (itemShowFeedback = false, itemShowScore = false, itemShowCorrect = false, itemShowSolution = false), the participant will not be shown the button to submit the task during the test implementation. The answers are saved at any time and assessed after the submission of the test.
641 {{/info}}
642
643 {{error}}
644 The following parameters are (% style="color: rgb(255,0,0);" %)**__no longer__ **(%%)available since **ONYX** **version 5.15**:
645 {{/error}}
646
647 * showSolution [**true **|false] - Replaced by testShowScore, testShowPassed, itemShowSolution (including implications)
648 * showFeedback [**true **|false] - Replaced by testShowFeedback and itemShowFeedback
649 )))
650 )))
651
652 === ReturnValue registerTest ===
653
654 (% class="wrapped" %)
655 |(((
656 Long
657 )))|(((
658 **One of the following values:**
659
660 * WAITING(0) – waiting for test start
661 * WORKING(1) – is processing the test
662 * FINISHED(2) – handed in the test
663 * RESUME_ALLOWED(3) – resuming allowed
664 * NOT_ENTERED(4) – has not yet entered the test
665 * CANCELED(5) – has interrupted the testing process
666 * RESUME_REQUESTED(6) – wants to continue
667 * RESUMED(7) – has continued
668 * DISCONNECTED(8) – client is not / no longer reachable
669 * SUSPENDED(9) – testing process has been interrupted
670 * RESUME_SUSPENDED(10) – interrupted testing is continued
671 * OK(42) – OK
672 )))
673 |(((
674 \\
675 )))|(((
676 **Error codes:**
677
678 * ERROR_RETURN_RESULTS(0xFF01)
679 * ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)
680 * ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)
681 * ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)
682 * ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)
683 * ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)
684 * ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)
685 * UNKNOWN(-1)
686 )))
687
688 == Registration of a student ==
689
690 After a test has been registered, students can use it. Provided that they have been registered themselves.
691
692 {{code title="Registration"}}
693 @WebMethod(operationName = „registerStudent")
694 public Long registerStudent(
695 @WebParam(name = „testSessionId", partName = „testSessionId") final Long test
696 SessionId,
697 @WebParam(name = „studentId", partName = „studentId") final Long studentId,
698 @WebParam(name = „payload", partName = „payload") final byte[] payload,
699 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
700 }
701 {{/code}}
702
703 === Parameter registerStudent ===
704
705 (% class="wrapped" %)
706 |(((
707 testSessionId
708 )))|(((
709 (% class="TableParagraph" %)
710 Unique ID assigned by the LMS, which serves as an identifier for the test (cf. registerTest).
711 )))
712 |(((
713 studentId
714 )))|(((
715 (% class="TableParagraph" %)
716 Unique identification for test participants. ID will be returned by ONYX when status changes or results are transmitted.
717 )))
718 |(% colspan="1" %)(% colspan="1" %)
719 (((
720 payload
721 )))|(% colspan="1" %)(% colspan="1" %)
722 (((
723 (% class="TableParagraph" %)
724 Optional. Results for the participant (e.g. if interrupted tests are continued)
725 )))
726 |(% colspan="1" %)(% colspan="1" %)
727 (((
728 parameters
729 )))|(% colspan="1" %)(% colspan="1" %)
730 (((
731 (% class="TableParagraph" %)
732 List of parameters to control the test (all optional, bold = default):
733
734 * Language [**de**|en|fr|es] Language of the ONYX user interface.
735 * Status: Initial status of the participant (currently only RESUME_SUSPENDED(10) is supported).
736 )))
737
738 === ReturnValue registerStudent ===
739
740 (% class="wrapped" %)
741 |(((
742 Long
743 )))|(((
744 One of the values as described under registration of a test.
745 )))
746
747 == Test control ==
748
749 For registered test participants, the status can be controlled by the LMS, for example, to start, finish, or continue the test after its release by the tutor.
750
751 {{code title="Test control"}}
752 @WebMethod(operationName = „testControl")
753 public Long testControl(
754 @WebParam(name = „testSessionId") final Long testSessionId,
755 @WebParam(name = „studentIds") final StudentIdsWrapper students,
756 @WebParam(name = „status") final Integer status,
757 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
758 }
759 {{/code}}
760
761 === Parameter testControl ===
762
763 (% class="wrapped" %)
764 |(((
765 testSessionId
766 )))|(((
767 Unique ID assigned by the LMS, which serves as an identifier for the test (cf. registerTest).
768 )))
769 |(((
770 studentIds
771 )))|(((
772 List of unique IDs for test participants.
773 )))
774 |(((
775 status
776 )))|(((
777 New status to be set for the given test participants.
778 )))
779 |(((
780 parameters
781 )))|(((
782 List of parameters to control the test (all optional):
783
784 * addTime: Time in minutes to add to the test session.
785 )))
786
787 === ReturnValue testControl ===
788
789 (% class="wrapped" %)
790 |(((
791 Long
792 )))|(((
793 One of the values as described under registration of a test.
794 )))
795
796 == Clear storage ==
797
798 When all participants have finished the test, the LMS can inform ONYX to deregister the test and to clear the storage.
799
800 {{code title="Test control"}}
801 @WebMethod(operationName = „deregisterTest")
802 public Long deregisterTest(
803 @WebParam(name = „testSessionId") final Long testSessionId,
804 @WebParam(name = „providerId") final String providerId,
805 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
806 }
807 {{/code}}
808
809 === Parameter deregisterTest ===
810
811 (% class="wrapped" %)
812 |(((
813 testSessionId
814 )))|(((
815 Unique ID assigned by the LMS, which serves as an identifier for the test (cf. registerTest).
816 )))
817 |(((
818 providerId
819 )))|(((
820 Identification under which the requesting LMS is registered with ONYX.
821 )))
822 |(((
823 parameters
824 )))|(((
825 Currently not used.
826 )))
827
828 === ReturnValue deregisterTest ===
829
830 (% class="wrapped" %)
831 |(((
832 Long
833 )))|(((
834 One of the values as described under registration of a test.
835 )))
836
837 == Test display ==
838
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
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"]]
843 Only the URL in the lower part of the WSDL has to be adapted to the LMS.
844 {{/note}}
845
846 == Configuration of the ONYX Player ==
847
848 The ONYX Player uses a configuration file named onyxplugin.config.xml, which must be stored in the Java Classpath.
849
850 {{error title="Security"}}
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 {{/error}}
853 {{/layout-cell}}
854 {{/layout-section}}
855 {{/layout}}
856 {{/sv-translation}}