Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 349.1
bearbeitet von Carina Enke
am 05.03.2018
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 1.11.
Auf Version 390.4
bearbeitet von Carina Enke
am 18.12.2023
Änderungskommentar: Update document after refactoring.

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +00 Onyx.Hilfe.Systeminformationen.WebHome
Inhalt
... ... @@ -6,16 +6,18 @@
6 6  
7 7  {{layout-section ac:type="two_right_sidebar"}}
8 8  {{layout-cell}}
9 -====== Inhalt: ======
9 +\\
10 +{{/layout-cell}}
10 10  
12 +{{layout-cell}}
13 +{{scroll-ignore}}
14 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
11 11  
12 12  
13 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
17 +{{toc/}}
18 +{{/panel}}
19 +{{/scroll-ignore}}
14 14  {{/layout-cell}}
15 -
16 -{{layout-cell}}
17 -
18 -{{/layout-cell}}
19 19  {{/layout-section}}
20 20  
21 21  {{layout-section ac:type="single"}}
... ... @@ -24,6 +24,7 @@
24 24  
25 25  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
26 26  
29 +(% class="wrapped" %)
27 27  |(((
28 28  armSite
29 29  )))|(((
... ... @@ -69,6 +69,7 @@
69 69  
70 70  === Parameter armSite ===
71 71  
75 +(% class="wrapped" %)
72 72  |(((
73 73  version
74 74  )))|(((
... ... @@ -111,6 +111,7 @@
111 111  
112 112  === ReturnValue armSite ===
113 113  
118 +(% class="wrapped" %)
114 114  |(((
115 115  String
116 116  )))|(((
... ... @@ -133,6 +133,7 @@
133 133  
134 134  === Parameter initiateSite ===
135 135  
141 +(% class="wrapped" %)
136 136  |(((
137 137  version
138 138  )))|(((
... ... @@ -168,6 +168,7 @@
168 168  
169 169  === ReturnValue initiateSite ===
170 170  
177 +(% class="wrapped" %)
171 171  |(((
172 172  String
173 173  )))|(((
... ... @@ -191,7 +191,7 @@
191 191  
192 192  == Abmeldung durch LMS ==
193 193  
194 -
201 +\\
195 195  
196 196  {{code}}
197 197  @WebMethod(operationName = „disarmSite")
... ... @@ -203,10 +203,11 @@
203 203  }
204 204  {{/code}}
205 205  
206 -
213 +\\
207 207  
208 208  === Parameter disarmSite ===
209 209  
217 +(% class="wrapped" %)
210 210  |(((
211 211  version
212 212  )))|(((
... ... @@ -232,6 +232,7 @@
232 232  
233 233  === ReturnValue disarmSite ===
234 234  
243 +(% class="wrapped" %)
235 235  |(((
236 236  Boolean
237 237  )))|(((
... ... @@ -254,6 +254,7 @@
254 254  
255 255  === Parameter getResultValues ===
256 256  
266 +(% class="wrapped" %)
257 257  |(((
258 258  version
259 259  )))|(((
... ... @@ -284,6 +284,7 @@
284 284  
285 285  === ReturnValue getResultValues ===
286 286  
297 +(% class="wrapped" %)
287 287  |(((
288 288  HashMap<String, String>
289 289  )))|(((
... ... @@ -303,6 +303,7 @@
303 303  
304 304  === Parameter getResultVariables ===
305 305  
317 +(% class="wrapped" %)
306 306  |(((
307 307  version
308 308  )))|(((
... ... @@ -321,6 +321,7 @@
321 321  
322 322  === ReturnValue getResultVariables ===
323 323  
336 +(% class="wrapped" %)
324 324  |(((
325 325  HashMap<String, String>
326 326  )))|(((
... ... @@ -349,7 +349,7 @@
349 349  
350 350  {{layout-section ac:type="two_right_sidebar"}}
351 351  {{layout-cell}}
352 -
365 +\\
353 353  {{/layout-cell}}
354 354  
355 355  {{layout-cell}}
... ... @@ -379,29 +379,29 @@
379 379  
380 380  {{layout-section ac:type="single"}}
381 381  {{layout-cell}}
382 -== General ==
395 +== General information ==
383 383  
384 -The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
397 +The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
385 385  
386 386  |(((
387 387  armSite
388 388  )))|(((
389 -Registration of sequence requests at the ONYX reporter
402 +Registration of sequence requests at the ONYX Reporter
390 390  )))
391 391  |(((
392 392  initiateSite
393 393  )))|(((
394 -Initiates the reporter session (transmission of the CP).
407 +Initiates the Reporter session (transmission of the CP).
395 395  )))
396 396  |(((
397 397  disarmSite
398 398  )))|(((
399 -Release of all reporter resources for this session.
412 +Release of all Reporter resources for this session.
400 400  )))
401 401  |(((
402 402  getResultValues
403 403  )))|(((
404 -Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
417 +Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
405 405  )))
406 406  |(% colspan="1" %)(% colspan="1" %)
407 407  (((
... ... @@ -408,12 +408,12 @@
408 408  getResultVariables
409 409  )))|(% colspan="1" %)(% colspan="1" %)
410 410  (((
411 -Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
424 +Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
412 412  )))
413 413  
414 -== Connection to the LMS ==
427 +== Login through the LMS ==
415 415  
416 -{{code language="xml" title="Anmeldung des LMS"}}
429 +{{code language="xml" title="Login through the LMS"}}
417 417  @WebMethod(operationName = „armSite")
418 418  public String armSite(
419 419  @WebParam(name = „version") final Integer version,
... ... @@ -436,22 +436,22 @@
436 436  |(((
437 437  userId
438 438  )))|(((
439 -UserId of the requested reporter user
452 +UserId of the requested Reporter user
440 440  )))
441 441  |(((
442 442  optionalRole
443 443  )))|(((
444 -Optional. User role. 0=student, 1=tutor
457 +Optional. User role. 0 = student, 1 = tutor
445 445  )))
446 446  |(((
447 447  secretToShare
448 448  )))|(((
449 -Shared secret. Has to remain identical for every communication.
462 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
450 450  )))
451 451  |(((
452 452  optionalUserLastName
453 453  )))|(((
454 -Optional. User lastname.
467 +Optional. Last name of the user.
455 455  )))
456 456  |(% colspan="1" %)(% colspan="1" %)
457 457  (((
... ... @@ -458,7 +458,7 @@
458 458  optionalUserFirstName
459 459  )))|(% colspan="1" %)(% colspan="1" %)
460 460  (((
461 -Optional. User firstname.
474 +Optional. First name of the user.
462 462  )))
463 463  |(% colspan="1" %)(% colspan="1" %)
464 464  (((
... ... @@ -473,12 +473,12 @@
473 473  |(((
474 474  String
475 475  )))|(((
476 -Session ID that has to be used to mark any further reporter call.
489 +Session ID which has to be used to mark any other Reporter call.
477 477  )))
478 478  
479 479  == Initialisation through LMS ==
480 480  
481 -{{code language="xml" title="Initialisierung durch LMS"}}
494 +{{code language="xml" title="Initialisation through LMS"}}
482 482  @WebMethod(operationName = „initiateSite")
483 483  public String initiateSite(
484 484  @WebParam(name = „version") final Integer version,
... ... @@ -507,17 +507,17 @@
507 507  |(((
508 508  secretToShare
509 509  )))|(((
510 -Shared secret. Has to remain identical at every communication.
523 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
511 511  )))
512 512  |(((
513 513  students
514 514  )))|(((
515 -List of students with their results. See below.
528 +List of students and their results. See below.
516 516  )))
517 517  |(((
518 518  optionalContentPackage
519 519  )))|(((
520 -Optional. Content Package (zipped) as byte array.
533 +Optional. Content package (zipped) as byte array.
521 521  )))
522 522  |(((
523 523  additionalParams
... ... @@ -530,11 +530,11 @@
530 530  |(((
531 531  String
532 532  )))|(((
533 -Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
546 +Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
534 534  
535 -* sid: Session ID as returned by armSite
548 +* sid: Session ID, as returned by armSite
536 536  * (((
537 -uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
550 +uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
538 538  )))
539 539  )))
540 540  
... ... @@ -550,7 +550,7 @@
550 550  }
551 551  {{/code}}
552 552  
553 -== Deconnection through the LMS ==
566 +== Logout through the LMS ==
554 554  
555 555  
556 556  
... ... @@ -583,7 +583,7 @@
583 583  |(((
584 584  secretToShare
585 585  )))|(((
586 -Shared secret. Has to remain identical at every communication.
599 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
587 587  )))
588 588  |(((
589 589  additionalParams
... ... @@ -596,12 +596,12 @@
596 596  |(((
597 597  Boolean
598 598  )))|(((
599 -True if successful, otherwise false.
612 +True in the case of success, otherwise false.
600 600  )))
601 601  
602 -== Request of learning results through the LMS ==
615 +== Request of learner results through the LMS ==
603 603  
604 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
617 +{{code language="xml" title="Request of learner results through the LMS"}}
605 605   @WebMethod(operationName = „getResultValues")
606 606  public HashMapWrapper getResultValues(
607 607   @WebParam(name = „version") final Integer version,
... ... @@ -630,12 +630,12 @@
630 630  |(((
631 631  secretToShare
632 632  )))|(((
633 -Shared secret. Has to remain identical at every communication.
646 +A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
634 634  )))
635 635  |(((
636 636  requestedValues
637 637  )))|(((
638 -Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
651 +Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
639 639  )))
640 640  |(((
641 641  additionalParams
... ... @@ -648,12 +648,12 @@
648 648  |(((
649 649  HashMap<String, String>
650 650  )))|(((
651 -Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
664 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
652 652  )))
653 653  
654 654  == Request of result variables through the LMS ==
655 655  
656 -{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
669 +{{code language="xml" title="Request of result variables through the LMS"}}
657 657   @WebMethod(operationName = „getResultVariables")
658 658  public HashMapWrapper getResultVariables(
659 659  @WebParam(name = „version") final Integer version,
... ... @@ -685,13 +685,12 @@
685 685  |(((
686 686  HashMap<String, String>
687 687  )))|(((
688 -Map of result variables, key is the variable name, value the corresponding
689 -value (HashMap is wrapped).
701 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
690 690  )))
691 691  
692 692  == Wrapper ==
693 693  
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.
706 +Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
695 695  
696 696  === Wrapper for HashMap<String, String> ===
697 697  
HashMapWrapperjava.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Größe
... ... @@ -1,0 +1,1 @@
1 +135.3 KB
Inhalt
HashMapWrapperjava2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Größe
... ... @@ -1,0 +1,1 @@
1 +187.3 KB
Inhalt
ResultsForStudentsWrapperjava.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Größe
... ... @@ -1,0 +1,1 @@
1 +83.3 KB
Inhalt
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -147882103
1 +3342390
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/147882103/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter