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 285.1
bearbeitet von Carina Enke
am 08.05.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.7.

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