Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

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

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,3 +1,4 @@
1 +{{sv-translation language="de"}}
1 1  {{layout}}
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
... ... @@ -377,3 +377,356 @@
377 377  {{/layout-cell}}
378 378  {{/layout-section}}
379 379  {{/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}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342791
1 +3342937
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342791/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342937/Schnittstelle ONYX Reporter