Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 398.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 390.7
bearbeitet von Carina Enke
am 18.12.2023
Änderungskommentar: Renamed from xwiki:ONYX.Hilfe.Systeminformationen.Schnittstelle ONYX Reporter.WebHome

Zusammenfassung

Details

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