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 239.1
bearbeitet von Carina Enke
am 19.05.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 9.0.

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.sandra_riediger
1 +XWiki.carina
Inhalt
... ... @@ -1,42 +1,105 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="two_right_sidebar"}}
3 +{{layout-section ac:type="single"}}
4 4  {{layout-cell}}
5 -====== Inhalt: ======
6 6  
7 7  
7 +{{details}}
8 +(% class="wrapped" %)
9 +|=(((
10 +Verantwortlicher
11 +)))|(((
12 +\\
13 +)))
14 +|=(% colspan="1" %)(% colspan="1" %)
15 +(((
16 +Status
17 +)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
18 +(((
19 +(% class="content-wrapper" %)
20 +(((
21 +{{sv-metadata type="workflow-status"/}}
8 8  
9 -{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
10 -{{/layout-cell}}
11 -
12 -{{layout-cell}}
23 +{{status colour="Green" title="Fertig"/}}
24 +)))
25 +)))
13 13  |=(% colspan="1" %)(% colspan="1" %)
14 14  (((
15 -Programmversion
28 +Varianten
16 16  )))|(% colspan="1" %)(% colspan="1" %)
17 17  (((
18 -
31 +(% class="content-wrapper" %)
32 +(((
33 +{{sv-metadata type="variants"/}}
19 19  )))
20 -|=(((
21 -Status
22 -)))|(((
23 -(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
24 24  )))
25 -|=(((
26 -Aufgaben
27 -)))|(((
28 -
36 +|=(% colspan="1" %)(% colspan="1" %)
37 +(((
38 +Attribute
39 +)))|(% colspan="1" %)(% colspan="1" %)
40 +(((
41 +(% class="content-wrapper" %)
42 +(((
43 +{{sv-metadata type="attributes"/}}
44 +)))
45 +)))
46 +|=(% colspan="1" %)(% colspan="1" %)
47 +(((
48 +Pagekey
49 +)))|(% colspan="1" %)(% colspan="1" %)
50 +(((
51 +(% class="content-wrapper" %)
52 +(((
53 +{{sv-metadata type="pagekey"/}}
54 +)))
55 +)))
56 +|=(% colspan="1" %)(% colspan="1" %)
57 +(((
58 +Übersetzung
59 +)))|(% colspan="1" %)(% colspan="1" %)
60 +(((
61 +(% class="content-wrapper" %)
62 +(((
63 + ONYX Reporter interface
29 29  
30 -
65 +{{status colour="Green" title="Fertig"/}}
31 31  )))
32 -|=(((
33 -JIRA
34 -)))|(((
35 -
36 36  )))
68 +|=(% colspan="1" %)(% colspan="1" %)
69 +(((
70 +TODOs
71 +)))|(% colspan="1" %)(% colspan="1" %)
72 +(((
73 +(% class="content-wrapper" %)
74 +(((
75 +(% class="task-list" %)
76 +(((
77 +{{task reference="/Tasks/Task_9" status="Done"}}
78 +carina {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-ysSwd"/}}: Übersetzung offen
79 +{{/task}}
80 +)))
81 +)))
82 +)))
83 +{{/details}}
37 37  {{/layout-cell}}
38 38  {{/layout-section}}
39 39  
87 +{{layout-section ac:type="two_right_sidebar"}}
88 +{{layout-cell}}
89 +\\
90 +{{/layout-cell}}
91 +
92 +{{layout-cell}}
93 +{{scroll-ignore}}
94 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
95 +
96 +
97 +{{toc/}}
98 +{{/panel}}
99 +{{/scroll-ignore}}
100 +{{/layout-cell}}
101 +{{/layout-section}}
102 +
40 40  {{layout-section ac:type="single"}}
41 41  {{layout-cell}}
42 42  == Allgemeines ==
... ... @@ -43,6 +43,7 @@
43 43  
44 44  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
45 45  
109 +(% class="wrapped" %)
46 46  |(((
47 47  armSite
48 48  )))|(((
... ... @@ -73,7 +73,7 @@
73 73  
74 74  == Anmeldung des LMS ==
75 75  
76 -{{code title="Anmeldung des LMS" language="xml"}}
140 +{{code language="xml" title="Anmeldung des LMS"}}
77 77  @WebMethod(operationName = „armSite")
78 78  public String armSite(
79 79  @WebParam(name = „version") final Integer version,
... ... @@ -88,6 +88,7 @@
88 88  
89 89  === Parameter armSite ===
90 90  
155 +(% class="wrapped" %)
91 91  |(((
92 92  version
93 93  )))|(((
... ... @@ -130,6 +130,7 @@
130 130  
131 131  === ReturnValue armSite ===
132 132  
198 +(% class="wrapped" %)
133 133  |(((
134 134  String
135 135  )))|(((
... ... @@ -138,7 +138,7 @@
138 138  
139 139  == Initialisierung durch LMS ==
140 140  
141 -{{code title="Initialisierung durch LMS" language="xml"}}
207 +{{code language="xml" title="Initialisierung durch LMS"}}
142 142  @WebMethod(operationName = „initiateSite")
143 143  public String initiateSite(
144 144  @WebParam(name = „version") final Integer version,
... ... @@ -152,6 +152,7 @@
152 152  
153 153  === Parameter initiateSite ===
154 154  
221 +(% class="wrapped" %)
155 155  |(((
156 156  version
157 157  )))|(((
... ... @@ -187,6 +187,7 @@
187 187  
188 188  === ReturnValue initiateSite ===
189 189  
257 +(% class="wrapped" %)
190 190  |(((
191 191  String
192 192  )))|(((
... ... @@ -210,7 +210,7 @@
210 210  
211 211  == Abmeldung durch LMS ==
212 212  
213 -
281 +\\
214 214  
215 215  {{code}}
216 216  @WebMethod(operationName = „disarmSite")
... ... @@ -222,10 +222,11 @@
222 222  }
223 223  {{/code}}
224 224  
225 -
293 +\\
226 226  
227 227  === Parameter disarmSite ===
228 228  
297 +(% class="wrapped" %)
229 229  |(((
230 230  version
231 231  )))|(((
... ... @@ -251,6 +251,7 @@
251 251  
252 252  === ReturnValue disarmSite ===
253 253  
323 +(% class="wrapped" %)
254 254  |(((
255 255  Boolean
256 256  )))|(((
... ... @@ -259,7 +259,7 @@
259 259  
260 260  == Abfrage von Lernerresultaten durch LMS ==
261 261  
262 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
332 +{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
263 263   @WebMethod(operationName = „getResultValues")
264 264  public HashMapWrapper getResultValues(
265 265   @WebParam(name = „version") final Integer version,
... ... @@ -273,6 +273,7 @@
273 273  
274 274  === Parameter getResultValues ===
275 275  
346 +(% class="wrapped" %)
276 276  |(((
277 277  version
278 278  )))|(((
... ... @@ -303,6 +303,7 @@
303 303  
304 304  === ReturnValue getResultValues ===
305 305  
377 +(% class="wrapped" %)
306 306  |(((
307 307  HashMap<String, String>
308 308  )))|(((
... ... @@ -311,7 +311,7 @@
311 311  
312 312  == Abfrage von Ergebnisvariablen durch LMS ==
313 313  
314 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
386 +{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
315 315   @WebMethod(operationName = „getResultVariables")
316 316  public HashMapWrapper getResultVariables(
317 317  @WebParam(name = „version") final Integer version,
... ... @@ -322,6 +322,7 @@
322 322  
323 323  === Parameter getResultVariables ===
324 324  
397 +(% class="wrapped" %)
325 325  |(((
326 326  version
327 327  )))|(((
... ... @@ -340,6 +340,7 @@
340 340  
341 341  === ReturnValue getResultVariables ===
342 342  
416 +(% class="wrapped" %)
343 343  |(((
344 344  HashMap<String, String>
345 345  )))|(((
... ... @@ -348,7 +348,7 @@
348 348  
349 349  == Wrapper ==
350 350  
351 -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.
425 +Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
352 352  
353 353  === Wrapper für die HashMap<String, String> ===
354 354  
... ... @@ -368,13 +368,13 @@
368 368  
369 369  {{layout-section ac:type="two_right_sidebar"}}
370 370  {{layout-cell}}
371 -
445 +\\
372 372  {{/layout-cell}}
373 373  
374 374  {{layout-cell}}
375 375  ====== relevante Links: ======
376 376  
377 -* [[doc:Schnittstelle ONYX WebPlayer]]
451 +* [[doc:ONYX Player Interface]]
378 378  {{/layout-cell}}
379 379  {{/layout-section}}
380 380  {{/layout}}
... ... @@ -388,64 +388,39 @@
388 388  
389 389  
390 390  
391 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
465 +{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
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  
422 422  {{layout-section ac:type="single"}}
423 423  {{layout-cell}}
424 -
475 +== General information ==
425 425  
426 -== Allgemeines ==
477 +The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
427 427  
428 -Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
429 -
430 430  |(((
431 431  armSite
432 432  )))|(((
433 -Anmeldung von Folgerequests beim ONYX Reporter.
482 +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).
487 +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.
492 +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.
497 +Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
449 449  )))
450 450  |(% colspan="1" %)(% colspan="1" %)
451 451  (((
... ... @@ -452,12 +452,12 @@
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.
504 +Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
456 456  )))
457 457  
458 -== Anmeldung des LMS ==
507 +== Login through the LMS ==
459 459  
460 -{{code title="Anmeldung des LMS" language="xml"}}
509 +{{code language="xml" title="Login through the LMS"}}
461 461  @WebMethod(operationName = „armSite")
462 462  public String armSite(
463 463  @WebParam(name = „version") final Integer version,
... ... @@ -475,27 +475,27 @@
475 475  |(((
476 476  version
477 477  )))|(((
478 -Angefragte Version: 1
527 +Requested version: 1
479 479  )))
480 480  |(((
481 481  userId
482 482  )))|(((
483 -UserId des anfragenden Reporter-Benutzers
532 +UserId of the requested Reporter user
484 484  )))
485 485  |(((
486 486  optionalRole
487 487  )))|(((
488 -Optional. Rolle des Benutzers. 0 = Student, 1= Tutor
537 +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.
542 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
494 494  )))
495 495  |(((
496 496  optionalUserLastName
497 497  )))|(((
498 -Optional. Nachname des Benutzers.
547 +Optional. Last name of the user.
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.
554 +Optional. First name of the user.
506 506  )))
507 507  |(% colspan="1" %)(% colspan="1" %)
508 508  (((
... ... @@ -517,12 +517,12 @@
517 517  |(((
518 518  String
519 519  )))|(((
520 -Session ID, mit der alle weiteren Reporter-Aufrufe gekennzeichnet werden müssen.
569 +Session ID which has to be used to mark any other Reporter call.
521 521  )))
522 522  
523 -== Initialisierung durch LMS ==
572 +== Initialisation through LMS ==
524 524  
525 -{{code title="Initialisierung durch LMS" language="xml"}}
574 +{{code language="xml" title="Initialisation through LMS"}}
526 526  @WebMethod(operationName = „initiateSite")
527 527  public String initiateSite(
528 528  @WebParam(name = „version") final Integer version,
... ... @@ -539,7 +539,7 @@
539 539  |(((
540 540  version
541 541  )))|(((
542 -Angefragte Version: 1
591 +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.
598 +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.
603 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
555 555  )))
556 556  |(((
557 557  students
558 558  )))|(((
559 -Liste der Studenten mit ihren Resultaten. Siehe unten.
608 +List of students and their results. See below.
560 560  )))
561 561  |(((
562 562  optionalContentPackage
563 563  )))|(((
564 -Optional. Content Package (gezippt) als Byte-Array.
613 +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:
626 +Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
578 578  
579 -* sid: Session ID, wie von armSite zurück gegeben
580 -* uid: Student ID, wie in initiateSite beim Reporter angemeldet
628 +* sid: Session ID, as returned by armSite
629 +* (((
630 +uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
581 581  )))
632 +)))
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 ==
646 +== Logout through the LMS ==
596 596  
597 597  
598 598  
... ... @@ -613,7 +613,7 @@
613 613  |(((
614 614  version
615 615  )))|(((
616 -Angefragte Version: 1
667 +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.
674 +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.
679 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
629 629  )))
630 630  |(((
631 631  additionalParams
... ... @@ -638,12 +638,12 @@
638 638  |(((
639 639  Boolean
640 640  )))|(((
641 -True bei Erfolg, sonst false.
692 +True in the case of success, otherwise false.
642 642  )))
643 643  
644 -== Abfrage von Lernerresultaten durch LMS ==
695 +== Request of learner results through the LMS ==
645 645  
646 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
697 +{{code language="xml" title="Request of learner results through the LMS"}}
647 647   @WebMethod(operationName = „getResultValues")
648 648  public HashMapWrapper getResultValues(
649 649   @WebParam(name = „version") final Integer version,
... ... @@ -660,7 +660,7 @@
660 660  |(((
661 661  version
662 662  )))|(((
663 -Angefragte Version: 1
714 +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.
721 +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.
726 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further 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.
731 +Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
681 681  )))
682 682  |(((
683 683  additionalParams
... ... @@ -690,12 +690,12 @@
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)
744 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
694 694  )))
695 695  
696 -== Abfrage von Ergebnisvariablen durch LMS ==
747 +== Request of result variables through the LMS ==
697 697  
698 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
749 +{{code language="xml" title="Request of result variables through the LMS"}}
699 699   @WebMethod(operationName = „getResultVariables")
700 700  public HashMapWrapper getResultVariables(
701 701  @WebParam(name = „version") final Integer version,
... ... @@ -709,12 +709,12 @@
709 709  |(((
710 710  version
711 711  )))|(((
712 -Angefragte Version: 1
763 +Requested version: 1
713 713  )))
714 714  |(((
715 715  contentPackage
716 716  )))|(((
717 -Content Package (gezippt) als Byte-Array.
768 +Content package (zipped) as byte array.
718 718  )))
719 719  |(((
720 720  additionalParams
... ... @@ -727,14 +727,14 @@
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)
781 +Map of result variables, key is the variable name, value is the respective variable's 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.
786 +Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
736 736  
737 -=== Wrapper für die HashMap<String, String> ===
788 +=== 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> ===
796 +=== 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 +337413507
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/337413507/Schnittstelle ONYX Reporter