Zum Inhalt springen

Wiki-Quellcode von ONYX Player Interface

Version 197.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}}
5 \\
6 {{/layout-cell}}
7 {{/layout-section}}
8
9 {{layout-section ac:type="two_right_sidebar"}}
10 {{layout-cell}}
11 Die Schnittstelle zwischen ONYX Player und der Lernplattform besteht aus folgenden Komponenten:
12
13 * Anmeldung eines Tests durch die Lernplattform beim ONYX Player
14 * Anmeldung eines Teilnehmers durch die Lernplattform beim ONYX Player
15 * Teststeuerung
16 * Ergebnisrückgabe der Testresultate durch den ONYX Player an die Lernplattform
17 * Abmeldung des Tests
18 {{/layout-cell}}
19
20 {{layout-cell}}
21 (% class="auto-cursor-target" %)
22 \\
23
24 {{scroll-ignore}}(% class="auto-cursor-target" %)
25 \\
26
27 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
28
29
30 {{toc/}}
31 {{/panel}}
32
33 (% class="auto-cursor-target" %)
34 \\{{/scroll-ignore}}
35 \\
36
37 \\
38 {{/layout-cell}}
39 {{/layout-section}}
40
41 {{layout-section ac:type="single"}}
42 {{layout-cell}}
43 == Allgemeines ==
44
45 Der ONYX Player definiert einen WebService. Dieser ist über die URL **<ONYXWebPlayer-URL>/onyx/onyxexamservices** erreichbar.
46
47 Link zur WSDL der öffentlichen Demo-Runtime: (% class="nolink" %)**http:~/~/demo.bps-system.de/onyx/onyxexamservices?wsdl**
48
49 == Anmeldung eines Tests ==
50
51 Bevor Teilnehmer Tests belegen können, müssen diese zuerst bei ONYX angemeldet werden.
52
53 {{code language="xml" title="Anmeldung"}}
54 @WebMethod(operationName = „registerTest")
55 public Long registerTest(
56 @WebParam(name = „testSessionId") final Long testSessionId,
57 @WebParam(name = „providerId") final String providerId,
58 @WebParam(name = „contentPackage") final byte[] contentPackage,
59 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
60 }
61 {{/code}}
62
63 === Parameter registerTest ===
64
65 (% class="wrapped" %)
66 |(((
67 testSessionId
68 )))|(((
69 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für diesen Test
70
71 darstellt.
72 )))
73 |(((
74 providerId
75 )))|(((
76 Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.
77 )))
78 |(((
79 contentPackage
80 )))|(((
81 Das IMS QTI v2.1 CP (ZIP-File als byte-Array).
82 )))
83 |(((
84 parameters
85 )))|(((
86 (% class="content-wrapper" %)
87 (((
88 Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden (registerStudent).
89
90 Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.
91
92 (% class="wrapped" %)
93 |=(((
94 Parameter
95 )))|=(((
96 Beschreibung
97 )))
98 |(% colspan="1" %)(% colspan="1" %)
99 (((
100 showSolution [true|**false**]
101 )))|(% colspan="1" %)(% colspan="1" %)
102 (((
103 Soll dem Nutzer die korrekte Antwort anzeigbar sein?
104 )))
105 |(% colspan="1" %)(% colspan="1" %)
106 (((
107 isSynchronized [true|**false**]
108 )))|(% colspan="1" %)(% colspan="1" %)
109 (((
110 Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?
111 )))
112 |(% colspan="1" %)(% colspan="1" %)
113 (((
114 continuationAllowed [true|**false**]
115 )))|(% colspan="1" %)(% colspan="1" %)
116 (((
117 Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.
118 )))
119 |(% colspan="1" %)(% colspan="1" %)
120 (((
121 suspendAllowed [true|**false**]
122 )))|(% colspan="1" %)(% colspan="1" %)
123 (((
124 Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.
125 )))
126 |(% colspan="1" %)(% colspan="1" %)
127 (((
128 Templateid
129 )))|(% colspan="1" %)(% colspan="1" %)
130 (((
131 Derzeit einzig unterstützt: onyxwithoutnav - führt zur Nichtanzeige des Navigationsbaumes.
132 )))
133 |(% colspan="1" %)(% colspan="1" %)
134 (((
135 dontShowItemTitles (% class="error" %)[true|**false**]
136 )))|(% colspan="1" %)(% colspan="1" %)
137 (((
138 (% class="error" %)Sollen die Titel der Aufgaben nicht angezeigt werden?
139 )))
140
141 \\
142
143 {{note}}
144 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".
145 {{/note}}
146
147 Aufgabenauswertung:
148
149 (% class="wrapped" %)
150 |=(((
151 Parameter
152 )))|=(((
153 Beschreibung
154 )))
155 |(((
156 itemShowFeedback [**true**|false]
157 )))|(((
158 Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.
159 )))
160 |(% colspan="1" %)(% colspan="1" %)
161 (((
162 itemShowMaxScore [**true**|false]
163 )))|(% colspan="1" %)(% colspan="1" %)
164 (((
165 Dem Teilnehmer wird die maximal mögliche Punktzahl zu jeder Aufgabe angezeigt.
166 )))
167 |(% colspan="1" %)(% colspan="1" %)
168 (((
169 itemShowScore [**true**|false]
170 )))|(% colspan="1" %)(% colspan="1" %)
171 (((
172 Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat.
173 )))
174 |(% colspan="1" %)(% colspan="1" %)
175 (((
176 itemShowCorrect [**true**|false]
177 )))|(% colspan="1" %)(% colspan="1" %)
178 (((
179 Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.
180 )))
181 |(% colspan="1" %)(% colspan="1" %)
182 (((
183 itemShowSolution [**true**|false]
184 )))|(% colspan="1" %)(% colspan="1" %)
185 (((
186 Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.
187 )))
188
189 Testauswertung:
190
191 (% class="wrapped" %)
192 |=(((
193 Parameter
194 )))|=(((
195 Beschreibung
196 )))
197 |(((
198 testShowFeedback [**true**|false]
199 )))|(((
200 Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.
201 )))
202 |(% colspan="1" %)(% colspan="1" %)
203 (((
204 testShowScore [**true**|false]
205 )))|(% colspan="1" %)(% colspan="1" %)
206 (((
207 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.
208 )))
209 |(% colspan="1" %)(% colspan="1" %)
210 (((
211 testShowPassed (% class="error" %)[**true**|false]
212 )))|(% colspan="1" %)(% colspan="1" %)
213 (((
214 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.
215 )))
216
217 \\
218
219 {{info title="Hinweis"}}
220 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.
221 {{/info}}
222
223 (% class="auto-cursor-target" %)
224 \\
225
226 {{error}}
227 Folgende Parameter sind seit **ONYX Version 5.15 **(% style="color: rgb(255,0,0);" %)__nicht mehr__ (%%)verfügbar:
228 {{/error}}
229
230 * showSolution [**true** |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)
231 * showFeedback [**true** |false] - Ersetzt durch testShowFeedback sowie itemShowFeedback
232 )))
233 )))
234
235 === ReturnValue registerTest ===
236
237 (% class="wrapped" %)
238 |(((
239 Long
240 )))|(((
241 **Einer der folgenden Werte:**
242
243 * WAITING(0) – Warten auf Teststart
244 * WORKING(1) – bearbeitet Test
245 * FINISHED(2) – hat Test abgegeben
246 * RESUME_ALLOWED(3) – Fortsetzen erlaubt
247 * NOT_ENTERED(4) – hat Test noch nicht betreten
248 * CANCELED(5) – hat Testbearbeitung abgebrochen
249 * RESUME_REQUESTED(6) – möchte fortsetzen
250 * RESUMED(7) – hat fortgesetzt
251 * DISCONNECTED(8) – Client nicht (mehr) erreichbar
252 * SUSPENDED(9) – Testbearbeitung unterbrochen
253 * RESUME_SUSPENDED(10) – unterbrochene Bearbeitung fortgesetzt
254 * OK(42) – OK
255 )))
256 |(((
257 \\
258 )))|(((
259 **Fehlercodes:**
260
261 * ERROR_RETURN_RESULTS(0xFF01)
262 * ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)
263 * ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)
264 * ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)
265 * ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)
266 * ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)
267 * ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)
268 * UNKNOWN(-1)
269 )))
270
271 == Anmeldung eines Studenten ==
272
273 Nach Anmeldung eines Test können Studenten diesen nutzen. Dazu müssen auch diese angemeldet werden.
274
275 {{code title="Anmeldung"}}
276 @WebMethod(operationName = „registerStudent")
277 public Long registerStudent(
278 @WebParam(name = „testSessionId", partName = „testSessionId") final Long test
279 SessionId,
280 @WebParam(name = „studentId", partName = „studentId") final Long studentId,
281 @WebParam(name = „payload", partName = „payload") final byte[] payload,
282 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
283 }
284 {{/code}}
285
286 === Parameter registerStudent ===
287
288 (% class="wrapped" %)
289 |(((
290 testSessionId
291 )))|(((
292 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).
293 )))
294 |(((
295 studentId
296 )))|(((
297 Eindeutige Kennung für Testteilnehmer. Diese wird von ONYX zurück gemeldet, wenn Statusänderungen oder Ergebnisse übertragen werden.
298 )))
299 |(% colspan="1" %)(% colspan="1" %)
300 (((
301 payload
302 )))|(% colspan="1" %)(% colspan="1" %)
303 (((
304 Optional. Resultate für den Teilnehmer (bspw. im Fall der Fortsetzung von unterbrochenen Tests)
305 )))
306 |(% colspan="1" %)(% colspan="1" %)
307 (((
308 parameters
309 )))|(% colspan="1" %)(% colspan="1" %)
310 (((
311 Liste von Parametern zur Teststeuerung (alle optional, fett gedruckt = Standard):
312
313 * language [**de**|en|fr|es] Sprache des Benutzerinterfaces von ONYX.
314 * status: Initialer Status des Teilnehmers (aktuell wird nur RESUME_SUSPENDED(10) unterstützt).
315 )))
316
317 === ReturnValue registerStudent ===
318
319 (% class="wrapped" %)
320 |(((
321 Long
322 )))|(((
323 Einer der Werte wie unter Anmeldung eines Tests beschrieben.
324 )))
325
326 == Teststeuerung ==
327
328 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.
329
330 {{code title="Teststeuerung"}}
331 @WebMethod(operationName = „testControl")
332 public Long testControl(
333 @WebParam(name = „testSessionId") final Long testSessionId,
334 @WebParam(name = „studentIds") final StudentIdsWrapper students,
335 @WebParam(name = „status") final Integer status,
336 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
337 }
338 {{/code}}
339
340 === Parameter testControl ===
341
342 (% class="wrapped" %)
343 |(((
344 testSessionId
345 )))|(((
346 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).
347 )))
348 |(((
349 studentIds
350 )))|(((
351 Liste eindeutiger Kennungen für Testteilnehmer.
352 )))
353 |(((
354 status
355 )))|(((
356 Neu zu setzender Status für die gegebenen Testteilnehmer.
357 )))
358 |(((
359 parameters
360 )))|(((
361 Liste von Parametern zur Teststeuerung (alle optional):
362
363 * addTime: Time in minutes to add to the test session.
364 )))
365
366 === ReturnValue testControl ===
367
368 (% class="wrapped" %)
369 |(((
370 Long
371 )))|(((
372 Einer der Werte wie unter Anmeldung eines Tests beschrieben.
373 )))
374
375 == Speicher aufräumen ==
376
377 Haben alle Teilnehmer den Test durchgeführt, so kann die Lernplattform ONYX mitteilen, dass dieses den Test deregistrieren und den Speicher aufräumen kann.
378
379 {{code title="Teststeuerung"}}
380 @WebMethod(operationName = „deregisterTest")
381 public Long deregisterTest(
382 @WebParam(name = „testSessionId") final Long testSessionId,
383 @WebParam(name = „providerId") final String providerId,
384 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
385 }
386 {{/code}}
387
388 === Parameter deregisterTest ===
389
390 (% class="wrapped" %)
391 |(((
392 testSessionId
393 )))|(((
394 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).
395 )))
396 |(((
397 providerId
398 )))|(((
399 Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.
400 )))
401 |(((
402 parameters
403 )))|(((
404 Aktuell nicht verwendet.
405 )))
406
407 === ReturnValue deregisterTest ===
408
409 (% class="wrapped" %)
410 |(((
411 Long
412 )))|(((
413 Einer der Werte wie unter Anmeldung eines Tests beschrieben.
414 )))
415
416 == Anzeige des Tests ==
417
418
419 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:
420
421 {{note title="URL"}}
422 [[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
423 Lediglich die URL im unteren Teil der WSDL muss an die Lernplattform angepasst werden.
424 {{/note}}
425
426 == Konfiguration des ONYX Players ==
427
428 Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen.
429
430 \\
431
432 {{error title="Sicherheit"}}
433 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.
434 {{/error}}
435
436 (% class="auto-cursor-target" %)
437 \\
438 {{/layout-cell}}
439 {{/layout-section}}
440
441 {{layout-section ac:type="single"}}
442 {{layout-cell}}
443 ----
444 {{/layout-cell}}
445 {{/layout-section}}
446
447 {{layout-section ac:type="single"}}
448 {{layout-cell}}
449 \\
450
451 {{column}}
452 (% class="auto-cursor-target" %)
453 Bei Fragen zur Konfiguration oder zum Einsatz der ONYX-Testsuite in anderen Plattformen helfen wir Ihnen gern weiter.
454
455 {{panel title="BPS Bildungsportal Sachsen GmbH"}}
456 **[[image:attach:BPS-Logo-web.png]]
457 **
458
459 **Tel.: **+49 (0) 371 666 2739 0(% style="color: rgb(89,89,89);" %)**
460 E-Mail: **(%%)[[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]]
461
462 Gern können Sie auch unser (% style="text-align: left;" %)**[[Kontaktformular>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]] **(%%)nutzen.
463 {{/panel}}
464
465 (% class="auto-cursor-target" %)
466 \\
467 {{/column}}
468
469 (% class="auto-cursor-target" %)
470 \\
471 {{/layout-cell}}
472 {{/layout-section}}
473 {{/layout}}
474 {{/sv-translation}}
475
476 {{sv-translation language="en"}}
477 {{layout}}
478 {{layout-section ac:type="two_right_sidebar"}}
479 {{layout-cell}}
480 The API between the ONYX Player and the LMS consists of the following components:
481
482 * Registration of a test in the ONYX Player through the LMS
483 * Registration of a participant in the ONYX Player through the LMS
484 * Test control
485 * Return of test results to the LMS by the ONYX Player
486 * Deregistration of the test
487 {{/layout-cell}}
488
489 {{layout-cell}}
490 {{scroll-ignore}}
491 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
492
493
494 {{toc/}}
495 {{/panel}}
496 {{/scroll-ignore}}
497 {{/layout-cell}}
498 {{/layout-section}}
499
500 {{layout-section ac:type="single"}}
501 {{layout-cell}}
502 == General information ==
503
504 The ONYX Player defines a web service, which can be reached via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
505
506 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"]]
507
508 == Registration of a test ==
509
510
511 Before participants can take tests, the tests need to be registered with ONYX.
512
513 {{code language="xml" title="Registration"}}
514 @WebMethod(operationName = „registerTest")
515 public Long registerTest(
516 @WebParam(name = „testSessionId") final Long testSessionId,
517 @WebParam(name = „providerId") final String providerId,
518 @WebParam(name = „contentPackage") final byte[] contentPackage,
519 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
520 }
521 {{/code}}
522
523 === Parameter registerTest ===
524
525 (% class="wrapped" %)
526 |(((
527 testSessionId
528 )))|(((
529 Unique ID assigned by the LMS, which serves as an identifier for this test.
530 )))
531 |(((
532 providerId
533 )))|(((
534 Identification under which the requesting LMS is registrated with ONYX.
535 )))
536 |(((
537 contentPackage
538 )))|(((
539 The IMS QTI v2.1 CP (zip file as byte array).
540 )))
541 |(((
542 parameters
543 )))|(((
544 (% class="content-wrapper" %)
545 (((
546 (% class="TableParagraph" %)
547 List of parameters to control the test. Additional parameters can be set for individual participants ( registerStudent ).
548
549 (% class="TableParagraph" %)
550 All parameters are optional. The default setting is shown in bold.
551
552 |=(((
553 \\
554 )))|=(((
555 \\
556 )))
557 |(((
558 showSolution [true|**false**]
559 )))|(((
560 Should the correct answer be displayed to the user?
561 )))
562 |(((
563 isSynchronized [true|**false**]
564 )))|(((
565 Is it a test in the exam mode for which the test start is synchronised for all users?
566 )))
567 |(((
568 continuationAllowed [true|**false**]
569 )))|(((
570 Is it allowed to continue the test session at any time? If not, each test start must be performed via the LMS.
571 )))
572 |(% colspan="1" %)(% colspan="1" %)
573 (((
574 suspendAllowed [true|f**alse**]
575 )))|(% colspan="1" %)(% colspan="1" %)
576 (((
577 Is it is allowed to interrupt the test? If this is the case, the additional button "Suspend" will be displayed.
578 )))
579 |(% colspan="1" %)(% colspan="1" %)
580 (((
581 Templateid:
582 )))|(% colspan="1" %)(% colspan="1" %)
583 (((
584 Currently only supported: onyxwithoutnav - hides the navigation tree.
585 )))
586 |(% colspan="1" %)(% colspan="1" %)
587 (((
588 dontShowItemTitles [true|**false**]
589 )))|(% colspan="1" %)(% colspan="1" %)
590 (((
591 Are the titles of the tasks supposed to be displayed?
592 )))
593
594 \\
595
596 {{note}}
597 The following parameters are available since **version 5.15:**
598 {{/note}}
599
600 Item
601
602 |=(((
603 Parameter
604 )))|=(((
605 Description
606 )))
607 |(((
608 itemShowFeedback [**true**|false]
609 )))|(((
610 The task feedback defined by the author is displayed to the participant after the task has been answered.
611 )))
612 |(((
613 itemShowMaxScore [**true**|false]
614 )))|(((
615 Dem Teilnehmer wird die maximal mögliche Punktzahl zu jeder Aufgabe angezeigt.
616 )))
617 |(% colspan="1" %)(% colspan="1" %)
618 (((
619 itemShowScore [**true**|false]
620 )))|(% colspan="1" %)(% colspan="1" %)
621 (((
622 The participant is shown the number of points achieved for the task after the submission of their answer.
623 )))
624 |(% colspan="1" %)(% colspan="1" %)
625 (((
626 itemShowCorrect [**true**|false]
627 )))|(% colspan="1" %)(% colspan="1" %)
628 (((
629 The participant is shown whether their answer was correct or wrong after the submission of their answer. Implies itemShowScore=true.
630 )))
631 |(% colspan="1" %)(% colspan="1" %)
632 (((
633 itemShowSolution [**true**|false]
634 )))|(% colspan="1" %)(% colspan="1" %)
635 (((
636 The participant is shown the correct solution after the submission of their answer. Implies itemShowCorrect=true and itemShowScore=true.
637 )))
638
639 Test
640
641 |=(((
642 Parameter
643 )))|=(((
644 Description
645 )))
646 |(((
647 testShowFeedback [**true**|false]
648 )))|(((
649 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.
650
651 \\
652 )))
653 |(((
654 testShowScore [**true**|false]
655 )))|(((
656 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.
657 )))
658 |(((
659 testShowPassed [**true**|false]
660 )))|(((
661 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.
662 )))
663
664 \\
665
666 {{info title="Note"}}
667 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.
668 {{/info}}
669
670 {{error}}
671 The following parameters are (% style="color: rgb(255,0,0);" %)__no longer__ (%%)available since **ONYX** **version 5.15**:
672 {{/error}}
673
674 * showSolution [**true **|false] - Replaced by testShowScore, testShowPassed, itemShowSolution (including implications)
675 * showFeedback [**true **|false] - Replaced by testShowFeedback and itemShowFeedback
676 )))
677 )))
678
679 === ReturnValue registerTest ===
680
681 (% class="wrapped" %)
682 |(((
683 Long
684 )))|(((
685 **One of the following values:**
686
687 * WAITING(0) – waiting for test start
688 * WORKING(1) – is processing the test
689 * FINISHED(2) – handed in the test
690 * RESUME_ALLOWED(3) – resuming allowed
691 * NOT_ENTERED(4) – has not yet entered the test
692 * CANCELED(5) – has interrupted the testing process
693 * RESUME_REQUESTED(6) – wants to continue
694 * RESUMED(7) – has continued
695 * DISCONNECTED(8) – client is not / no longer reachable
696 * SUSPENDED(9) – testing process has been interrupted
697 * RESUME_SUSPENDED(10) – interrupted testing is continued
698 * OK(42) – OK
699 )))
700 |(((
701 \\
702 )))|(((
703 **Error codes:**
704
705 * ERROR_RETURN_RESULTS(0xFF01)
706 * ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)
707 * ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)
708 * ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)
709 * ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)
710 * ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)
711 * ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)
712 * UNKNOWN(-1)
713 )))
714
715 == Registration of a student ==
716
717 After a test has been registered, students can use it. Provided that they have been registered themselves.
718
719 {{code title="Registration"}}
720 @WebMethod(operationName = „registerStudent")
721 public Long registerStudent(
722 @WebParam(name = „testSessionId", partName = „testSessionId") final Long test
723 SessionId,
724 @WebParam(name = „studentId", partName = „studentId") final Long studentId,
725 @WebParam(name = „payload", partName = „payload") final byte[] payload,
726 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
727 }
728 {{/code}}
729
730 === Parameter registerStudent ===
731
732 (% class="wrapped" %)
733 |(((
734 testSessionId
735 )))|(((
736 (% class="TableParagraph" %)
737 Unique ID assigned by the LMS, which serves as an identifier for the test (cf. registerTest).
738 )))
739 |(((
740 studentId
741 )))|(((
742 (% class="TableParagraph" %)
743 Unique identification for test participants. ID will be returned by ONYX when status changes or results are transmitted.
744 )))
745 |(% colspan="1" %)(% colspan="1" %)
746 (((
747 payload
748 )))|(% colspan="1" %)(% colspan="1" %)
749 (((
750 (% class="TableParagraph" %)
751 Optional. Results for the participant (e.g. if interrupted tests are continued)
752 )))
753 |(% colspan="1" %)(% colspan="1" %)
754 (((
755 parameters
756 )))|(% colspan="1" %)(% colspan="1" %)
757 (((
758 (% class="TableParagraph" %)
759 List of parameters to control the test (all optional, bold = default):
760
761 * Language [**de**|en|fr|es] Language of the ONYX user interface.
762 * Status: Initial status of the participant (currently only RESUME_SUSPENDED(10) is supported).
763 )))
764
765 === ReturnValue registerStudent ===
766
767 (% class="wrapped" %)
768 |(((
769 Long
770 )))|(((
771 One of the values as described under registration of a test.
772 )))
773
774 == Test control ==
775
776 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.
777
778 {{code title="Test control"}}
779 @WebMethod(operationName = „testControl")
780 public Long testControl(
781 @WebParam(name = „testSessionId") final Long testSessionId,
782 @WebParam(name = „studentIds") final StudentIdsWrapper students,
783 @WebParam(name = „status") final Integer status,
784 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
785 }
786 {{/code}}
787
788 === Parameter testControl ===
789
790 (% class="wrapped" %)
791 |(((
792 testSessionId
793 )))|(((
794 Unique ID assigned by the LMS, which serves as an identifier for the test (cf. registerTest).
795 )))
796 |(((
797 studentIds
798 )))|(((
799 List of unique IDs for test participants.
800 )))
801 |(((
802 status
803 )))|(((
804 New status to be set for the given test participants.
805 )))
806 |(((
807 parameters
808 )))|(((
809 List of parameters to control the test (all optional):
810
811 * addTime: Time in minutes to add to the test session.
812 )))
813
814 === ReturnValue testControl ===
815
816 (% class="wrapped" %)
817 |(((
818 Long
819 )))|(((
820 One of the values as described under registration of a test.
821 )))
822
823 == Clear storage ==
824
825 When all participants have finished the test, the LMS can inform ONYX to deregister the test and to clear the storage.
826
827 {{code title="Test control"}}
828 @WebMethod(operationName = „deregisterTest")
829 public Long deregisterTest(
830 @WebParam(name = „testSessionId") final Long testSessionId,
831 @WebParam(name = „providerId") final String providerId,
832 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
833 }
834 {{/code}}
835
836 === Parameter deregisterTest ===
837
838 (% class="wrapped" %)
839 |(((
840 testSessionId
841 )))|(((
842 Unique ID assigned by the LMS, which serves as an identifier for the test (cf. registerTest).
843 )))
844 |(((
845 providerId
846 )))|(((
847 Identification under which the requesting LMS is registered with ONYX.
848 )))
849 |(((
850 parameters
851 )))|(((
852 Currently not used.
853 )))
854
855 === ReturnValue deregisterTest ===
856
857 (% class="wrapped" %)
858 |(((
859 Long
860 )))|(((
861 One of the values as described under registration of a test.
862 )))
863
864 == Test display ==
865
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
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"]]
870 Only the URL in the lower part of the WSDL has to be adapted to the LMS.
871 {{/note}}
872
873 == Configuration of the ONYX Player ==
874
875 The ONYX Player uses a configuration file named onyxplugin.config.xml, which must be stored in the Java Classpath.
876
877 {{error title="Security"}}
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 {{/error}}
880 {{/layout-cell}}
881 {{/layout-section}}
882
883 {{layout-section ac:type="single"}}
884 {{layout-cell}}
885 ----
886 {{/layout-cell}}
887 {{/layout-section}}
888
889 {{layout-section ac:type="single"}}
890 {{layout-cell}}
891 {{column}}
892 (% class="auto-cursor-target" %)
893 Bei Fragen zur Konfiguration oder zum Einsatz der ONYX-Testsuite in anderen Plattformen helfen wir Ihnen gern weiter.
894
895 {{panel title="BPS Bildungsportal Sachsen GmbH"}}
896 **[[image:attach:BPS-Logo-web.png]]
897 **
898
899 **Tel.: **+49 (0) 371 666 2739 0(% style="color: rgb(89,89,89);" %)**
900 E-Mail: **(%%)[[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]]
901
902 Gern können Sie auch unser (% style="text-align: left;" %)**[[Kontaktformular>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]] **(%%)nutzen.
903 {{/panel}}
904 {{/column}}
905 {{/layout-cell}}
906 {{/layout-section}}
907 {{/layout}}
908 {{/sv-translation}}