Wiki-Quellcode von ONYX Player Interface

Version 200.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}}
25 (% class="auto-cursor-target" %)
26 \\
27
28 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
29
30
31 {{toc/}}
32 {{/panel}}
33
34 (% class="auto-cursor-target" %)
35 \\
36 {{/scroll-ignore}}
37
38 (% class="auto-cursor-target" %)
39 \\
40
41 {{details hidden="true"}}
42 Diese Informationen werden nicht auf der Seite angezeigt.
43
44 (% class="wrapped" %)
45 |=(% colspan="1" %)(% colspan="1" %)
46 (((
47 Beteiligte
48 )))|(% colspan="1" %)(% colspan="1" %)
49 (((
50 (% class="content-wrapper" %)
51 (((
52 {{contributors order="name"/}}
53 )))
54 )))
55 |=(% colspan="1" %)(% colspan="1" %)
56 (((
57 Deadline
58 )))|(% colspan="1" %)(% colspan="1" %)
59 (((
60 ~/~/
61 )))
62 |=(((
63 Verantwortlicher
64 )))|(((
65 (% class="task-list" %)
66 (((
67 {{task reference="/Tasks/Task_8" status="InProgress"}}
68
69 {{/task}}
70 )))
71 )))
72 |=(% colspan="1" %)(% colspan="1" %)
73 (((
74 Status
75 )))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
76 (((
77 (% class="content-wrapper" %)
78 (((
79 {{sv-metadata default-text="Workflow Status" type="workflow-status"/}}
80 )))
81 )))
82 |=(% colspan="1" %)(% colspan="1" %)
83 (((
84 Varianten
85 )))|(% colspan="1" %)(% colspan="1" %)
86 (((
87 (% class="content-wrapper" %)
88 (((
89 {{sv-metadata default-text="Varianten" type="variants"/}}
90 )))
91 )))
92 |=(% colspan="1" %)(% colspan="1" %)
93 (((
94 Attribute
95 )))|(% colspan="1" %)(% colspan="1" %)
96 (((
97 (% class="content-wrapper" %)
98 (((
99 {{sv-metadata default-text="Attribute" type="attributes"/}}
100 )))
101 )))
102 |=(% colspan="1" %)(% colspan="1" %)
103 (((
104 Pagekey
105 )))|(% colspan="1" %)(% colspan="1" %)
106 (((
107 (% class="content-wrapper" %)
108 (((
109 {{sv-metadata default-text="Pagekey" type="pagekey"/}}
110 )))
111 )))
112 |=(% colspan="1" %)(% colspan="1" %)
113 (((
114 Autorenbemerkung
115 )))|(% colspan="1" %)(% colspan="1" %)
116 (((
117 \\
118 )))
119
120 (% class="auto-cursor-target" %)
121 \\
122 {{/details}}
123
124 \\
125
126 \\
127 {{/layout-cell}}
128 {{/layout-section}}
129
130 {{layout-section ac:type="single"}}
131 {{layout-cell}}
132 == Allgemeines ==
133
134 Der ONYX Player definiert einen WebService. Dieser ist über die URL **<ONYXWebPlayer-URL>/onyx/onyxexamservices** erreichbar.
135
136 Link zur WSDL der öffentlichen Demo-Runtime: (% class="nolink" %)**http:~/~/demo.bps-system.de/onyx/onyxexamservices?wsdl**
137
138 == Anmeldung eines Tests ==
139
140 Bevor Teilnehmer Tests belegen können, müssen diese zuerst bei ONYX angemeldet werden.
141
142 {{code language="xml" title="Anmeldung"}}
143 @WebMethod(operationName = „registerTest")
144 public Long registerTest(
145 @WebParam(name = „testSessionId") final Long testSessionId,
146 @WebParam(name = „providerId") final String providerId,
147 @WebParam(name = „contentPackage") final byte[] contentPackage,
148 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
149 }
150 {{/code}}
151
152 === Parameter registerTest ===
153
154 (% class="wrapped" %)
155 |(((
156 testSessionId
157 )))|(((
158 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für diesen Test
159
160 darstellt.
161 )))
162 |(((
163 providerId
164 )))|(((
165 Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.
166 )))
167 |(((
168 contentPackage
169 )))|(((
170 Das IMS QTI v2.1 CP (ZIP-File als byte-Array).
171 )))
172 |(((
173 parameters
174 )))|(((
175 (% class="content-wrapper" %)
176 (((
177 Liste von Parametern zur Teststeuerung. Weitere Parameter können für den einzelnen Teilnehmer festgelegt werden (registerStudent).
178
179 Alle Parameter sind optional. Die Standardeinstellung ist fett gedruckt.
180
181 (% class="wrapped" %)
182 |=(((
183 Parameter
184 )))|=(((
185 Beschreibung
186 )))
187 |(% colspan="1" %)(% colspan="1" %)
188 (((
189 showSolution [true|**false**]
190 )))|(% colspan="1" %)(% colspan="1" %)
191 (((
192 Soll dem Nutzer die korrekte Antwort anzeigbar sein?
193 )))
194 |(% colspan="1" %)(% colspan="1" %)
195 (((
196 isSynchronized [true|**false**]
197 )))|(% colspan="1" %)(% colspan="1" %)
198 (((
199 Handelt es sich um einen Test im Prüfungsmodus, bei dem der Start des Tests über alle Teilnehmer synchronisiert wird?
200 )))
201 |(% colspan="1" %)(% colspan="1" %)
202 (((
203 continuationAllowed [true|**false**]
204 )))|(% colspan="1" %)(% colspan="1" %)
205 (((
206 Ist es erlaubt, die Testsession jederzeit fortzusetzen? Wenn nicht, muss jeder Teststart über die Lernplattform durchgeführt werden.
207 )))
208 |(% colspan="1" %)(% colspan="1" %)
209 (((
210 suspendAllowed [true|**false**]
211 )))|(% colspan="1" %)(% colspan="1" %)
212 (((
213 Ist es erlaubt, den Test zu unterbrechen? In diesem Fall wird eine zusätzliche Taste „Unterbrechen“ angezeigt.
214 )))
215 |(% colspan="1" %)(% colspan="1" %)
216 (((
217 Templateid
218 )))|(% colspan="1" %)(% colspan="1" %)
219 (((
220 Derzeit einzig unterstützt: onyxwithoutnav - führt zur Nichtanzeige des Navigationsbaumes.
221 )))
222 |(% colspan="1" %)(% colspan="1" %)
223 (((
224 dontShowItemTitles (% class="error" %)[true|**false**]
225 )))|(% colspan="1" %)(% colspan="1" %)
226 (((
227 (% class="error" %)Sollen die Titel der Aufgaben nicht angezeigt werden?
228 )))
229
230 \\
231
232 {{note}}
233 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".
234 {{/note}}
235
236 Aufgabenauswertung:
237
238 (% class="wrapped" %)
239 |=(((
240 Parameter
241 )))|=(((
242 Beschreibung
243 )))
244 |(((
245 itemShowFeedback [**true**|false]
246 )))|(((
247 Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort das durch den Autor definierte Aufgaben-Feedback angezeigt.
248 )))
249 |(% colspan="1" %)(% colspan="1" %)
250 (((
251 itemShowMaxScore [**true**|false]
252 )))|(% colspan="1" %)(% colspan="1" %)
253 (((
254 Dem Teilnehmer wird die maximal mögliche Punktzahl zu jeder Aufgabe angezeigt.
255 )))
256 |(% colspan="1" %)(% colspan="1" %)
257 (((
258 itemShowScore [**true**|false]
259 )))|(% colspan="1" %)(% colspan="1" %)
260 (((
261 Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, wie viele Punkte er für die Aufgabe erreicht hat.
262 )))
263 |(% colspan="1" %)(% colspan="1" %)
264 (((
265 itemShowCorrect [**true**|false]
266 )))|(% colspan="1" %)(% colspan="1" %)
267 (((
268 Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort angezeigt, ob seine Antworten korrekt oder falsch waren. Impliziert itemShowScore=true.
269 )))
270 |(% colspan="1" %)(% colspan="1" %)
271 (((
272 itemShowSolution [**true**|false]
273 )))|(% colspan="1" %)(% colspan="1" %)
274 (((
275 Dem Teilnehmer wird nach Abgabe seiner Aufgaben-Antwort die korrekte Lösung angezeigt. Impliziert itemShowCorrect=true und itemShowScore=true.
276 )))
277
278 Testauswertung:
279
280 (% class="wrapped" %)
281 |=(((
282 Parameter
283 )))|=(((
284 Beschreibung
285 )))
286 |(((
287 testShowFeedback [**true**|false]
288 )))|(((
289 Dem Teilnehmer wird nach Testabgabe eine Testabschlusseite angezeigt, welche das durch den Autor definierte Test-Feedback (nicht) enthält.
290 )))
291 |(% colspan="1" %)(% colspan="1" %)
292 (((
293 testShowScore [**true**|false]
294 )))|(% colspan="1" %)(% colspan="1" %)
295 (((
296 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.
297 )))
298 |(% colspan="1" %)(% colspan="1" %)
299 (((
300 testShowPassed (% class="error" %)[**true**|false]
301 )))|(% colspan="1" %)(% colspan="1" %)
302 (((
303 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.
304 )))
305
306 \\
307
308 {{info title="Hinweis"}}
309 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.
310 {{/info}}
311
312 (% class="auto-cursor-target" %)
313 \\
314
315 {{error}}
316 Folgende Parameter sind seit **ONYX Version 5.15 **(% style="color: rgb(255,0,0);" %)__nicht mehr__ (%%)verfügbar:
317 {{/error}}
318
319 * showSolution [**true** |false] - Ersetzt durch testShowScore, testShowPassed, itemShowSolution (inkl. Implikationen)
320 * showFeedback [**true** |false] - Ersetzt durch testShowFeedback sowie itemShowFeedback
321 )))
322 )))
323
324 === ReturnValue registerTest ===
325
326 (% class="wrapped" %)
327 |(((
328 Long
329 )))|(((
330 **Einer der folgenden Werte:**
331
332 * WAITING(0) – Warten auf Teststart
333 * WORKING(1) – bearbeitet Test
334 * FINISHED(2) – hat Test abgegeben
335 * RESUME_ALLOWED(3) – Fortsetzen erlaubt
336 * NOT_ENTERED(4) – hat Test noch nicht betreten
337 * CANCELED(5) – hat Testbearbeitung abgebrochen
338 * RESUME_REQUESTED(6) – möchte fortsetzen
339 * RESUMED(7) – hat fortgesetzt
340 * DISCONNECTED(8) – Client nicht (mehr) erreichbar
341 * SUSPENDED(9) – Testbearbeitung unterbrochen
342 * RESUME_SUSPENDED(10) – unterbrochene Bearbeitung fortgesetzt
343 * OK(42) – OK
344 )))
345 |(((
346 \\
347 )))|(((
348 **Fehlercodes:**
349
350 * ERROR_RETURN_RESULTS(0xFF01)
351 * ERROR_MULTIPLE_REGISTER_STUDENT_WITH_SAME_ID_CALLS(0xFF02)
352 * ERROR_REGISTER_STUDENT_WITH_UNKNOWN_TEST_ID(0xFF03)
353 * ERROR_REGISTER_STUDENT_WITH_EMPTY_TEST_ID(0xFF04)
354 * ERROR_REGISTER_STUDENT_WITH_EMPTY_STUDENT_ID(0xFF05)
355 * ERROR_REGISTER_STUDENT_TO_RESUME_WITHOUT_PAYLOAD(0xFF06)
356 * ERROR_REGISTER_STUDENT_FOR_UNKNOWN_PROVIDER(0xFF07)
357 * UNKNOWN(-1)
358 )))
359
360 == Anmeldung eines Studenten ==
361
362 Nach Anmeldung eines Test können Studenten diesen nutzen. Dazu müssen auch diese angemeldet werden.
363
364 {{code title="Anmeldung"}}
365 @WebMethod(operationName = „registerStudent")
366 public Long registerStudent(
367 @WebParam(name = „testSessionId", partName = „testSessionId") final Long test
368 SessionId,
369 @WebParam(name = „studentId", partName = „studentId") final Long studentId,
370 @WebParam(name = „payload", partName = „payload") final byte[] payload,
371 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
372 }
373 {{/code}}
374
375 === Parameter registerStudent ===
376
377 (% class="wrapped" %)
378 |(((
379 testSessionId
380 )))|(((
381 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).
382 )))
383 |(((
384 studentId
385 )))|(((
386 Eindeutige Kennung für Testteilnehmer. Diese wird von ONYX zurück gemeldet, wenn Statusänderungen oder Ergebnisse übertragen werden.
387 )))
388 |(% colspan="1" %)(% colspan="1" %)
389 (((
390 payload
391 )))|(% colspan="1" %)(% colspan="1" %)
392 (((
393 Optional. Resultate für den Teilnehmer (bspw. im Fall der Fortsetzung von unterbrochenen Tests)
394 )))
395 |(% colspan="1" %)(% colspan="1" %)
396 (((
397 parameters
398 )))|(% colspan="1" %)(% colspan="1" %)
399 (((
400 Liste von Parametern zur Teststeuerung (alle optional, fett gedruckt = Standard):
401
402 * language [**de**|en|fr|es] Sprache des Benutzerinterfaces von ONYX.
403 * status: Initialer Status des Teilnehmers (aktuell wird nur RESUME_SUSPENDED(10) unterstützt).
404 )))
405
406 === ReturnValue registerStudent ===
407
408 (% class="wrapped" %)
409 |(((
410 Long
411 )))|(((
412 Einer der Werte wie unter Anmeldung eines Tests beschrieben.
413 )))
414
415 == Teststeuerung ==
416
417 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.
418
419 {{code title="Teststeuerung"}}
420 @WebMethod(operationName = „testControl")
421 public Long testControl(
422 @WebParam(name = „testSessionId") final Long testSessionId,
423 @WebParam(name = „studentIds") final StudentIdsWrapper students,
424 @WebParam(name = „status") final Integer status,
425 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
426 }
427 {{/code}}
428
429 === Parameter testControl ===
430
431 (% class="wrapped" %)
432 |(((
433 testSessionId
434 )))|(((
435 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).
436 )))
437 |(((
438 studentIds
439 )))|(((
440 Liste eindeutiger Kennungen für Testteilnehmer.
441 )))
442 |(((
443 status
444 )))|(((
445 Neu zu setzender Status für die gegebenen Testteilnehmer.
446 )))
447 |(((
448 parameters
449 )))|(((
450 Liste von Parametern zur Teststeuerung (alle optional):
451
452 * addTime: Time in minutes to add to the test session.
453 )))
454
455 === ReturnValue testControl ===
456
457 (% class="wrapped" %)
458 |(((
459 Long
460 )))|(((
461 Einer der Werte wie unter Anmeldung eines Tests beschrieben.
462 )))
463
464 == Speicher aufräumen ==
465
466 Haben alle Teilnehmer den Test durchgeführt, so kann die Lernplattform ONYX mitteilen, dass dieses den Test deregistrieren und den Speicher aufräumen kann.
467
468 {{code title="Teststeuerung"}}
469 @WebMethod(operationName = „deregisterTest")
470 public Long deregisterTest(
471 @WebParam(name = „testSessionId") final Long testSessionId,
472 @WebParam(name = „providerId") final String providerId,
473 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
474 }
475 {{/code}}
476
477 === Parameter deregisterTest ===
478
479 (% class="wrapped" %)
480 |(((
481 testSessionId
482 )))|(((
483 Durch die Lernplattform vergebene, eindeutige ID, welche die Kennung für den Test darstellt (siehe registerTest).
484 )))
485 |(((
486 providerId
487 )))|(((
488 Die Kennung, unter welcher die anfordernde Lernplattform bei ONYX angemeldet ist.
489 )))
490 |(((
491 parameters
492 )))|(((
493 Aktuell nicht verwendet.
494 )))
495
496 === ReturnValue deregisterTest ===
497
498 (% class="wrapped" %)
499 |(((
500 Long
501 )))|(((
502 Einer der Werte wie unter Anmeldung eines Tests beschrieben.
503 )))
504
505 == Anzeige des Tests ==
506
507
508 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:
509
510 {{note title="URL"}}
511 [[http:~~/~~/demo.bps-system.de/olatce/services/ReturnWSService?wsdl>>url:http://demo.bps-system.de/olatce/services/ReturnWSService?wsdl||shape="rect"]]
512 Lediglich die URL im unteren Teil der WSDL muss an die Lernplattform angepasst werden.
513 {{/note}}
514
515 == Konfiguration des ONYX Players ==
516
517 Der ONYX Player verwendet eine Konfigurationsdatei namens onyxplugin.config.xml. Diese muss im Java Classpath liegen.
518
519 \\
520
521 {{error title="Sicherheit"}}
522 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.
523 {{/error}}
524
525 (% class="auto-cursor-target" %)
526 \\
527 {{/layout-cell}}
528 {{/layout-section}}
529
530 {{layout-section ac:type="single"}}
531 {{layout-cell}}
532 ----
533 {{/layout-cell}}
534 {{/layout-section}}
535
536 {{layout-section ac:type="single"}}
537 {{layout-cell}}
538 \\
539
540 {{column}}
541 (% class="auto-cursor-target" %)
542 Bei Fragen zur Konfiguration oder zum Einsatz der ONYX-Testsuite in anderen Plattformen helfen wir Ihnen gern weiter.
543
544 {{panel title="BPS Bildungsportal Sachsen GmbH"}}
545 **[[image:attach:BPS-Logo-web.png]]
546 **
547
548 **Tel.: **+49 (0) 371 666 2739 0(% style="color: rgb(89,89,89);" %)**
549 E-Mail: **(%%)[[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]]
550
551 Gern können Sie auch unser (% style="text-align: left;" %)**[[Kontaktformular>>url:https://www.bps-system.de/cms/kontakt/||shape="rect"]] **(%%)nutzen.
552 {{/panel}}
553
554 (% class="auto-cursor-target" %)
555 \\
556 {{/column}}
557
558 (% class="auto-cursor-target" %)
559 \\
560 {{/layout-cell}}
561 {{/layout-section}}
562 {{/layout}}
563 {{/sv-translation}}
564
565 {{sv-translation language="en"}}
566 {{layout}}
567 {{layout-section ac:type="two_right_sidebar"}}
568 {{layout-cell}}
569 The API between the ONYX Player and the LMS consists of the following components:
570
571 * Registration of a test in the ONYX Player through the LMS
572 * Registration of a participant in the ONYX Player through the LMS
573 * Test control
574 * Return of test results to the LMS by the ONYX Player
575 * Deregistration of the test
576 {{/layout-cell}}
577
578 {{layout-cell}}
579 {{scroll-ignore}}
580 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
581
582
583 {{toc/}}
584 {{/panel}}
585 {{/scroll-ignore}}
586 {{/layout-cell}}
587 {{/layout-section}}
588
589 {{layout-section ac:type="single"}}
590 {{layout-cell}}
591 == General information ==
592
593 The ONYX Player defines a web service, which can be reached via the URL **<ONYXPlayer-URL>/onyx/onyxexamservices**.
594
595 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"]]
596
597 == Registration of a test ==
598
599
600 Before participants can take tests, the tests need to be registered with ONYX.
601
602 {{code language="xml" title="Registration"}}
603 @WebMethod(operationName = „registerTest")
604 public Long registerTest(
605 @WebParam(name = „testSessionId") final Long testSessionId,
606 @WebParam(name = „providerId") final String providerId,
607 @WebParam(name = „contentPackage") final byte[] contentPackage,
608 @WebParam(name = „parameters") final MapWrapper parameters) throws Exception {
609 }
610 {{/code}}
611
612 === Parameter registerTest ===
613
614 (% class="wrapped" %)
615 |(((
616 testSessionId
617 )))|(((
618 Unique ID assigned by the LMS, which serves as an identifier for this test.
619 )))
620 |(((
621 providerId
622 )))|(((
623 Identification under which the requesting LMS is registrated with ONYX.
624 )))
625 |(((
626 contentPackage
627 )))|(((
628 The IMS QTI v2.1 CP (zip file as byte array).
629 )))
630 |(((
631 parameters
632 )))|(((
633 (% class="content-wrapper" %)
634 (((
635 (% class="TableParagraph" %)
636 List of parameters to control the test. Additional parameters can be set for individual participants ( registerStudent ).
637
638 (% class="TableParagraph" %)
639 All parameters are optional. The default setting is shown in bold.
640
641 {{info title="Note"}}
642 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"]]".
643 {{/info}}
644
645 * showSolution [true|**false**] Should the correct answer be displayed to the user?
646 * isSynchronized [true|**false**] Is it a test in the exam mode for which the test start is synchronised for all users?
647 * 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.
648 * suspendAllowed [true|f**alse**] Is it is allowed to interrupt the test? If this is the case, the additional button "Suspend" will be displayed.
649 * Templateid: Currently only supported: onyxwithoutnav - hides the navigation tree.
650 * dontShowItemTitles [true|**false**]: Are the titles of the tasks supposed to be displayed?
651 \\
652
653 {{note}}
654 The following parameters are available since **version 5.15:**
655 {{/note}}
656
657 * 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.
658 * 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.
659 * 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.
660 * itemShowFeedback [**true**|false] The task feedback defined by the author is displayed to the participant after the task has been answered.
661 * itemShowScore [**true**|false] The participant is shown the number of points achieved for the task after the submission of their answer.
662 * itemShowCorrect [**true**|false] The participant is shown whether their answer was correct or wrong after the submission of their answer. Implies itemShowScore=true.
663 * itemShowSolution [**true**|false] The participant is shown the correct solution after the submission of their answer. Implies itemShowCorrect=true and itemShowScore=true.
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 {{/layout}}
883 {{/sv-translation}}