Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 381.1
bearbeitet von sandra_riediger
am 17.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 379.1
bearbeitet von sandra_riediger
am 15.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 style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
9 +{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
10 10  {{/layout-cell}}
11 11  
12 12  {{layout-cell}}
... ... @@ -392,7 +392,30 @@
392 392  {{/layout-cell}}
393 393  
394 394  {{layout-cell}}
395 +|=(% colspan="1" %)(% colspan="1" %)
396 +(((
397 +Programmversion
398 +)))|(% colspan="1" %)(% colspan="1" %)
399 +(((
395 395  
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 +)))
396 396  {{/layout-cell}}
397 397  {{/layout-section}}
398 398  
... ... @@ -400,29 +400,29 @@
400 400  {{layout-cell}}
401 401  
402 402  
403 -== General ==
426 +== Allgemeines ==
404 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:
428 +Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
406 406  
407 407  |(((
408 408  armSite
409 409  )))|(((
410 -Registration of sequence requests at the ONYX reporter
433 +Anmeldung von Folgerequests beim ONYX Reporter.
411 411  )))
412 412  |(((
413 413  initiateSite
414 414  )))|(((
415 -Initiates the reporter session (transmission of the CP).
438 +Initiiert die Reporter-Session (Übertragung des CPs).
416 416  )))
417 417  |(((
418 418  disarmSite
419 419  )))|(((
420 -Release of all reporter resources for this session.
443 +Freigabe von allen Reporter-Ressourcen für diese Session.
421 421  )))
422 422  |(((
423 423  getResultValues
424 424  )))|(((
425 -Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
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.
426 426  )))
427 427  |(% colspan="1" %)(% colspan="1" %)
428 428  (((
... ... @@ -429,10 +429,10 @@
429 429  getResultVariables
430 430  )))|(% colspan="1" %)(% colspan="1" %)
431 431  (((
432 -Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
455 +Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich.
433 433  )))
434 434  
435 -== Connection to the LMS ==
458 +== Anmeldung des LMS ==
436 436  
437 437  {{code title="Anmeldung des LMS" language="xml"}}
438 438  @WebMethod(operationName = „armSite")
... ... @@ -452,27 +452,27 @@
452 452  |(((
453 453  version
454 454  )))|(((
455 -Requested version: 1
478 +Angefragte Version: 1
456 456  )))
457 457  |(((
458 458  userId
459 459  )))|(((
460 -UserId of the requested reporter user
483 +UserId des anfragenden Reporter-Benutzers
461 461  )))
462 462  |(((
463 463  optionalRole
464 464  )))|(((
465 -Optional. User role. 0=student, 1=tutor
488 +Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
466 466  )))
467 467  |(((
468 468  secretToShare
469 469  )))|(((
470 -Shared secret. Has to remain identical for every communication.
493 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
471 471  )))
472 472  |(((
473 473  optionalUserLastName
474 474  )))|(((
475 -Optional. User lastname.
498 +Optional. Nachname des Benutzers.
476 476  )))
477 477  |(% colspan="1" %)(% colspan="1" %)
478 478  (((
... ... @@ -479,7 +479,7 @@
479 479  optionalUserFirstName
480 480  )))|(% colspan="1" %)(% colspan="1" %)
481 481  (((
482 -Optional. User firstname.
505 +Optional. Vorname des Benutzers.
483 483  )))
484 484  |(% colspan="1" %)(% colspan="1" %)
485 485  (((
... ... @@ -494,10 +494,10 @@
494 494  |(((
495 495  String
496 496  )))|(((
497 -Session ID that has to be used to mark any further reporter call.
520 +Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
498 498  )))
499 499  
500 -== Initialisation through LMS ==
523 +== Initialisierung durch LMS ==
501 501  
502 502  {{code title="Initialisierung durch LMS" language="xml"}}
503 503  @WebMethod(operationName = „initiateSite")
... ... @@ -516,7 +516,7 @@
516 516  |(((
517 517  version
518 518  )))|(((
519 -Requested version: 1
542 +Angefragte Version: 1
520 520  )))
521 521  |(% colspan="1" %)(% colspan="1" %)
522 522  (((
... ... @@ -523,22 +523,22 @@
523 523  sessionId
524 524  )))|(% colspan="1" %)(% colspan="1" %)
525 525  (((
526 -SessionId, as returned by armSite.
549 +SessionId, wie von armSite zurück geliefert.
527 527  )))
528 528  |(((
529 529  secretToShare
530 530  )))|(((
531 -Shared secret. Has to remain identical at every communication.
554 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
532 532  )))
533 533  |(((
534 534  students
535 535  )))|(((
536 -List of students with their results. See below.
559 +Liste der Studenten mit ihren Resultaten. Siehe unten.
537 537  )))
538 538  |(((
539 539  optionalContentPackage
540 540  )))|(((
541 -Optional. Content Package (zipped) as byte array.
564 +Optional. Content Package (gezippt) als Byte-Array.
542 542  )))
543 543  |(((
544 544  additionalParams
... ... @@ -551,13 +551,11 @@
551 551  |(((
552 552  String
553 553  )))|(((
554 -Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
577 +Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern:
555 555  
556 -* sid: Session ID as returned by armSite
557 -* (((
558 -uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
579 +* sid: Session ID, wie von armSite zurück gegeben
580 +* uid: Student ID, wie in initiateSite beim Reporter angemeldet
559 559  )))
560 -)))
561 561  
562 562  {{code language="xml"}}
563 563  public class ResultsForStudent {
... ... @@ -571,7 +571,7 @@
571 571  }
572 572  {{/code}}
573 573  
574 -== Deconnection through the LMS ==
595 +== Abmeldung durch LMS ==
575 575  
576 576  
577 577  
... ... @@ -592,7 +592,7 @@
592 592  |(((
593 593  version
594 594  )))|(((
595 -Requested version: 1
616 +Angefragte Version: 1
596 596  )))
597 597  |(% colspan="1" %)(% colspan="1" %)
598 598  (((
... ... @@ -599,12 +599,12 @@
599 599  sessionId
600 600  )))|(% colspan="1" %)(% colspan="1" %)
601 601  (((
602 -SessionId, as returned by armSite.
623 +SessionId, wie von armSite zurück geliefert.
603 603  )))
604 604  |(((
605 605  secretToShare
606 606  )))|(((
607 -Shared secret. Has to remain identical at every communication.
628 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
608 608  )))
609 609  |(((
610 610  additionalParams
... ... @@ -617,10 +617,10 @@
617 617  |(((
618 618  Boolean
619 619  )))|(((
620 -True if successful, otherwise false.
641 +True bei Erfolg, sonst false.
621 621  )))
622 622  
623 -== Request of learning results through the LMS ==
644 +== Abfrage von Lernerresultaten durch LMS ==
624 624  
625 625  {{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
626 626   @WebMethod(operationName = „getResultValues")
... ... @@ -639,7 +639,7 @@
639 639  |(((
640 640  version
641 641  )))|(((
642 -Requested version: 1
663 +Angefragte Version: 1
643 643  )))
644 644  |(% colspan="1" %)(% colspan="1" %)
645 645  (((
... ... @@ -646,17 +646,17 @@
646 646  sessionId
647 647  )))|(% colspan="1" %)(% colspan="1" %)
648 648  (((
649 -SessionId, as returned by armSite.
670 +SessionId, wie von armSite zurück geliefert.
650 650  )))
651 651  |(((
652 652  secretToShare
653 653  )))|(((
654 -Shared secret. Has to remain identical at every communication.
675 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben.
655 655  )))
656 656  |(((
657 657  requestedValues
658 658  )))|(((
659 -Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
680 +Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück.
660 660  )))
661 661  |(((
662 662  additionalParams
... ... @@ -669,10 +669,10 @@
669 669  |(((
670 670  HashMap<String, String>
671 671  )))|(((
672 -Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
693 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
673 673  )))
674 674  
675 -== Request of result variables through the LMS ==
696 +== Abfrage von Ergebnisvariablen durch LMS ==
676 676  
677 677  {{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
678 678   @WebMethod(operationName = „getResultVariables")
... ... @@ -688,12 +688,12 @@
688 688  |(((
689 689  version
690 690  )))|(((
691 -Requested version: 1
712 +Angefragte Version: 1
692 692  )))
693 693  |(((
694 694  contentPackage
695 695  )))|(((
696 -Content package (zipped) as byte array.
717 +Content Package (gezippt) als Byte-Array.
697 697  )))
698 698  |(((
699 699  additionalParams
... ... @@ -706,15 +706,14 @@
706 706  |(((
707 707  HashMap<String, String>
708 708  )))|(((
709 -Map of result variables, key is the variable name, value the corresponding
710 -value (HashMap is wrapped).
730 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt)
711 711  )))
712 712  
713 713  == Wrapper ==
714 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.
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.
716 716  
717 -=== Wrapper for HashMap<String, String> ===
737 +=== Wrapper für die HashMap<String, String> ===
718 718  
719 719  HashMapWrapper.java:
720 720  
... ... @@ -722,7 +722,7 @@
722 722  
723 723  [[image:attach:HashMapWrapperjava2.png]]
724 724  
725 -=== Wrapper for the ArrayList<ResultsForStudent> ===
745 +=== Wrapper für die ArrayList<ResultsForStudent> ===
726 726  
727 727  ResultsForStudentsWrapper.java:
728 728  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342937
1 +3342793
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342937/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342793/Schnittstelle ONYX Reporter