Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 380.1
bearbeitet von sandra_riediger
am 17.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 401.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Schnittstelle ONYX Reporter
1 +10 Schnittstelle ONYX Reporter
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Systeminformationen.WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.sandra_riediger
1 +XWiki.carina
Inhalt
... ... @@ -1,39 +2,17 @@
1 -{{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="two_right_sidebar"}}
4 4  {{layout-cell}}
5 -====== Inhalt: ======
6 -
7 -
8 -
9 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
4 +
10 10  {{/layout-cell}}
11 11  
12 12  {{layout-cell}}
13 -|=(% colspan="1" %)(% colspan="1" %)
14 -(((
15 -Programmversion
16 -)))|(% colspan="1" %)(% colspan="1" %)
17 -(((
18 -
19 -)))
20 -|=(((
21 -Status
22 -)))|(((
23 -(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
24 -)))
25 -|=(((
26 -Aufgaben
27 -)))|(((
28 -
8 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
9 +{{toc start="2"/}}
29 29  
30 -
31 -)))
32 -|=(((
33 -JIRA
34 -)))|(((
35 -
36 -)))
11 + **Weitere Informationen:**
12 +
13 +* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
14 +{{/panel}}
37 37  {{/layout-cell}}
38 38  {{/layout-section}}
39 39  
... ... @@ -43,6 +43,7 @@
43 43  
44 44  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
45 45  
24 +(% class="wrapped" %)
46 46  |(((
47 47  armSite
48 48  )))|(((
... ... @@ -73,7 +73,7 @@
73 73  
74 74  == Anmeldung des LMS ==
75 75  
76 -{{code title="Anmeldung des LMS" language="xml"}}
55 +{{code language="xml" title="Anmeldung des LMS"}}
77 77  @WebMethod(operationName = „armSite")
78 78  public String armSite(
79 79  @WebParam(name = „version") final Integer version,
... ... @@ -88,6 +88,7 @@
88 88  
89 89  === Parameter armSite ===
90 90  
70 +(% class="wrapped" %)
91 91  |(((
92 92  version
93 93  )))|(((
... ... @@ -130,6 +130,7 @@
130 130  
131 131  === ReturnValue armSite ===
132 132  
113 +(% class="wrapped" %)
133 133  |(((
134 134  String
135 135  )))|(((
... ... @@ -138,7 +138,7 @@
138 138  
139 139  == Initialisierung durch LMS ==
140 140  
141 -{{code title="Initialisierung durch LMS" language="xml"}}
122 +{{code language="xml" title="Initialisierung durch LMS"}}
142 142  @WebMethod(operationName = „initiateSite")
143 143  public String initiateSite(
144 144  @WebParam(name = „version") final Integer version,
... ... @@ -152,6 +152,7 @@
152 152  
153 153  === Parameter initiateSite ===
154 154  
136 +(% class="wrapped" %)
155 155  |(((
156 156  version
157 157  )))|(((
... ... @@ -187,6 +187,7 @@
187 187  
188 188  === ReturnValue initiateSite ===
189 189  
172 +(% class="wrapped" %)
190 190  |(((
191 191  String
192 192  )))|(((
... ... @@ -210,7 +210,6 @@
210 210  
211 211  == Abmeldung durch LMS ==
212 212  
213 -
214 214  
215 215  {{code}}
216 216  @WebMethod(operationName = „disarmSite")
... ... @@ -222,10 +222,10 @@
222 222  }
223 223  {{/code}}
224 224  
225 -
226 226  
227 227  === Parameter disarmSite ===
228 228  
210 +(% class="wrapped" %)
229 229  |(((
230 230  version
231 231  )))|(((
... ... @@ -251,6 +251,7 @@
251 251  
252 252  === ReturnValue disarmSite ===
253 253  
236 +(% class="wrapped" %)
254 254  |(((
255 255  Boolean
256 256  )))|(((
... ... @@ -259,7 +259,7 @@
259 259  
260 260  == Abfrage von Lernerresultaten durch LMS ==
261 261  
262 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
245 +{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
263 263   @WebMethod(operationName = „getResultValues")
264 264  public HashMapWrapper getResultValues(
265 265   @WebParam(name = „version") final Integer version,
... ... @@ -273,6 +273,7 @@
273 273  
274 274  === Parameter getResultValues ===
275 275  
259 +(% class="wrapped" %)
276 276  |(((
277 277  version
278 278  )))|(((
... ... @@ -303,6 +303,7 @@
303 303  
304 304  === ReturnValue getResultValues ===
305 305  
290 +(% class="wrapped" %)
306 306  |(((
307 307  HashMap<String, String>
308 308  )))|(((
... ... @@ -311,7 +311,7 @@
311 311  
312 312  == Abfrage von Ergebnisvariablen durch LMS ==
313 313  
314 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
299 +{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
315 315   @WebMethod(operationName = „getResultVariables")
316 316  public HashMapWrapper getResultVariables(
317 317  @WebParam(name = „version") final Integer version,
... ... @@ -322,6 +322,7 @@
322 322  
323 323  === Parameter getResultVariables ===
324 324  
310 +(% class="wrapped" %)
325 325  |(((
326 326  version
327 327  )))|(((
... ... @@ -340,6 +340,7 @@
340 340  
341 341  === ReturnValue getResultVariables ===
342 342  
329 +(% class="wrapped" %)
343 343  |(((
344 344  HashMap<String, String>
345 345  )))|(((
... ... @@ -348,386 +348,21 @@
348 348  
349 349  == Wrapper ==
350 350  
351 -Da die Übertragung von Maps und Listen über JAX-WS Probleme macht (clientseitig gefüllte Listen werden leer über den WS versandt und kommen daher auch leer serverseitig an), müssen diese gewrappt werden.
338 +Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
352 352  
353 353  === Wrapper für die HashMap<String, String> ===
354 354  
355 355  HashMapWrapper.java:
356 356  
357 -[[image:attach:HashMapWrapperjava.png]]
344 +[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
358 358  
359 -[[image:attach:HashMapWrapperjava2.png]]
346 +[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
360 360  
361 361  === Wrapper für die ArrayList<ResultsForStudent> ===
362 362  
363 363  ResultsForStudentsWrapper.java:
364 364  
365 -[[image:attach:ResultsForStudentsWrapperjava.png]]
352 +[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
366 366  {{/layout-cell}}
367 367  {{/layout-section}}
368 -
369 -{{layout-section ac:type="two_right_sidebar"}}
370 -{{layout-cell}}
371 -
372 -{{/layout-cell}}
373 -
374 -{{layout-cell}}
375 -====== relevante Links: ======
376 -
377 -* [[doc:Schnittstelle ONYX WebPlayer]]
378 -{{/layout-cell}}
379 -{{/layout-section}}
380 380  {{/layout}}
381 -{{/sv-translation}}
382 -
383 -{{sv-translation language="en"}}
384 -{{layout}}
385 -{{layout-section ac:type="two_equal"}}
386 -{{layout-cell}}
387 -====== Content: ======
388 -
389 -
390 -
391 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
392 -{{/layout-cell}}
393 -
394 -{{layout-cell}}
395 -
396 -{{/layout-cell}}
397 -{{/layout-section}}
398 -
399 -{{layout-section ac:type="single"}}
400 -{{layout-cell}}
401 -
402 -
403 -== General ==
404 -
405 -The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
406 -
407 -|(((
408 -armSite
409 -)))|(((
410 -Registration of sequence requests at the ONYX reporter
411 -)))
412 -|(((
413 -initiateSite
414 -)))|(((
415 -Initiates the reporter session (transmission of the CP).
416 -)))
417 -|(((
418 -disarmSite
419 -)))|(((
420 -Release of all reporter resources for this session.
421 -)))
422 -|(((
423 -getResultValues
424 -)))|(((
425 -Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
426 -)))
427 -|(% colspan="1" %)(% colspan="1" %)
428 -(((
429 -getResultVariables
430 -)))|(% colspan="1" %)(% colspan="1" %)
431 -(((
432 -Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
433 -)))
434 -
435 -== Connection to the LMS ==
436 -
437 -{{code title="Anmeldung des LMS" language="xml"}}
438 -@WebMethod(operationName = „armSite")
439 -public String armSite(
440 -@WebParam(name = „version") final Integer version,
441 -@WebParam(name = „userId") final String userId,
442 -@WebParam(name = „optionalRole") final Integer role,
443 -@WebParam(name = „secretToShare") final String secretToShare,
444 -@WebParam(name = „optionalUserLastName") final String userLastName,
445 -@WebParam(name = „optionalUserFirstName") final String userFirstName,
446 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
447 -}
448 -{{/code}}
449 -
450 -=== Parameter armSite ===
451 -
452 -|(((
453 -version
454 -)))|(((
455 -Requested version: 1
456 -)))
457 -|(((
458 -userId
459 -)))|(((
460 -UserId of the requested reporter user
461 -)))
462 -|(((
463 -optionalRole
464 -)))|(((
465 -Optional. User role. 0=student, 1=tutor
466 -)))
467 -|(((
468 -secretToShare
469 -)))|(((
470 -Shared secret. Has to remain identical for every communication.
471 -)))
472 -|(((
473 -optionalUserLastName
474 -)))|(((
475 -Optional. User lastname.
476 -)))
477 -|(% colspan="1" %)(% colspan="1" %)
478 -(((
479 -optionalUserFirstName
480 -)))|(% colspan="1" %)(% colspan="1" %)
481 -(((
482 -Optional. User firstname.
483 -)))
484 -|(% colspan="1" %)(% colspan="1" %)
485 -(((
486 -additionalParams
487 -)))|(% colspan="1" %)(% colspan="1" %)
488 -(((
489 -Reserved for future use.
490 -)))
491 -
492 -=== ReturnValue armSite ===
493 -
494 -|(((
495 -String
496 -)))|(((
497 -Session ID that has to be used to mark any further reporter call.
498 -)))
499 -
500 -== Initialisation through LMS ==
501 -
502 -{{code title="Initialisierung durch LMS" language="xml"}}
503 -@WebMethod(operationName = „initiateSite")
504 -public String initiateSite(
505 -@WebParam(name = „version") final Integer version,
506 -@WebParam(name = „sessionId") final String sessionId,
507 -@WebParam(name = „secretToShare") final String secretToShare,
508 -@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
509 -@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
510 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
511 -}
512 -{{/code}}
513 -
514 -=== Parameter initiateSite ===
515 -
516 -|(((
517 -version
518 -)))|(((
519 -Requested version: 1
520 -)))
521 -|(% colspan="1" %)(% colspan="1" %)
522 -(((
523 -sessionId
524 -)))|(% colspan="1" %)(% colspan="1" %)
525 -(((
526 -SessionId, as returned by armSite.
527 -)))
528 -|(((
529 -secretToShare
530 -)))|(((
531 -Shared secret. Has to remain identical at every communication.
532 -)))
533 -|(((
534 -students
535 -)))|(((
536 -List of students with their results. See below.
537 -)))
538 -|(((
539 -optionalContentPackage
540 -)))|(((
541 -Optional. Content Package (zipped) as byte array.
542 -)))
543 -|(((
544 -additionalParams
545 -)))|(((
546 -Reserved for future use.
547 -)))
548 -
549 -=== ReturnValue initiateSite ===
550 -
551 -|(((
552 -String
553 -)))|(((
554 -Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
555 -
556 -* sid: Session ID as returned by armSite
557 -* (((
558 -uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
559 -)))
560 -)))
561 -
562 -{{code language="xml"}}
563 -public class ResultsForStudent {
564 -   private String studentId = „";
565 -   private String firstname = „";
566 -   private String lastname = „";
567 -   private String groupname = „";
568 -   private String tutorname = „";
569 -   private File contentFile = null;
570 -   private byte[] resultsFile = null;
571 -}
572 -{{/code}}
573 -
574 -== Deconnection through the LMS ==
575 -
576 -
577 -
578 -{{code}}
579 -@WebMethod(operationName = „disarmSite")
580 -public Boolean disarmSite(
581 -@WebParam(name = „version") final Integer version,
582 -@WebParam(name = „sessionId") final String sessionId,
583 -@WebParam(name = „secretToShare") final String secretToShare,
584 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
585 -}
586 -{{/code}}
587 -
588 -
589 -
590 -=== Parameter disarmSite ===
591 -
592 -|(((
593 -version
594 -)))|(((
595 -Requested version: 1
596 -)))
597 -|(% colspan="1" %)(% colspan="1" %)
598 -(((
599 -sessionId
600 -)))|(% colspan="1" %)(% colspan="1" %)
601 -(((
602 -SessionId, as returned by armSite.
603 -)))
604 -|(((
605 -secretToShare
606 -)))|(((
607 -Shared secret. Has to remain identical at every communication.
608 -)))
609 -|(((
610 -additionalParams
611 -)))|(((
612 -Reserved for future use.
613 -)))
614 -
615 -=== ReturnValue disarmSite ===
616 -
617 -|(((
618 -Boolean
619 -)))|(((
620 -True if successful, otherwise false.
621 -)))
622 -
623 -== Request of learning results through the LMS ==
624 -
625 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
626 - @WebMethod(operationName = „getResultValues")
627 -public HashMapWrapper getResultValues(
628 - @WebParam(name = „version") final Integer version,
629 - @WebParam(name = „sessionId") final String sessionId,
630 - @WebParam(name = „secretToShare") final String secretToShare,
631 - @WebParam(name = „requestedValues") final HashMap<String, String>
632 - requestedValues,
633 - @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
634 -}
635 -{{/code}}
636 -
637 -=== Parameter getResultValues ===
638 -
639 -|(((
640 -version
641 -)))|(((
642 -Requested version: 1
643 -)))
644 -|(% colspan="1" %)(% colspan="1" %)
645 -(((
646 -sessionId
647 -)))|(% colspan="1" %)(% colspan="1" %)
648 -(((
649 -SessionId, as returned by armSite.
650 -)))
651 -|(((
652 -secretToShare
653 -)))|(((
654 -Shared secret. Has to remain identical at every communication.
655 -)))
656 -|(((
657 -requestedValues
658 -)))|(((
659 -Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
660 -)))
661 -|(((
662 -additionalParams
663 -)))|(((
664 -Reserved for future use.
665 -)))
666 -
667 -=== ReturnValue getResultValues ===
668 -
669 -|(((
670 -HashMap<String, String>
671 -)))|(((
672 -Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
673 -)))
674 -
675 -== Request of result variables through the LMS ==
676 -
677 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
678 - @WebMethod(operationName = „getResultVariables")
679 -public HashMapWrapper getResultVariables(
680 -@WebParam(name = „version") final Integer version,
681 -@WebParam(name = „contentPackage") final byte[] contentPackage,
682 -@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
683 -}
684 -{{/code}}
685 -
686 -=== Parameter getResultVariables ===
687 -
688 -|(((
689 -version
690 -)))|(((
691 -Requested version: 1
692 -)))
693 -|(((
694 -contentPackage
695 -)))|(((
696 -Content package (zipped) as byte array.
697 -)))
698 -|(((
699 -additionalParams
700 -)))|(((
701 -Reserved for future use.
702 -)))
703 -
704 -=== ReturnValue getResultVariables ===
705 -
706 -|(((
707 -HashMap<String, String>
708 -)))|(((
709 -Map of result variables, key is the variable name, value the corresponding
710 -value (HashMap is wrapped).
711 -)))
712 -
713 -== Wrapper ==
714 -
715 -As the transmission of maps and lists generate problems via JAX-WS (lists filled by the customer are sent without any data and thus reach the server without data) they have to be wrapped.
716 -
717 -=== Wrapper for HashMap<String, String> ===
718 -
719 -HashMapWrapper.java:
720 -
721 -[[image:attach:HashMapWrapperjava.png]]
722 -
723 -[[image:attach:HashMapWrapperjava2.png]]
724 -
725 -=== Wrapper for the ArrayList<ResultsForStudent> ===
726 -
727 -ResultsForStudentsWrapper.java:
728 -
729 -[[image:attach:ResultsForStudentsWrapperjava.png]]
730 -{{/layout-cell}}
731 -{{/layout-section}}
732 -{{/layout}}
733 -{{/sv-translation}}
HashMapWrapperjava.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Größe
... ... @@ -1,0 +1,1 @@
1 +135.3 KB
Inhalt
HashMapWrapperjava2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Größe
... ... @@ -1,0 +1,1 @@
1 +187.3 KB
Inhalt
ResultsForStudentsWrapperjava.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Größe
... ... @@ -1,0 +1,1 @@
1 +83.3 KB
Inhalt
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342937
1 +3342390
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342937/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter