Zum Inhalt springen

Wiki-Quellcode von ONYX Player Interface

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