Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von 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.
Auf Version 352.1
bearbeitet von Carina Enke
am 08.03.2018
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.11.1.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,103 +1,21 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="single"}}
4 -{{layout-cell}}
5 -
6 -
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"/}}
22 -
23 -{{status colour="Green" title="Fertig"/}}
24 -)))
25 -)))
26 -|=(% colspan="1" %)(% colspan="1" %)
27 -(((
28 -Varianten
29 -)))|(% colspan="1" %)(% colspan="1" %)
30 -(((
31 -(% class="content-wrapper" %)
32 -(((
33 -{{sv-metadata type="variants"/}}
34 -)))
35 -)))
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
64 -
65 -{{status colour="Green" title="Fertig"/}}
66 -)))
67 -)))
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}}
84 -{{/layout-cell}}
4 +{{layout-cell}}{{/layout-cell}}
85 85  {{/layout-section}}
86 86  
87 87  {{layout-section ac:type="two_right_sidebar"}}
88 88  {{layout-cell}}
89 -\\
90 -{{/layout-cell}}
9 +====== Inhalt: ======
91 91  
92 -{{layout-cell}}
93 -{{scroll-ignore}}
94 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
95 95  
96 96  
97 -{{toc/}}
98 -{{/panel}}
99 -{{/scroll-ignore}}
13 +{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
100 100  {{/layout-cell}}
15 +
16 +{{layout-cell}}
17 +
18 +{{/layout-cell}}
101 101  {{/layout-section}}
102 102  
103 103  {{layout-section ac:type="single"}}
... ... @@ -106,7 +106,6 @@
106 106  
107 107  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
108 108  
109 -(% class="wrapped" %)
110 110  |(((
111 111  armSite
112 112  )))|(((
... ... @@ -152,7 +152,6 @@
152 152  
153 153  === Parameter armSite ===
154 154  
155 -(% class="wrapped" %)
156 156  |(((
157 157  version
158 158  )))|(((
... ... @@ -195,7 +195,6 @@
195 195  
196 196  === ReturnValue armSite ===
197 197  
198 -(% class="wrapped" %)
199 199  |(((
200 200  String
201 201  )))|(((
... ... @@ -218,7 +218,6 @@
218 218  
219 219  === Parameter initiateSite ===
220 220  
221 -(% class="wrapped" %)
222 222  |(((
223 223  version
224 224  )))|(((
... ... @@ -254,7 +254,6 @@
254 254  
255 255  === ReturnValue initiateSite ===
256 256  
257 -(% class="wrapped" %)
258 258  |(((
259 259  String
260 260  )))|(((
... ... @@ -278,7 +278,7 @@
278 278  
279 279  == Abmeldung durch LMS ==
280 280  
281 -\\
194 +
282 282  
283 283  {{code}}
284 284  @WebMethod(operationName = „disarmSite")
... ... @@ -290,11 +290,10 @@
290 290  }
291 291  {{/code}}
292 292  
293 -\\
206 +
294 294  
295 295  === Parameter disarmSite ===
296 296  
297 -(% class="wrapped" %)
298 298  |(((
299 299  version
300 300  )))|(((
... ... @@ -320,7 +320,6 @@
320 320  
321 321  === ReturnValue disarmSite ===
322 322  
323 -(% class="wrapped" %)
324 324  |(((
325 325  Boolean
326 326  )))|(((
... ... @@ -343,7 +343,6 @@
343 343  
344 344  === Parameter getResultValues ===
345 345  
346 -(% class="wrapped" %)
347 347  |(((
348 348  version
349 349  )))|(((
... ... @@ -374,7 +374,6 @@
374 374  
375 375  === ReturnValue getResultValues ===
376 376  
377 -(% class="wrapped" %)
378 378  |(((
379 379  HashMap<String, String>
380 380  )))|(((
... ... @@ -394,7 +394,6 @@
394 394  
395 395  === Parameter getResultVariables ===
396 396  
397 -(% class="wrapped" %)
398 398  |(((
399 399  version
400 400  )))|(((
... ... @@ -413,7 +413,6 @@
413 413  
414 414  === ReturnValue getResultVariables ===
415 415  
416 -(% class="wrapped" %)
417 417  |(((
418 418  HashMap<String, String>
419 419  )))|(((
... ... @@ -442,7 +442,7 @@
442 442  
443 443  {{layout-section ac:type="two_right_sidebar"}}
444 444  {{layout-cell}}
445 -\\
352 +
446 446  {{/layout-cell}}
447 447  
448 448  {{layout-cell}}
... ... @@ -472,29 +472,29 @@
472 472  
473 473  {{layout-section ac:type="single"}}
474 474  {{layout-cell}}
475 -== General information ==
382 +== General ==
476 476  
477 -The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
384 +The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
478 478  
479 479  |(((
480 480  armSite
481 481  )))|(((
482 -Registration of sequence requests at the ONYX Reporter
389 +Registration of sequence requests at the ONYX reporter
483 483  )))
484 484  |(((
485 485  initiateSite
486 486  )))|(((
487 -Initiates the Reporter session (transmission of the CP).
394 +Initiates the reporter session (transmission of the CP).
488 488  )))
489 489  |(((
490 490  disarmSite
491 491  )))|(((
492 -Release of all Reporter resources for this session.
399 +Release of all reporter resources for this session.
493 493  )))
494 494  |(((
495 495  getResultValues
496 496  )))|(((
497 -Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
404 +Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
498 498  )))
499 499  |(% colspan="1" %)(% colspan="1" %)
500 500  (((
... ... @@ -501,12 +501,12 @@
501 501  getResultVariables
502 502  )))|(% colspan="1" %)(% colspan="1" %)
503 503  (((
504 -Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
411 +Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
505 505  )))
506 506  
507 -== Login through the LMS ==
414 +== Connection to the LMS ==
508 508  
509 -{{code language="xml" title="Login through the LMS"}}
416 +{{code language="xml" title="Anmeldung des LMS"}}
510 510  @WebMethod(operationName = „armSite")
511 511  public String armSite(
512 512  @WebParam(name = „version") final Integer version,
... ... @@ -529,22 +529,22 @@
529 529  |(((
530 530  userId
531 531  )))|(((
532 -UserId of the requested Reporter user
439 +UserId of the requested reporter user
533 533  )))
534 534  |(((
535 535  optionalRole
536 536  )))|(((
537 -Optional. User role. 0 = student, 1 = tutor
444 +Optional. User role. 0=student, 1=tutor
538 538  )))
539 539  |(((
540 540  secretToShare
541 541  )))|(((
542 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
449 +Shared secret. Has to remain identical for every communication.
543 543  )))
544 544  |(((
545 545  optionalUserLastName
546 546  )))|(((
547 -Optional. Last name of the user.
454 +Optional. User lastname.
548 548  )))
549 549  |(% colspan="1" %)(% colspan="1" %)
550 550  (((
... ... @@ -551,7 +551,7 @@
551 551  optionalUserFirstName
552 552  )))|(% colspan="1" %)(% colspan="1" %)
553 553  (((
554 -Optional. First name of the user.
461 +Optional. User firstname.
555 555  )))
556 556  |(% colspan="1" %)(% colspan="1" %)
557 557  (((
... ... @@ -566,12 +566,12 @@
566 566  |(((
567 567  String
568 568  )))|(((
569 -Session ID which has to be used to mark any other Reporter call.
476 +Session ID that has to be used to mark any further reporter call.
570 570  )))
571 571  
572 572  == Initialisation through LMS ==
573 573  
574 -{{code language="xml" title="Initialisation through LMS"}}
481 +{{code language="xml" title="Initialisierung durch LMS"}}
575 575  @WebMethod(operationName = „initiateSite")
576 576  public String initiateSite(
577 577  @WebParam(name = „version") final Integer version,
... ... @@ -600,17 +600,17 @@
600 600  |(((
601 601  secretToShare
602 602  )))|(((
603 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
510 +Shared secret. Has to remain identical at every communication.
604 604  )))
605 605  |(((
606 606  students
607 607  )))|(((
608 -List of students and their results. See below.
515 +List of students with their results. See below.
609 609  )))
610 610  |(((
611 611  optionalContentPackage
612 612  )))|(((
613 -Optional. Content package (zipped) as byte array.
520 +Optional. Content Package (zipped) as byte array.
614 614  )))
615 615  |(((
616 616  additionalParams
... ... @@ -623,11 +623,11 @@
623 623  |(((
624 624  String
625 625  )))|(((
626 -Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
533 +Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
627 627  
628 -* sid: Session ID, as returned by armSite
535 +* sid: Session ID as returned by armSite
629 629  * (((
630 -uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
537 +uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
631 631  )))
632 632  )))
633 633  
... ... @@ -643,7 +643,7 @@
643 643  }
644 644  {{/code}}
645 645  
646 -== Logout through the LMS ==
553 +== Deconnection through the LMS ==
647 647  
648 648  
649 649  
... ... @@ -676,7 +676,7 @@
676 676  |(((
677 677  secretToShare
678 678  )))|(((
679 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
586 +Shared secret. Has to remain identical at every communication.
680 680  )))
681 681  |(((
682 682  additionalParams
... ... @@ -689,12 +689,12 @@
689 689  |(((
690 690  Boolean
691 691  )))|(((
692 -True in the case of success, otherwise false.
599 +True if successful, otherwise false.
693 693  )))
694 694  
695 -== Request of learner results through the LMS ==
602 +== Request of learning results through the LMS ==
696 696  
697 -{{code language="xml" title="Request of learner results through the LMS"}}
604 +{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
698 698   @WebMethod(operationName = „getResultValues")
699 699  public HashMapWrapper getResultValues(
700 700   @WebParam(name = „version") final Integer version,
... ... @@ -723,12 +723,12 @@
723 723  |(((
724 724  secretToShare
725 725  )))|(((
726 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
633 +Shared secret. Has to remain identical at every communication.
727 727  )))
728 728  |(((
729 729  requestedValues
730 730  )))|(((
731 -Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
638 +Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
732 732  )))
733 733  |(((
734 734  additionalParams
... ... @@ -741,12 +741,12 @@
741 741  |(((
742 742  HashMap<String, String>
743 743  )))|(((
744 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
651 +Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
745 745  )))
746 746  
747 747  == Request of result variables through the LMS ==
748 748  
749 -{{code language="xml" title="Request of result variables through the LMS"}}
656 +{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
750 750   @WebMethod(operationName = „getResultVariables")
751 751  public HashMapWrapper getResultVariables(
752 752  @WebParam(name = „version") final Integer version,
... ... @@ -778,12 +778,13 @@
778 778  |(((
779 779  HashMap<String, String>
780 780  )))|(((
781 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
688 +Map of result variables, key is the variable name, value the corresponding
689 +value (HashMap is wrapped).
782 782  )))
783 783  
784 784  == Wrapper ==
785 785  
786 -Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
694 +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.
787 787  
788 788  === Wrapper for HashMap<String, String> ===
789 789  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -337413507
1 +147882509
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/337413507/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/147882509/Schnittstelle ONYX Reporter