Zum Inhalt springen

Wiki-Quellcode von ONYX Player Interface

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