Zum Inhalt springen

Wiki-Quellcode von ONYX Player Interface

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