Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 378.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
... ... @@ -6,7 +6,7 @@
6 6  
7 7  
8 8  
9 -{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
9 +{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
10 10  {{/layout-cell}}
11 11  
12 12  {{layout-cell}}
... ... @@ -392,30 +392,7 @@
392 392  {{/layout-cell}}
393 393  
394 394  {{layout-cell}}
395 -|=(% colspan="1" %)(% colspan="1" %)
396 -(((
397 -Programmversion
398 -)))|(% colspan="1" %)(% colspan="1" %)
399 -(((
400 400  
401 -)))
402 -|=(((
403 -Status
404 -)))|(((
405 -(% class="status-macro aui-lozenge aui-lozenge-error" %)DRAFT
406 -)))
407 -|=(((
408 -Aufgaben
409 -)))|(((
410 -
411 -
412 -
413 -)))
414 -|=(((
415 -JIRA
416 -)))|(((
417 -
418 -)))
419 419  {{/layout-cell}}
420 420  {{/layout-section}}
421 421  
... ... @@ -423,29 +423,29 @@
423 423  {{layout-cell}}
424 424  
425 425  
426 -== Allgemeines ==
403 +== General ==
427 427  
428 -Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
405 +The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
429 429  
430 430  |(((
431 431  armSite
432 432  )))|(((
433 -Anmeldung von Folgerequests beim ONYX Reporter.
410 +Registration of sequence requests at the ONYX reporter
434 434  )))
435 435  |(((
436 436  initiateSite
437 437  )))|(((
438 -Initiiert die Reporter-Session (Übertragung des CPs).
415 +Initiates the reporter session (transmission of the CP).
439 439  )))
440 440  |(((
441 441  disarmSite
442 442  )))|(((
443 -Freigabe von allen Reporter-Ressourcen für diese Session.
420 +Release of all reporter resources for this session.
444 444  )))
445 445  |(((
446 446  getResultValues
447 447  )))|(((
448 -Gibt alle bzw. die angeforderten Resultate für den Test zurück. Voraussetzung: Es ist nur exakt ein Student in der bei initiateSite übertragenen Liste.
425 +Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
449 449  )))
450 450  |(% colspan="1" %)(% colspan="1" %)
451 451  (((
... ... @@ -452,10 +452,10 @@
452 452  getResultVariables
453 453  )))|(% colspan="1" %)(% colspan="1" %)
454 454  (((
455 -Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
432 +Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
456 456  )))
457 457  
458 -== Anmeldung des LMS ==
435 +== Connection to the LMS ==
459 459  
460 460  {{code title="Anmeldung des LMS" language="xml"}}
461 461  @WebMethod(operationName = „armSite")
... ... @@ -475,27 +475,27 @@
475 475  |(((
476 476  version
477 477  )))|(((
478 -Angefragte Version: 1
455 +Requested version: 1
479 479  )))
480 480  |(((
481 481  userId
482 482  )))|(((
483 -UserId des anfragenden Reporter-Benutzers
460 +UserId of the requested reporter user
484 484  )))
485 485  |(((
486 486  optionalRole
487 487  )))|(((
488 -Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
465 +Optional. User role. 0=student, 1=tutor
489 489  )))
490 490  |(((
491 491  secretToShare
492 492  )))|(((
493 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
470 +Shared secret. Has to remain identical for every communication.
494 494  )))
495 495  |(((
496 496  optionalUserLastName
497 497  )))|(((
498 -Optional. Nachname des Benutzers.
475 +Optional. User lastname.
499 499  )))
500 500  |(% colspan="1" %)(% colspan="1" %)
501 501  (((
... ... @@ -502,7 +502,7 @@
502 502  optionalUserFirstName
503 503  )))|(% colspan="1" %)(% colspan="1" %)
504 504  (((
505 -Optional. Vorname des Benutzers.
482 +Optional. User firstname.
506 506  )))
507 507  |(% colspan="1" %)(% colspan="1" %)
508 508  (((
... ... @@ -517,10 +517,10 @@
517 517  |(((
518 518  String
519 519  )))|(((
520 -Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
497 +Session ID that has to be used to mark any further reporter call.
521 521  )))
522 522  
523 -== Initialisierung durch LMS ==
500 +== Initialisation through LMS ==
524 524  
525 525  {{code title="Initialisierung durch LMS" language="xml"}}
526 526  @WebMethod(operationName = „initiateSite")
... ... @@ -539,7 +539,7 @@
539 539  |(((
540 540  version
541 541  )))|(((
542 -Angefragte Version: 1
519 +Requested version: 1
543 543  )))
544 544  |(% colspan="1" %)(% colspan="1" %)
545 545  (((
... ... @@ -546,22 +546,22 @@
546 546  sessionId
547 547  )))|(% colspan="1" %)(% colspan="1" %)
548 548  (((
549 -SessionId, wie von armSite zurück geliefert.
526 +SessionId, as returned by armSite.
550 550  )))
551 551  |(((
552 552  secretToShare
553 553  )))|(((
554 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
531 +Shared secret. Has to remain identical at every communication.
555 555  )))
556 556  |(((
557 557  students
558 558  )))|(((
559 -Liste der Studenten mit ihren Resultaten. Siehe unten.
536 +List of students with their results. See below.
560 560  )))
561 561  |(((
562 562  optionalContentPackage
563 563  )))|(((
564 -Optional. Content Package (gezippt) als Byte-Array.
541 +Optional. Content Package (zipped) as byte array.
565 565  )))
566 566  |(((
567 567  additionalParams
... ... @@ -574,11 +574,13 @@
574 574  |(((
575 575  String
576 576  )))|(((
577 -Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
554 +Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
578 578  
579 -* sid: Session ID, wie von armSite zurück gegeben
580 -* uid: Student ID, wie in initiateSite beim Reporter angemeldet
556 +* sid: Session ID as returned by armSite
557 +* (((
558 +uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
581 581  )))
560 +)))
582 582  
583 583  {{code language="xml"}}
584 584  public class ResultsForStudent {
... ... @@ -592,7 +592,7 @@
592 592  }
593 593  {{/code}}
594 594  
595 -== Abmeldung durch LMS ==
574 +== Deconnection through the LMS ==
596 596  
597 597  
598 598  
... ... @@ -613,7 +613,7 @@
613 613  |(((
614 614  version
615 615  )))|(((
616 -Angefragte Version: 1
595 +Requested version: 1
617 617  )))
618 618  |(% colspan="1" %)(% colspan="1" %)
619 619  (((
... ... @@ -620,12 +620,12 @@
620 620  sessionId
621 621  )))|(% colspan="1" %)(% colspan="1" %)
622 622  (((
623 -SessionId, wie von armSite zurück geliefert.
602 +SessionId, as returned by armSite.
624 624  )))
625 625  |(((
626 626  secretToShare
627 627  )))|(((
628 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
607 +Shared secret. Has to remain identical at every communication.
629 629  )))
630 630  |(((
631 631  additionalParams
... ... @@ -638,10 +638,10 @@
638 638  |(((
639 639  Boolean
640 640  )))|(((
641 -True bei Erfolg, sonst false.
620 +True if successful, otherwise false.
642 642  )))
643 643  
644 -== Abfrage von Lernerresultaten durch LMS ==
623 +== Request of learning results through the LMS ==
645 645  
646 646  {{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
647 647   @WebMethod(operationName = „getResultValues")
... ... @@ -660,7 +660,7 @@
660 660  |(((
661 661  version
662 662  )))|(((
663 -Angefragte Version: 1
642 +Requested version: 1
664 664  )))
665 665  |(% colspan="1" %)(% colspan="1" %)
666 666  (((
... ... @@ -667,17 +667,17 @@
667 667  sessionId
668 668  )))|(% colspan="1" %)(% colspan="1" %)
669 669  (((
670 -SessionId, wie von armSite zurück geliefert.
649 +SessionId, as returned by armSite.
671 671  )))
672 672  |(((
673 673  secretToShare
674 674  )))|(((
675 -Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
654 +Shared secret. Has to remain identical at every communication.
676 676  )))
677 677  |(((
678 678  requestedValues
679 679  )))|(((
680 -Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
659 +Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
681 681  )))
682 682  |(((
683 683  additionalParams
... ... @@ -690,10 +690,10 @@
690 690  |(((
691 691  HashMap<String, String>
692 692  )))|(((
693 -Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
672 +Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
694 694  )))
695 695  
696 -== Abfrage von Ergebnisvariablen durch LMS ==
675 +== Request of result variables through the LMS ==
697 697  
698 698  {{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
699 699   @WebMethod(operationName = „getResultVariables")
... ... @@ -709,12 +709,12 @@
709 709  |(((
710 710  version
711 711  )))|(((
712 -Angefragte Version: 1
691 +Requested version: 1
713 713  )))
714 714  |(((
715 715  contentPackage
716 716  )))|(((
717 -Content Package (gezippt) als Byte-Array.
696 +Content package (zipped) as byte array.
718 718  )))
719 719  |(((
720 720  additionalParams
... ... @@ -727,14 +727,15 @@
727 727  |(((
728 728  HashMap<String, String>
729 729  )))|(((
730 -Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
709 +Map of result variables, key is the variable name, value the corresponding
710 +value (HashMap is wrapped).
731 731  )))
732 732  
733 733  == Wrapper ==
734 734  
735 -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.
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.
736 736  
737 -=== Wrapper für die HashMap<String, String> ===
717 +=== Wrapper for HashMap<String, String> ===
738 738  
739 739  HashMapWrapper.java:
740 740  
... ... @@ -742,7 +742,7 @@
742 742  
743 743  [[image:attach:HashMapWrapperjava2.png]]
744 744  
745 -=== Wrapper für die ArrayList<ResultsForStudent> ===
725 +=== Wrapper for the ArrayList<ResultsForStudent> ===
746 746  
747 747  ResultsForStudentsWrapper.java:
748 748  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342793
1 +3342937
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342793/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342937/Schnittstelle ONYX Reporter