Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 329.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 390.10
bearbeitet von Carina Enke
am 18.12.2023
Änderungskommentar: Update document after refactoring.

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Systeminformationen.WebHome
Inhalt
... ... @@ -1,28 +1,23 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="single"}}
4 -{{layout-cell}}
5 -
6 -
7 -(% class="removedPlaceholderWrapper" %)
8 -
9 -
10 -
11 -{{/layout-cell}}
4 +{{layout-cell}}{{/layout-cell}}
12 12  {{/layout-section}}
13 13  
14 14  {{layout-section ac:type="two_right_sidebar"}}
15 15  {{layout-cell}}
16 -====== Inhalt: ======
9 +\\
10 +{{/layout-cell}}
17 17  
12 +{{layout-cell}}
13 +{{scroll-ignore}}
14 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
18 18  
19 19  
20 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
17 +{{toc/}}
18 +{{/panel}}
19 +{{/scroll-ignore}}
21 21  {{/layout-cell}}
22 -
23 -{{layout-cell}}
24 -
25 -{{/layout-cell}}
26 26  {{/layout-section}}
27 27  
28 28  {{layout-section ac:type="single"}}
... ... @@ -31,6 +31,7 @@
31 31  
32 32  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
33 33  
29 +(% class="wrapped" %)
34 34  |(((
35 35  armSite
36 36  )))|(((
... ... @@ -76,6 +76,7 @@
76 76  
77 77  === Parameter armSite ===
78 78  
75 +(% class="wrapped" %)
79 79  |(((
80 80  version
81 81  )))|(((
... ... @@ -118,6 +118,7 @@
118 118  
119 119  === ReturnValue armSite ===
120 120  
118 +(% class="wrapped" %)
121 121  |(((
122 122  String
123 123  )))|(((
... ... @@ -140,6 +140,7 @@
140 140  
141 141  === Parameter initiateSite ===
142 142  
141 +(% class="wrapped" %)
143 143  |(((
144 144  version
145 145  )))|(((
... ... @@ -175,6 +175,7 @@
175 175  
176 176  === ReturnValue initiateSite ===
177 177  
177 +(% class="wrapped" %)
178 178  |(((
179 179  String
180 180  )))|(((
... ... @@ -198,7 +198,7 @@
198 198  
199 199  == Abmeldung durch LMS ==
200 200  
201 -
201 +\\
202 202  
203 203  {{code}}
204 204  @WebMethod(operationName = „disarmSite")
... ... @@ -210,10 +210,11 @@
210 210  }
211 211  {{/code}}
212 212  
213 -
213 +\\
214 214  
215 215  === Parameter disarmSite ===
216 216  
217 +(% class="wrapped" %)
217 217  |(((
218 218  version
219 219  )))|(((
... ... @@ -239,6 +239,7 @@
239 239  
240 240  === ReturnValue disarmSite ===
241 241  
243 +(% class="wrapped" %)
242 242  |(((
243 243  Boolean
244 244  )))|(((
... ... @@ -261,6 +261,7 @@
261 261  
262 262  === Parameter getResultValues ===
263 263  
266 +(% class="wrapped" %)
264 264  |(((
265 265  version
266 266  )))|(((
... ... @@ -291,6 +291,7 @@
291 291  
292 292  === ReturnValue getResultValues ===
293 293  
297 +(% class="wrapped" %)
294 294  |(((
295 295  HashMap<String, String>
296 296  )))|(((
... ... @@ -310,6 +310,7 @@
310 310  
311 311  === Parameter getResultVariables ===
312 312  
317 +(% class="wrapped" %)
313 313  |(((
314 314  version
315 315  )))|(((
... ... @@ -328,6 +328,7 @@
328 328  
329 329  === ReturnValue getResultVariables ===
330 330  
336 +(% class="wrapped" %)
331 331  |(((
332 332  HashMap<String, String>
333 333  )))|(((
... ... @@ -356,7 +356,7 @@
356 356  
357 357  {{layout-section ac:type="two_right_sidebar"}}
358 358  {{layout-cell}}
359 -
365 +\\
360 360  {{/layout-cell}}
361 361  
362 362  {{layout-cell}}
... ... @@ -386,29 +386,29 @@
386 386  
387 387  {{layout-section ac:type="single"}}
388 388  {{layout-cell}}
389 -== General ==
395 +== General information ==
390 390  
391 -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:
392 392  
393 393  |(((
394 394  armSite
395 395  )))|(((
396 -Registration of sequence requests at the ONYX reporter
402 +Registration of sequence requests at the ONYX Reporter
397 397  )))
398 398  |(((
399 399  initiateSite
400 400  )))|(((
401 -Initiates the reporter session (transmission of the CP).
407 +Initiates the Reporter session (transmission of the CP).
402 402  )))
403 403  |(((
404 404  disarmSite
405 405  )))|(((
406 -Release of all reporter resources for this session.
412 +Release of all Reporter resources for this session.
407 407  )))
408 408  |(((
409 409  getResultValues
410 410  )))|(((
411 -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.
412 412  )))
413 413  |(% colspan="1" %)(% colspan="1" %)
414 414  (((
... ... @@ -415,12 +415,12 @@
415 415  getResultVariables
416 416  )))|(% colspan="1" %)(% colspan="1" %)
417 417  (((
418 -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.
419 419  )))
420 420  
421 -== Connection to the LMS ==
427 +== Login through the LMS ==
422 422  
423 -{{code language="xml" title="Anmeldung des LMS"}}
429 +{{code language="xml" title="Login through the LMS"}}
424 424  @WebMethod(operationName = „armSite")
425 425  public String armSite(
426 426  @WebParam(name = „version") final Integer version,
... ... @@ -443,22 +443,22 @@
443 443  |(((
444 444  userId
445 445  )))|(((
446 -UserId of the requested reporter user
452 +UserId of the requested Reporter user
447 447  )))
448 448  |(((
449 449  optionalRole
450 450  )))|(((
451 -Optional. User role. 0=student, 1=tutor
457 +Optional. User role. 0 = student, 1 = tutor
452 452  )))
453 453  |(((
454 454  secretToShare
455 455  )))|(((
456 -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.
457 457  )))
458 458  |(((
459 459  optionalUserLastName
460 460  )))|(((
461 -Optional. User lastname.
467 +Optional. Last name of the user.
462 462  )))
463 463  |(% colspan="1" %)(% colspan="1" %)
464 464  (((
... ... @@ -465,7 +465,7 @@
465 465  optionalUserFirstName
466 466  )))|(% colspan="1" %)(% colspan="1" %)
467 467  (((
468 -Optional. User firstname.
474 +Optional. First name of the user.
469 469  )))
470 470  |(% colspan="1" %)(% colspan="1" %)
471 471  (((
... ... @@ -480,12 +480,12 @@
480 480  |(((
481 481  String
482 482  )))|(((
483 -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.
484 484  )))
485 485  
486 486  == Initialisation through LMS ==
487 487  
488 -{{code language="xml" title="Initialisierung durch LMS"}}
494 +{{code language="xml" title="Initialisation through LMS"}}
489 489  @WebMethod(operationName = „initiateSite")
490 490  public String initiateSite(
491 491  @WebParam(name = „version") final Integer version,
... ... @@ -514,17 +514,17 @@
514 514  |(((
515 515  secretToShare
516 516  )))|(((
517 -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.
518 518  )))
519 519  |(((
520 520  students
521 521  )))|(((
522 -List of students with their results. See below.
528 +List of students and their results. See below.
523 523  )))
524 524  |(((
525 525  optionalContentPackage
526 526  )))|(((
527 -Optional. Content Package (zipped) as byte array.
533 +Optional. Content package (zipped) as byte array.
528 528  )))
529 529  |(((
530 530  additionalParams
... ... @@ -537,11 +537,11 @@
537 537  |(((
538 538  String
539 539  )))|(((
540 -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:
541 541  
542 -* sid: Session ID as returned by armSite
548 +* sid: Session ID, as returned by armSite
543 543  * (((
544 -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
545 545  )))
546 546  )))
547 547  
... ... @@ -557,7 +557,7 @@
557 557  }
558 558  {{/code}}
559 559  
560 -== Deconnection through the LMS ==
566 +== Logout through the LMS ==
561 561  
562 562  
563 563  
... ... @@ -590,7 +590,7 @@
590 590  |(((
591 591  secretToShare
592 592  )))|(((
593 -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.
594 594  )))
595 595  |(((
596 596  additionalParams
... ... @@ -603,12 +603,12 @@
603 603  |(((
604 604  Boolean
605 605  )))|(((
606 -True if successful, otherwise false.
612 +True in the case of success, otherwise false.
607 607  )))
608 608  
609 -== Request of learning results through the LMS ==
615 +== Request of learner results through the LMS ==
610 610  
611 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
617 +{{code language="xml" title="Request of learner results through the LMS"}}
612 612   @WebMethod(operationName = „getResultValues")
613 613  public HashMapWrapper getResultValues(
614 614   @WebParam(name = „version") final Integer version,
... ... @@ -637,12 +637,12 @@
637 637  |(((
638 638  secretToShare
639 639  )))|(((
640 -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.
641 641  )))
642 642  |(((
643 643  requestedValues
644 644  )))|(((
645 -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.
646 646  )))
647 647  |(((
648 648  additionalParams
... ... @@ -655,12 +655,12 @@
655 655  |(((
656 656  HashMap<String, String>
657 657  )))|(((
658 -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)
659 659  )))
660 660  
661 661  == Request of result variables through the LMS ==
662 662  
663 -{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
669 +{{code language="xml" title="Request of result variables through the LMS"}}
664 664   @WebMethod(operationName = „getResultVariables")
665 665  public HashMapWrapper getResultVariables(
666 666  @WebParam(name = „version") final Integer version,
... ... @@ -692,13 +692,12 @@
692 692  |(((
693 693  HashMap<String, String>
694 694  )))|(((
695 -Map of result variables, key is the variable name, value the corresponding
696 -value (HashMap is wrapped).
701 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
697 697  )))
698 698  
699 699  == Wrapper ==
700 700  
701 -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.
702 702  
703 703  === Wrapper for HashMap<String, String> ===
704 704  
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 -182190540
1 +3342390
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/182190540/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter