Änderungen von Dokument 08 Schnittstelle ONYX Reporter
Zuletzt geändert von Carina Enke am 13.02.2024
Zusammenfassung
-
Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
-
Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Inhalt
-
... ... @@ -402,7 +402,7 @@ 402 402 |=((( 403 403 Status 404 404 )))|((( 405 -(% class="status-macro aui-lozenge aui-lozenge-error" %)D ONE405 +(% class="status-macro aui-lozenge aui-lozenge-error" %)DRAFT 406 406 ))) 407 407 |=((( 408 408 Aufgaben ... ... @@ -423,29 +423,29 @@ 423 423 {{layout-cell}} 424 424 425 425 426 -== General==426 +== Allgemeines == 427 427 428 - TheAPItothe ONYX WebReporter enablesthecommunicationbetweenthe LMSandthereporter.Therefore,acoupleofcommands willbe executed:428 +Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen: 429 429 430 430 |((( 431 431 armSite 432 432 )))|((( 433 - Registration of sequencerequestsat the ONYXreporter433 +Anmeldung von Folgerequests beim ONYX Reporter. 434 434 ))) 435 435 |((( 436 436 initiateSite 437 437 )))|((( 438 -Initi atesthereportersession (transmissionof the CP).438 +Initiiert die Reporter-Session (Übertragung des CPs). 439 439 ))) 440 440 |((( 441 441 disarmSite 442 442 )))|((( 443 - Release ofallreporterresourcesforthissession.443 +Freigabe von allen Reporter-Ressourcen für diese Session. 444 444 ))) 445 445 |((( 446 446 getResultValues 447 447 )))|((( 448 - Returnsallorallrequestedresultsforthetest.Condition:thereis exactlyonestudent inlisttransmittedintheinitiateSite.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. 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 - Returnsallorallrequestedoutcomevariablesforthetest.NoarmSite, initiateSite or disarmSiteis necessary.455 +Gibt alle bzw. die angeforderten Outcome-Variablen für den Test zurück. Hierfür sind kein armSite, initiateSite oder disarmSite erforderlich. 456 456 ))) 457 457 458 -== Connectionto the LMS ==458 +== Anmeldung des 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 - Requestedversion: 1478 +Angefragte Version: 1 479 479 ))) 480 480 |((( 481 481 userId 482 482 )))|((( 483 -UserId of the requestedreporterser483 +UserId des anfragenden Reporter-Benutzers 484 484 ))) 485 485 |((( 486 486 optionalRole 487 487 )))|((( 488 -Optional. User role. 0=student, 1=tutor488 +Optional. Rolle des Benutzers. 0 = Student, 1= Tutor 489 489 ))) 490 490 |((( 491 491 secretToShare 492 492 )))|((( 493 - Shared secret.Hastoremain identicalfor everycommunication.493 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 494 494 ))) 495 495 |((( 496 496 optionalUserLastName 497 497 )))|((( 498 -Optional. User lastname.498 +Optional. Nachname des Benutzers. 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. Userfirstname.505 +Optional. Vorname des Benutzers. 506 506 ))) 507 507 |(% colspan="1" %)(% colspan="1" %) 508 508 ((( ... ... @@ -517,10 +517,10 @@ 517 517 |((( 518 518 String 519 519 )))|((( 520 -Session ID t hathas to be usedto markanyfurtherreporter call.520 +Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen. 521 521 ))) 522 522 523 -== Initialis ation through LMS ==523 +== Initialisierung durch 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 - Requestedversion: 1542 +Angefragte 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, as returnedbyarmSite.549 +SessionId, wie von armSite zurück geliefert. 550 550 ))) 551 551 |((( 552 552 secretToShare 553 553 )))|((( 554 - Shared secret.Hastoremain identicalateverycommunication.554 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 555 555 ))) 556 556 |((( 557 557 students 558 558 )))|((( 559 -List ofstudentswiththeirresults. Seebelow.559 +Liste der Studenten mit ihren Resultaten. Siehe unten. 560 560 ))) 561 561 |((( 562 562 optionalContentPackage 563 563 )))|((( 564 -Optional. Content Package (zipp ed) asbytearray.564 +Optional. Content Package (gezippt) als Byte-Array. 565 565 ))) 566 566 |((( 567 567 additionalParams ... ... @@ -574,13 +574,11 @@ 574 574 |((( 575 575 String 576 576 )))|((( 577 -Absolute URL of thesite fortheframe.It hasto beenrichedbytheLMSwiththe following URLparameters:577 +Absolute URL der Reporter-Seite für den IFrame. Dieser ist vom LMS durch die folgenden URL-Parameter anzureichern: 578 578 579 -* sid: Session ID as returned by armSite 580 -* ((( 581 -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 582 582 ))) 583 -))) 584 584 585 585 {{code language="xml"}} 586 586 public class ResultsForStudent { ... ... @@ -594,7 +594,7 @@ 594 594 } 595 595 {{/code}} 596 596 597 -== DeconnectionthroughtheLMS ==595 +== Abmeldung durch LMS == 598 598 599 599 600 600 ... ... @@ -615,7 +615,7 @@ 615 615 |((( 616 616 version 617 617 )))|((( 618 - Requestedversion: 1616 +Angefragte Version: 1 619 619 ))) 620 620 |(% colspan="1" %)(% colspan="1" %) 621 621 ((( ... ... @@ -622,12 +622,12 @@ 622 622 sessionId 623 623 )))|(% colspan="1" %)(% colspan="1" %) 624 624 ((( 625 -SessionId, as returnedbyarmSite.623 +SessionId, wie von armSite zurück geliefert. 626 626 ))) 627 627 |((( 628 628 secretToShare 629 629 )))|((( 630 - Shared secret.Hastoremain identicalateverycommunication.628 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 631 631 ))) 632 632 |((( 633 633 additionalParams ... ... @@ -640,10 +640,10 @@ 640 640 |((( 641 641 Boolean 642 642 )))|((( 643 -True i fsuccessful, otherwisefalse.641 +True bei Erfolg, sonst false. 644 644 ))) 645 645 646 -== RequestoflearningresultsthroughtheLMS ==644 +== Abfrage von Lernerresultaten durch LMS == 647 647 648 648 {{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}} 649 649 @WebMethod(operationName = „getResultValues") ... ... @@ -662,7 +662,7 @@ 662 662 |((( 663 663 version 664 664 )))|((( 665 - Requestedversion: 1663 +Angefragte Version: 1 666 666 ))) 667 667 |(% colspan="1" %)(% colspan="1" %) 668 668 ((( ... ... @@ -669,17 +669,17 @@ 669 669 sessionId 670 670 )))|(% colspan="1" %)(% colspan="1" %) 671 671 ((( 672 -SessionId, as returnedbyarmSite.670 +SessionId, wie von armSite zurück geliefert. 673 673 ))) 674 674 |((( 675 675 secretToShare 676 676 )))|((( 677 - Shared secret.Hastoremain identicalateverycommunication.675 +Ein geheimer String, mit dessen Hilfe Server und Client ihre Kommunikation verschlüsseln. Muss bei jeder weiteren Kommunikation gleich bleiben. 678 678 ))) 679 679 |((( 680 680 requestedValues 681 681 )))|((( 682 - Canbe empty,thusallresultvariableswillbereturned.Ifit containskeys,onlythosewillbe returned.680 +Kann leer sein, dann werden alle Result-Variables zurück geliefert. Sind Keys enthalten, so kommen nur diese zurück. 683 683 ))) 684 684 |((( 685 685 additionalParams ... ... @@ -692,10 +692,10 @@ 692 692 |((( 693 693 HashMap<String, String> 694 694 )))|((( 695 -Map ofresultvariables,key ishevariablevaluethecorrespondingvalue (HashMap is wrapped)693 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt) 696 696 ))) 697 697 698 -== RequestofresultvariablesthroughtheLMS ==696 +== Abfrage von Ergebnisvariablen durch LMS == 699 699 700 700 {{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}} 701 701 @WebMethod(operationName = „getResultVariables") ... ... @@ -711,12 +711,12 @@ 711 711 |((( 712 712 version 713 713 )))|((( 714 - Requestedversion: 1712 +Angefragte Version: 1 715 715 ))) 716 716 |((( 717 717 contentPackage 718 718 )))|((( 719 -Content package (zipped) asbytearray.717 +Content Package (gezippt) als Byte-Array. 720 720 ))) 721 721 |((( 722 722 additionalParams ... ... @@ -729,15 +729,14 @@ 729 729 |((( 730 730 HashMap<String, String> 731 731 )))|((( 732 -Map of result variables, key is the variable name, value the corresponding 733 -value (HashMap is wrapped). 730 +Map der Result-Variables, Key ist der Variablenname, Value der jeweilige Wert (HashMap ist gewrappt) 734 734 ))) 735 735 736 736 == Wrapper == 737 737 738 - Asthe transmissionof mapsandlists generateproblemsviaJAX-WS(lists filled bythecustomeraresentwithoutanydataandthusreachthe serverwithoutdata)theyhaveto 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. 739 739 740 -=== Wrapper f or HashMap<String, String> ===737 +=== Wrapper für die HashMap<String, String> === 741 741 742 742 HashMapWrapper.java: 743 743 ... ... @@ -745,7 +745,7 @@ 745 745 746 746 [[image:attach:HashMapWrapperjava2.png]] 747 747 748 -=== Wrapper f orthe ArrayList<ResultsForStudent> ===745 +=== Wrapper für die ArrayList<ResultsForStudent> === 749 749 750 750 ResultsForStudentsWrapper.java: 751 751
- Confluence.Code.ConfluencePageClass[0]
-
- id
-
... ... @@ -1,1 +1,1 @@ 1 -33429 221 +3342793 - url
-
... ... @@ -1,1 +1,1 @@ 1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/33429 22/Schnittstelle ONYX Reporter1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342793/Schnittstelle ONYX Reporter