Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 26.11.2025
Von Version 403.1
bearbeitet von Carina Enke
am 16.11.2025
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 341.1
bearbeitet von Carina Enke
am 15.10.2018
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.12.

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -08 Schnittstelle ONYX Reporter
1 +Schnittstelle ONYX Reporter
Übergeordnete Seite
... ... @@ -1,1 +1,0 @@
1 -ONYX.Systeminformationen.WebHome
Inhalt
... ... @@ -1,25 +1,36 @@
1 -{{section}}
2 -{{column width="60%"}}
3 -
4 -{{/column}}
1 +{{sv-translation language="de"}}
2 +{{layout}}
3 +{{layout-section ac:type="single"}}
4 +{{layout-cell}}
5 5  
6 -{{column width="30%"}}
7 -{{panel title="Inhalt"}}
8 -{{toc start="2"/}}
9 -{{/panel}}
10 10  
11 -{{panel title="Weiterführende Inhalte"}}
12 -* [[Schnittstelle ONYX Player>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
13 -{{/panel}}
14 -{{/column}}
15 -{{/section}}
7 +(% class="removedPlaceholderWrapper" %)
16 16  
17 17  
10 +
11 +{{/layout-cell}}
12 +{{/layout-section}}
13 +
14 +{{layout-section ac:type="two_right_sidebar"}}
15 +{{layout-cell}}
16 +====== Inhalt: ======
17 +
18 +
19 +
20 +{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
21 +{{/layout-cell}}
22 +
23 +{{layout-cell}}
24 +
25 +{{/layout-cell}}
26 +{{/layout-section}}
27 +
28 +{{layout-section ac:type="single"}}
29 +{{layout-cell}}
18 18  == Allgemeines ==
19 19  
20 20  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
21 21  
22 -(% class="wrapped" %)
23 23  |(((
24 24  armSite
25 25  )))|(((
... ... @@ -65,7 +65,6 @@
65 65  
66 66  === Parameter armSite ===
67 67  
68 -(% class="wrapped" %)
69 69  |(((
70 70  version
71 71  )))|(((
... ... @@ -108,7 +108,6 @@
108 108  
109 109  === ReturnValue armSite ===
110 110  
111 -(% class="wrapped" %)
112 112  |(((
113 113  String
114 114  )))|(((
... ... @@ -131,7 +131,6 @@
131 131  
132 132  === Parameter initiateSite ===
133 133  
134 -(% class="wrapped" %)
135 135  |(((
136 136  version
137 137  )))|(((
... ... @@ -167,7 +167,6 @@
167 167  
168 168  === ReturnValue initiateSite ===
169 169  
170 -(% class="wrapped" %)
171 171  |(((
172 172  String
173 173  )))|(((
... ... @@ -191,6 +191,7 @@
191 191  
192 192  == Abmeldung durch LMS ==
193 193  
201 +
194 194  
195 195  {{code}}
196 196  @WebMethod(operationName = „disarmSite")
... ... @@ -202,10 +202,10 @@
202 202  }
203 203  {{/code}}
204 204  
213 +
205 205  
206 206  === Parameter disarmSite ===
207 207  
208 -(% class="wrapped" %)
209 209  |(((
210 210  version
211 211  )))|(((
... ... @@ -334,12 +334,377 @@
334 334  
335 335  HashMapWrapper.java:
336 336  
337 -[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
345 +[[image:attach:HashMapWrapperjava.png]]
338 338  
339 -[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
347 +[[image:attach:HashMapWrapperjava2.png]]
340 340  
341 341  === Wrapper für die ArrayList<ResultsForStudent> ===
342 342  
343 343  ResultsForStudentsWrapper.java:
344 344  
345 -[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
353 +[[image:attach:ResultsForStudentsWrapperjava.png]]
354 +{{/layout-cell}}
355 +{{/layout-section}}
356 +
357 +{{layout-section ac:type="two_right_sidebar"}}
358 +{{layout-cell}}
359 +
360 +{{/layout-cell}}
361 +
362 +{{layout-cell}}
363 +====== relevante Links: ======
364 +
365 +* [[doc:ONYX Player Interface]]
366 +{{/layout-cell}}
367 +{{/layout-section}}
368 +{{/layout}}
369 +{{/sv-translation}}
370 +
371 +{{sv-translation language="en"}}
372 +{{layout}}
373 +{{layout-section ac:type="two_equal"}}
374 +{{layout-cell}}
375 +====== Content: ======
376 +
377 +
378 +
379 +{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
380 +{{/layout-cell}}
381 +
382 +{{layout-cell}}
383 +
384 +{{/layout-cell}}
385 +{{/layout-section}}
386 +
387 +{{layout-section ac:type="single"}}
388 +{{layout-cell}}
389 +== General information ==
390 +
391 +The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
392 +
393 +|(((
394 +armSite
395 +)))|(((
396 +Registration of sequence requests at the ONYX Reporter
397 +)))
398 +|(((
399 +initiateSite
400 +)))|(((
401 +Initiates the Reporter session (transmission of the CP).
402 +)))
403 +|(((
404 +disarmSite
405 +)))|(((
406 +Release of all Reporter resources for this session.
407 +)))
408 +|(((
409 +getResultValues
410 +)))|(((
411 +Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
412 +)))
413 +|(% colspan="1" %)(% colspan="1" %)
414 +(((
415 +getResultVariables
416 +)))|(% colspan="1" %)(% colspan="1" %)
417 +(((
418 +Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
419 +)))
420 +
421 +== Login through the LMS ==
422 +
423 +{{code language="xml" title="Login through the LMS"}}
424 +@WebMethod(operationName = „armSite")
425 +public String armSite(
426 +@WebParam(name = „version") final Integer version,
427 +@WebParam(name = „userId") final String userId,
428 +@WebParam(name = „optionalRole") final Integer role,
429 +@WebParam(name = „secretToShare") final String secretToShare,
430 +@WebParam(name = „optionalUserLastName") final String userLastName,
431 +@WebParam(name = „optionalUserFirstName") final String userFirstName,
432 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
433 +}
434 +{{/code}}
435 +
436 +=== Parameter armSite ===
437 +
438 +|(((
439 +version
440 +)))|(((
441 +Requested version: 1
442 +)))
443 +|(((
444 +userId
445 +)))|(((
446 +UserId of the requested Reporter user
447 +)))
448 +|(((
449 +optionalRole
450 +)))|(((
451 +Optional. User role. 0 = student, 1 = tutor
452 +)))
453 +|(((
454 +secretToShare
455 +)))|(((
456 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
457 +)))
458 +|(((
459 +optionalUserLastName
460 +)))|(((
461 +Optional. Last name of the user.
462 +)))
463 +|(% colspan="1" %)(% colspan="1" %)
464 +(((
465 +optionalUserFirstName
466 +)))|(% colspan="1" %)(% colspan="1" %)
467 +(((
468 +Optional. First name of the user.
469 +)))
470 +|(% colspan="1" %)(% colspan="1" %)
471 +(((
472 +additionalParams
473 +)))|(% colspan="1" %)(% colspan="1" %)
474 +(((
475 +Reserved for future use.
476 +)))
477 +
478 +=== ReturnValue armSite ===
479 +
480 +|(((
481 +String
482 +)))|(((
483 +Session ID which has to be used to mark any other Reporter call.
484 +)))
485 +
486 +== Initialisation through LMS ==
487 +
488 +{{code language="xml" title="Initialisation through LMS"}}
489 +@WebMethod(operationName = „initiateSite")
490 +public String initiateSite(
491 +@WebParam(name = „version") final Integer version,
492 +@WebParam(name = „sessionId") final String sessionId,
493 +@WebParam(name = „secretToShare") final String secretToShare,
494 +@WebParam(name = „students") final ArrayList<ResultsForStudent> students,
495 +@WebParam(name = „optionalContentPackage") final byte[] contentPackage,
496 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
497 +}
498 +{{/code}}
499 +
500 +=== Parameter initiateSite ===
501 +
502 +|(((
503 +version
504 +)))|(((
505 +Requested version: 1
506 +)))
507 +|(% colspan="1" %)(% colspan="1" %)
508 +(((
509 +sessionId
510 +)))|(% colspan="1" %)(% colspan="1" %)
511 +(((
512 +SessionId, as returned by armSite.
513 +)))
514 +|(((
515 +secretToShare
516 +)))|(((
517 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
518 +)))
519 +|(((
520 +students
521 +)))|(((
522 +List of students and their results. See below.
523 +)))
524 +|(((
525 +optionalContentPackage
526 +)))|(((
527 +Optional. Content package (zipped) as byte array.
528 +)))
529 +|(((
530 +additionalParams
531 +)))|(((
532 +Reserved for future use.
533 +)))
534 +
535 +=== ReturnValue initiateSite ===
536 +
537 +|(((
538 +String
539 +)))|(((
540 +Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
541 +
542 +* sid: Session ID, as returned by armSite
543 +* (((
544 +uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
545 +)))
546 +)))
547 +
548 +{{code language="xml"}}
549 +public class ResultsForStudent {
550 +   private String studentId = „";
551 +   private String firstname = „";
552 +   private String lastname = „";
553 +   private String groupname = „";
554 +   private String tutorname = „";
555 +   private File contentFile = null;
556 +   private byte[] resultsFile = null;
557 +}
558 +{{/code}}
559 +
560 +== Logout through the LMS ==
561 +
562 +
563 +
564 +{{code}}
565 +@WebMethod(operationName = „disarmSite")
566 +public Boolean disarmSite(
567 +@WebParam(name = „version") final Integer version,
568 +@WebParam(name = „sessionId") final String sessionId,
569 +@WebParam(name = „secretToShare") final String secretToShare,
570 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
571 +}
572 +{{/code}}
573 +
574 +
575 +
576 +=== Parameter disarmSite ===
577 +
578 +|(((
579 +version
580 +)))|(((
581 +Requested version: 1
582 +)))
583 +|(% colspan="1" %)(% colspan="1" %)
584 +(((
585 +sessionId
586 +)))|(% colspan="1" %)(% colspan="1" %)
587 +(((
588 +SessionId, as returned by armSite.
589 +)))
590 +|(((
591 +secretToShare
592 +)))|(((
593 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
594 +)))
595 +|(((
596 +additionalParams
597 +)))|(((
598 +Reserved for future use.
599 +)))
600 +
601 +=== ReturnValue disarmSite ===
602 +
603 +|(((
604 +Boolean
605 +)))|(((
606 +True in the case of success, otherwise false.
607 +)))
608 +
609 +== Request of learner results through the LMS ==
610 +
611 +{{code language="xml" title="Request of learner results through the LMS"}}
612 + @WebMethod(operationName = „getResultValues")
613 +public HashMapWrapper getResultValues(
614 + @WebParam(name = „version") final Integer version,
615 + @WebParam(name = „sessionId") final String sessionId,
616 + @WebParam(name = „secretToShare") final String secretToShare,
617 + @WebParam(name = „requestedValues") final HashMap<String, String>
618 + requestedValues,
619 + @WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
620 +}
621 +{{/code}}
622 +
623 +=== Parameter getResultValues ===
624 +
625 +|(((
626 +version
627 +)))|(((
628 +Requested version: 1
629 +)))
630 +|(% colspan="1" %)(% colspan="1" %)
631 +(((
632 +sessionId
633 +)))|(% colspan="1" %)(% colspan="1" %)
634 +(((
635 +SessionId, as returned by armSite.
636 +)))
637 +|(((
638 +secretToShare
639 +)))|(((
640 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
641 +)))
642 +|(((
643 +requestedValues
644 +)))|(((
645 +Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
646 +)))
647 +|(((
648 +additionalParams
649 +)))|(((
650 +Reserved for future use.
651 +)))
652 +
653 +=== ReturnValue getResultValues ===
654 +
655 +|(((
656 +HashMap<String, String>
657 +)))|(((
658 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
659 +)))
660 +
661 +== Request of result variables through the LMS ==
662 +
663 +{{code language="xml" title="Request of result variables through the LMS"}}
664 + @WebMethod(operationName = „getResultVariables")
665 +public HashMapWrapper getResultVariables(
666 +@WebParam(name = „version") final Integer version,
667 +@WebParam(name = „contentPackage") final byte[] contentPackage,
668 +@WebParam(name = „additionalParams") final HashMapWrapper additionalParams) {
669 +}
670 +{{/code}}
671 +
672 +=== Parameter getResultVariables ===
673 +
674 +|(((
675 +version
676 +)))|(((
677 +Requested version: 1
678 +)))
679 +|(((
680 +contentPackage
681 +)))|(((
682 +Content package (zipped) as byte array.
683 +)))
684 +|(((
685 +additionalParams
686 +)))|(((
687 +Reserved for future use.
688 +)))
689 +
690 +=== ReturnValue getResultVariables ===
691 +
692 +|(((
693 +HashMap<String, String>
694 +)))|(((
695 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
696 +)))
697 +
698 +== Wrapper ==
699 +
700 +Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
701 +
702 +=== Wrapper for HashMap<String, String> ===
703 +
704 +HashMapWrapper.java:
705 +
706 +[[image:attach:HashMapWrapperjava.png]]
707 +
708 +[[image:attach:HashMapWrapperjava2.png]]
709 +
710 +=== Wrapper for the ArrayList<ResultsForStudent> ===
711 +
712 +ResultsForStudentsWrapper.java:
713 +
714 +[[image:attach:ResultsForStudentsWrapperjava.png]]
715 +{{/layout-cell}}
716 +{{/layout-section}}
717 +{{/layout}}
718 +{{/sv-translation}}
HashMapWrapperjava.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Größe
... ... @@ -1,1 +1,0 @@
1 -135.3 KB
Inhalt
HashMapWrapperjava2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Größe
... ... @@ -1,1 +1,0 @@
1 -187.3 KB
Inhalt
ResultsForStudentsWrapperjava.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Größe
... ... @@ -1,1 +1,0 @@
1 -83.3 KB
Inhalt
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342390
1 +182518281
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/182518281/Schnittstelle ONYX Reporter