Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 313.1
bearbeitet von Carina Enke
am 24.09.2018
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.11.1.
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
Inhalt
... ... @@ -4,12 +4,12 @@
4 4  {{layout-cell}}
5 5  
6 6  
7 -{{conditionalcontent 0="Zielgruppe: (BPS)" sv-attr:866DE48701525447C13BC59401CD793F="866DE48701525447C13C469E1E314A59" atlassian-macro-output-type="INLINE"}}
8 8  {{details}}
8 +(% class="wrapped" %)
9 9  |=(((
10 10  Verantwortlicher
11 11  )))|(((
12 -
12 +\\
13 13  )))
14 14  |=(% colspan="1" %)(% colspan="1" %)
15 15  (((
... ... @@ -16,69 +16,88 @@
16 16  Status
17 17  )))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
18 18  (((
19 +(% class="content-wrapper" %)
20 +(((
19 19  {{sv-metadata type="workflow-status"/}}
20 20  
21 21  {{status colour="Green" title="Fertig"/}}
22 22  )))
25 +)))
23 23  |=(% colspan="1" %)(% colspan="1" %)
24 24  (((
25 25  Varianten
26 26  )))|(% colspan="1" %)(% colspan="1" %)
27 27  (((
31 +(% class="content-wrapper" %)
32 +(((
28 28  {{sv-metadata type="variants"/}}
29 29  )))
35 +)))
30 30  |=(% colspan="1" %)(% colspan="1" %)
31 31  (((
32 32  Attribute
33 33  )))|(% colspan="1" %)(% colspan="1" %)
34 34  (((
41 +(% class="content-wrapper" %)
42 +(((
35 35  {{sv-metadata type="attributes"/}}
36 36  )))
45 +)))
37 37  |=(% colspan="1" %)(% colspan="1" %)
38 38  (((
39 39  Pagekey
40 40  )))|(% colspan="1" %)(% colspan="1" %)
41 41  (((
51 +(% class="content-wrapper" %)
52 +(((
42 42  {{sv-metadata type="pagekey"/}}
43 43  )))
55 +)))
44 44  |=(% colspan="1" %)(% colspan="1" %)
45 45  (((
46 46  Übersetzung
47 47  )))|(% colspan="1" %)(% colspan="1" %)
48 48  (((
61 +(% class="content-wrapper" %)
62 +(((
63 + ONYX Reporter interface
49 49  
50 -
51 51  {{status colour="Green" title="Fertig"/}}
52 52  )))
67 +)))
53 53  |=(% colspan="1" %)(% colspan="1" %)
54 54  (((
55 55  TODOs
56 56  )))|(% colspan="1" %)(% colspan="1" %)
57 57  (((
73 +(% class="content-wrapper" %)
74 +(((
58 58  (% class="task-list" %)
59 59  (((
60 60  {{task reference="/Tasks/Task_9" status="Done"}}
61 -carina {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-phXzt"/}}: Übersetzung offen
78 +carina {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-ysSwd"/}}: Übersetzung offen
62 62  {{/task}}
63 63  )))
64 64  )))
82 +)))
65 65  {{/details}}
66 -{{/conditionalcontent}}
67 67  {{/layout-cell}}
68 68  {{/layout-section}}
69 69  
70 70  {{layout-section ac:type="two_right_sidebar"}}
71 71  {{layout-cell}}
72 -====== Inhalt: ======
89 +\\
90 +{{/layout-cell}}
73 73  
92 +{{layout-cell}}
93 +{{scroll-ignore}}
94 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
74 74  
75 75  
76 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
97 +{{toc/}}
98 +{{/panel}}
99 +{{/scroll-ignore}}
77 77  {{/layout-cell}}
78 -
79 -{{layout-cell}}
80 -
81 -{{/layout-cell}}
82 82  {{/layout-section}}
83 83  
84 84  {{layout-section ac:type="single"}}
... ... @@ -87,6 +87,7 @@
87 87  
88 88  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
89 89  
109 +(% class="wrapped" %)
90 90  |(((
91 91  armSite
92 92  )))|(((
... ... @@ -132,6 +132,7 @@
132 132  
133 133  === Parameter armSite ===
134 134  
155 +(% class="wrapped" %)
135 135  |(((
136 136  version
137 137  )))|(((
... ... @@ -174,6 +174,7 @@
174 174  
175 175  === ReturnValue armSite ===
176 176  
198 +(% class="wrapped" %)
177 177  |(((
178 178  String
179 179  )))|(((
... ... @@ -196,6 +196,7 @@
196 196  
197 197  === Parameter initiateSite ===
198 198  
221 +(% class="wrapped" %)
199 199  |(((
200 200  version
201 201  )))|(((
... ... @@ -231,6 +231,7 @@
231 231  
232 232  === ReturnValue initiateSite ===
233 233  
257 +(% class="wrapped" %)
234 234  |(((
235 235  String
236 236  )))|(((
... ... @@ -254,7 +254,7 @@
254 254  
255 255  == Abmeldung durch LMS ==
256 256  
257 -
281 +\\
258 258  
259 259  {{code}}
260 260  @WebMethod(operationName = „disarmSite")
... ... @@ -266,10 +266,11 @@
266 266  }
267 267  {{/code}}
268 268  
269 -
293 +\\
270 270  
271 271  === Parameter disarmSite ===
272 272  
297 +(% class="wrapped" %)
273 273  |(((
274 274  version
275 275  )))|(((
... ... @@ -295,6 +295,7 @@
295 295  
296 296  === ReturnValue disarmSite ===
297 297  
323 +(% class="wrapped" %)
298 298  |(((
299 299  Boolean
300 300  )))|(((
... ... @@ -317,6 +317,7 @@
317 317  
318 318  === Parameter getResultValues ===
319 319  
346 +(% class="wrapped" %)
320 320  |(((
321 321  version
322 322  )))|(((
... ... @@ -347,6 +347,7 @@
347 347  
348 348  === ReturnValue getResultValues ===
349 349  
377 +(% class="wrapped" %)
350 350  |(((
351 351  HashMap<String, String>
352 352  )))|(((
... ... @@ -366,6 +366,7 @@
366 366  
367 367  === Parameter getResultVariables ===
368 368  
397 +(% class="wrapped" %)
369 369  |(((
370 370  version
371 371  )))|(((
... ... @@ -384,6 +384,7 @@
384 384  
385 385  === ReturnValue getResultVariables ===
386 386  
416 +(% class="wrapped" %)
387 387  |(((
388 388  HashMap<String, String>
389 389  )))|(((
... ... @@ -412,7 +412,7 @@
412 412  
413 413  {{layout-section ac:type="two_right_sidebar"}}
414 414  {{layout-cell}}
415 -
445 +\\
416 416  {{/layout-cell}}
417 417  
418 418  {{layout-cell}}
... ... @@ -442,29 +442,29 @@
442 442  
443 443  {{layout-section ac:type="single"}}
444 444  {{layout-cell}}
445 -== General ==
475 +== General information ==
446 446  
447 -The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
477 +The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
448 448  
449 449  |(((
450 450  armSite
451 451  )))|(((
452 -Registration of sequence requests at the ONYX reporter
482 +Registration of sequence requests at the ONYX Reporter
453 453  )))
454 454  |(((
455 455  initiateSite
456 456  )))|(((
457 -Initiates the reporter session (transmission of the CP).
487 +Initiates the Reporter session (transmission of the CP).
458 458  )))
459 459  |(((
460 460  disarmSite
461 461  )))|(((
462 -Release of all reporter resources for this session.
492 +Release of all Reporter resources for this session.
463 463  )))
464 464  |(((
465 465  getResultValues
466 466  )))|(((
467 -Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
497 +Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
468 468  )))
469 469  |(% colspan="1" %)(% colspan="1" %)
470 470  (((
... ... @@ -471,12 +471,12 @@
471 471  getResultVariables
472 472  )))|(% colspan="1" %)(% colspan="1" %)
473 473  (((
474 -Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
504 +Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
475 475  )))
476 476  
477 -== Connection to the LMS ==
507 +== Login through the LMS ==
478 478  
479 -{{code language="xml" title="Anmeldung des LMS"}}
509 +{{code language="xml" title="Login through the LMS"}}
480 480  @WebMethod(operationName = „armSite")
481 481  public String armSite(
482 482  @WebParam(name = „version") final Integer version,
... ... @@ -499,22 +499,22 @@
499 499  |(((
500 500  userId
501 501  )))|(((
502 -UserId of the requested reporter user
532 +UserId of the requested Reporter user
503 503  )))
504 504  |(((
505 505  optionalRole
506 506  )))|(((
507 -Optional. User role. 0=student, 1=tutor
537 +Optional. User role. 0 = student, 1 = tutor
508 508  )))
509 509  |(((
510 510  secretToShare
511 511  )))|(((
512 -Shared secret. Has to remain identical for every communication.
542 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
513 513  )))
514 514  |(((
515 515  optionalUserLastName
516 516  )))|(((
517 -Optional. User lastname.
547 +Optional. Last name of the user.
518 518  )))
519 519  |(% colspan="1" %)(% colspan="1" %)
520 520  (((
... ... @@ -521,7 +521,7 @@
521 521  optionalUserFirstName
522 522  )))|(% colspan="1" %)(% colspan="1" %)
523 523  (((
524 -Optional. User firstname.
554 +Optional. First name of the user.
525 525  )))
526 526  |(% colspan="1" %)(% colspan="1" %)
527 527  (((
... ... @@ -536,12 +536,12 @@
536 536  |(((
537 537  String
538 538  )))|(((
539 -Session ID that has to be used to mark any further reporter call.
569 +Session ID which has to be used to mark any other Reporter call.
540 540  )))
541 541  
542 542  == Initialisation through LMS ==
543 543  
544 -{{code language="xml" title="Initialisierung durch LMS"}}
574 +{{code language="xml" title="Initialisation through LMS"}}
545 545  @WebMethod(operationName = „initiateSite")
546 546  public String initiateSite(
547 547  @WebParam(name = „version") final Integer version,
... ... @@ -570,17 +570,17 @@
570 570  |(((
571 571  secretToShare
572 572  )))|(((
573 -Shared secret. Has to remain identical at every communication.
603 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
574 574  )))
575 575  |(((
576 576  students
577 577  )))|(((
578 -List of students with their results. See below.
608 +List of students and their results. See below.
579 579  )))
580 580  |(((
581 581  optionalContentPackage
582 582  )))|(((
583 -Optional. Content Package (zipped) as byte array.
613 +Optional. Content package (zipped) as byte array.
584 584  )))
585 585  |(((
586 586  additionalParams
... ... @@ -593,11 +593,11 @@
593 593  |(((
594 594  String
595 595  )))|(((
596 -Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
626 +Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
597 597  
598 -* sid: Session ID as returned by armSite
628 +* sid: Session ID, as returned by armSite
599 599  * (((
600 -uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
630 +uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
601 601  )))
602 602  )))
603 603  
... ... @@ -613,7 +613,7 @@
613 613  }
614 614  {{/code}}
615 615  
616 -== Deconnection through the LMS ==
646 +== Logout through the LMS ==
617 617  
618 618  
619 619  
... ... @@ -646,7 +646,7 @@
646 646  |(((
647 647  secretToShare
648 648  )))|(((
649 -Shared secret. Has to remain identical at every communication.
679 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
650 650  )))
651 651  |(((
652 652  additionalParams
... ... @@ -659,12 +659,12 @@
659 659  |(((
660 660  Boolean
661 661  )))|(((
662 -True if successful, otherwise false.
692 +True in the case of success, otherwise false.
663 663  )))
664 664  
665 -== Request of learning results through the LMS ==
695 +== Request of learner results through the LMS ==
666 666  
667 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
697 +{{code language="xml" title="Request of learner results through the LMS"}}
668 668   @WebMethod(operationName = „getResultValues")
669 669  public HashMapWrapper getResultValues(
670 670   @WebParam(name = „version") final Integer version,
... ... @@ -693,12 +693,12 @@
693 693  |(((
694 694  secretToShare
695 695  )))|(((
696 -Shared secret. Has to remain identical at every communication.
726 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
697 697  )))
698 698  |(((
699 699  requestedValues
700 700  )))|(((
701 -Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
731 +Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
702 702  )))
703 703  |(((
704 704  additionalParams
... ... @@ -711,12 +711,12 @@
711 711  |(((
712 712  HashMap<String, String>
713 713  )))|(((
714 -Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
744 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
715 715  )))
716 716  
717 717  == Request of result variables through the LMS ==
718 718  
719 -{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
749 +{{code language="xml" title="Request of result variables through the LMS"}}
720 720   @WebMethod(operationName = „getResultVariables")
721 721  public HashMapWrapper getResultVariables(
722 722  @WebParam(name = „version") final Integer version,
... ... @@ -748,13 +748,12 @@
748 748  |(((
749 749  HashMap<String, String>
750 750  )))|(((
751 -Map of result variables, key is the variable name, value the corresponding
752 -value (HashMap is wrapped).
781 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
753 753  )))
754 754  
755 755  == Wrapper ==
756 756  
757 -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.
786 +Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
758 758  
759 759  === Wrapper for HashMap<String, String> ===
760 760  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -178880909
1 +337413507
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/178880909/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/337413507/Schnittstelle ONYX Reporter