Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 390.4
bearbeitet von Carina Enke
am 18.12.2023
Änderungskommentar: Update document after refactoring.
Auf Version 381.1
bearbeitet von sandra_riediger
am 17.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,1 +1,0 @@
1 -00 Onyx.Hilfe.Systeminformationen.WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.carina
1 +XWiki.sandra_riediger
Inhalt
... ... @@ -1,22 +1,39 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="single"}}
4 -{{layout-cell}}{{/layout-cell}}
5 -{{/layout-section}}
6 -
7 7  {{layout-section ac:type="two_right_sidebar"}}
8 8  {{layout-cell}}
9 -\\
5 +====== Inhalt: ======
6 +
7 +
8 +
9 +{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
10 10  {{/layout-cell}}
11 11  
12 12  {{layout-cell}}
13 -{{scroll-ignore}}
14 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
13 +|=(% colspan="1" %)(% colspan="1" %)
14 +(((
15 +Programmversion
16 +)))|(% colspan="1" %)(% colspan="1" %)
17 +(((
18 +
19 +)))
20 +|=(((
21 +Status
22 +)))|(((
23 +(% class="status-macro aui-lozenge aui-lozenge-error" %)ENTWURF
24 +)))
25 +|=(((
26 +Aufgaben
27 +)))|(((
28 +
15 15  
16 -
17 -{{toc/}}
18 -{{/panel}}
19 -{{/scroll-ignore}}
30 +
31 +)))
32 +|=(((
33 +JIRA
34 +)))|(((
35 +
36 +)))
20 20  {{/layout-cell}}
21 21  {{/layout-section}}
22 22  
... ... @@ -26,7 +26,6 @@
26 26  
27 27  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
28 28  
29 -(% class="wrapped" %)
30 30  |(((
31 31  armSite
32 32  )))|(((
... ... @@ -57,7 +57,7 @@
57 57  
58 58  == Anmeldung des LMS ==
59 59  
60 -{{code language="xml" title="Anmeldung des LMS"}}
76 +{{code title="Anmeldung des LMS" language="xml"}}
61 61  @WebMethod(operationName = „armSite")
62 62  public String armSite(
63 63  @WebParam(name = „version") final Integer version,
... ... @@ -72,7 +72,6 @@
72 72  
73 73  === Parameter armSite ===
74 74  
75 -(% class="wrapped" %)
76 76  |(((
77 77  version
78 78  )))|(((
... ... @@ -115,7 +115,6 @@
115 115  
116 116  === ReturnValue armSite ===
117 117  
118 -(% class="wrapped" %)
119 119  |(((
120 120  String
121 121  )))|(((
... ... @@ -124,7 +124,7 @@
124 124  
125 125  == Initialisierung durch LMS ==
126 126  
127 -{{code language="xml" title="Initialisierung durch LMS"}}
141 +{{code title="Initialisierung durch LMS" language="xml"}}
128 128  @WebMethod(operationName = „initiateSite")
129 129  public String initiateSite(
130 130  @WebParam(name = „version") final Integer version,
... ... @@ -138,7 +138,6 @@
138 138  
139 139  === Parameter initiateSite ===
140 140  
141 -(% class="wrapped" %)
142 142  |(((
143 143  version
144 144  )))|(((
... ... @@ -174,7 +174,6 @@
174 174  
175 175  === ReturnValue initiateSite ===
176 176  
177 -(% class="wrapped" %)
178 178  |(((
179 179  String
180 180  )))|(((
... ... @@ -198,7 +198,7 @@
198 198  
199 199  == Abmeldung durch LMS ==
200 200  
201 -\\
213 +
202 202  
203 203  {{code}}
204 204  @WebMethod(operationName = „disarmSite")
... ... @@ -210,11 +210,10 @@
210 210  }
211 211  {{/code}}
212 212  
213 -\\
225 +
214 214  
215 215  === Parameter disarmSite ===
216 216  
217 -(% class="wrapped" %)
218 218  |(((
219 219  version
220 220  )))|(((
... ... @@ -240,7 +240,6 @@
240 240  
241 241  === ReturnValue disarmSite ===
242 242  
243 -(% class="wrapped" %)
244 244  |(((
245 245  Boolean
246 246  )))|(((
... ... @@ -249,7 +249,7 @@
249 249  
250 250  == Abfrage von Lernerresultaten durch LMS ==
251 251  
252 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
262 +{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
253 253   @WebMethod(operationName = „getResultValues")
254 254  public HashMapWrapper getResultValues(
255 255   @WebParam(name = „version") final Integer version,
... ... @@ -263,7 +263,6 @@
263 263  
264 264  === Parameter getResultValues ===
265 265  
266 -(% class="wrapped" %)
267 267  |(((
268 268  version
269 269  )))|(((
... ... @@ -294,7 +294,6 @@
294 294  
295 295  === ReturnValue getResultValues ===
296 296  
297 -(% class="wrapped" %)
298 298  |(((
299 299  HashMap<String, String>
300 300  )))|(((
... ... @@ -303,7 +303,7 @@
303 303  
304 304  == Abfrage von Ergebnisvariablen durch LMS ==
305 305  
306 -{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
314 +{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
307 307   @WebMethod(operationName = „getResultVariables")
308 308  public HashMapWrapper getResultVariables(
309 309  @WebParam(name = „version") final Integer version,
... ... @@ -314,7 +314,6 @@
314 314  
315 315  === Parameter getResultVariables ===
316 316  
317 -(% class="wrapped" %)
318 318  |(((
319 319  version
320 320  )))|(((
... ... @@ -333,7 +333,6 @@
333 333  
334 334  === ReturnValue getResultVariables ===
335 335  
336 -(% class="wrapped" %)
337 337  |(((
338 338  HashMap<String, String>
339 339  )))|(((
... ... @@ -342,7 +342,7 @@
342 342  
343 343  == Wrapper ==
344 344  
345 -Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
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.
346 346  
347 347  === Wrapper für die HashMap<String, String> ===
348 348  
... ... @@ -362,13 +362,13 @@
362 362  
363 363  {{layout-section ac:type="two_right_sidebar"}}
364 364  {{layout-cell}}
365 -\\
371 +
366 366  {{/layout-cell}}
367 367  
368 368  {{layout-cell}}
369 369  ====== relevante Links: ======
370 370  
371 -* [[doc:ONYX Player Interface]]
377 +* [[doc:Schnittstelle ONYX WebPlayer]]
372 372  {{/layout-cell}}
373 373  {{/layout-section}}
374 374  {{/layout}}
... ... @@ -382,7 +382,7 @@
382 382  
383 383  
384 384  
385 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
391 +{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
386 386  {{/layout-cell}}
387 387  
388 388  {{layout-cell}}
... ... @@ -392,29 +392,31 @@
392 392  
393 393  {{layout-section ac:type="single"}}
394 394  {{layout-cell}}
395 -== General information ==
401 +
396 396  
397 -The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
403 +== General ==
398 398  
405 +The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
406 +
399 399  |(((
400 400  armSite
401 401  )))|(((
402 -Registration of sequence requests at the ONYX Reporter
410 +Registration of sequence requests at the ONYX reporter
403 403  )))
404 404  |(((
405 405  initiateSite
406 406  )))|(((
407 -Initiates the Reporter session (transmission of the CP).
415 +Initiates the reporter session (transmission of the CP).
408 408  )))
409 409  |(((
410 410  disarmSite
411 411  )))|(((
412 -Release of all Reporter resources for this session.
420 +Release of all reporter resources for this session.
413 413  )))
414 414  |(((
415 415  getResultValues
416 416  )))|(((
417 -Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
425 +Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
418 418  )))
419 419  |(% colspan="1" %)(% colspan="1" %)
420 420  (((
... ... @@ -421,12 +421,12 @@
421 421  getResultVariables
422 422  )))|(% colspan="1" %)(% colspan="1" %)
423 423  (((
424 -Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
432 +Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
425 425  )))
426 426  
427 -== Login through the LMS ==
435 +== Connection to the LMS ==
428 428  
429 -{{code language="xml" title="Login through the LMS"}}
437 +{{code title="Anmeldung des LMS" language="xml"}}
430 430  @WebMethod(operationName = „armSite")
431 431  public String armSite(
432 432  @WebParam(name = „version") final Integer version,
... ... @@ -449,22 +449,22 @@
449 449  |(((
450 450  userId
451 451  )))|(((
452 -UserId of the requested Reporter user
460 +UserId of the requested reporter user
453 453  )))
454 454  |(((
455 455  optionalRole
456 456  )))|(((
457 -Optional. User role. 0 = student, 1 = tutor
465 +Optional. User role. 0=student, 1=tutor
458 458  )))
459 459  |(((
460 460  secretToShare
461 461  )))|(((
462 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
470 +Shared secret. Has to remain identical for every communication.
463 463  )))
464 464  |(((
465 465  optionalUserLastName
466 466  )))|(((
467 -Optional. Last name of the user.
475 +Optional. User lastname.
468 468  )))
469 469  |(% colspan="1" %)(% colspan="1" %)
470 470  (((
... ... @@ -471,7 +471,7 @@
471 471  optionalUserFirstName
472 472  )))|(% colspan="1" %)(% colspan="1" %)
473 473  (((
474 -Optional. First name of the user.
482 +Optional. User firstname.
475 475  )))
476 476  |(% colspan="1" %)(% colspan="1" %)
477 477  (((
... ... @@ -486,12 +486,12 @@
486 486  |(((
487 487  String
488 488  )))|(((
489 -Session ID which has to be used to mark any other Reporter call.
497 +Session ID that has to be used to mark any further reporter call.
490 490  )))
491 491  
492 492  == Initialisation through LMS ==
493 493  
494 -{{code language="xml" title="Initialisation through LMS"}}
502 +{{code title="Initialisierung durch LMS" language="xml"}}
495 495  @WebMethod(operationName = „initiateSite")
496 496  public String initiateSite(
497 497  @WebParam(name = „version") final Integer version,
... ... @@ -520,17 +520,17 @@
520 520  |(((
521 521  secretToShare
522 522  )))|(((
523 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
531 +Shared secret. Has to remain identical at every communication.
524 524  )))
525 525  |(((
526 526  students
527 527  )))|(((
528 -List of students and their results. See below.
536 +List of students with their results. See below.
529 529  )))
530 530  |(((
531 531  optionalContentPackage
532 532  )))|(((
533 -Optional. Content package (zipped) as byte array.
541 +Optional. Content Package (zipped) as byte array.
534 534  )))
535 535  |(((
536 536  additionalParams
... ... @@ -543,11 +543,11 @@
543 543  |(((
544 544  String
545 545  )))|(((
546 -Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
554 +Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
547 547  
548 -* sid: Session ID, as returned by armSite
556 +* sid: Session ID as returned by armSite
549 549  * (((
550 -uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
558 +uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
551 551  )))
552 552  )))
553 553  
... ... @@ -563,7 +563,7 @@
563 563  }
564 564  {{/code}}
565 565  
566 -== Logout through the LMS ==
574 +== Deconnection through the LMS ==
567 567  
568 568  
569 569  
... ... @@ -596,7 +596,7 @@
596 596  |(((
597 597  secretToShare
598 598  )))|(((
599 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
607 +Shared secret. Has to remain identical at every communication.
600 600  )))
601 601  |(((
602 602  additionalParams
... ... @@ -609,12 +609,12 @@
609 609  |(((
610 610  Boolean
611 611  )))|(((
612 -True in the case of success, otherwise false.
620 +True if successful, otherwise false.
613 613  )))
614 614  
615 -== Request of learner results through the LMS ==
623 +== Request of learning results through the LMS ==
616 616  
617 -{{code language="xml" title="Request of learner results through the LMS"}}
625 +{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
618 618   @WebMethod(operationName = „getResultValues")
619 619  public HashMapWrapper getResultValues(
620 620   @WebParam(name = „version") final Integer version,
... ... @@ -643,12 +643,12 @@
643 643  |(((
644 644  secretToShare
645 645  )))|(((
646 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
654 +Shared secret. Has to remain identical at every communication.
647 647  )))
648 648  |(((
649 649  requestedValues
650 650  )))|(((
651 -Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
659 +Can be empty, thus all result variables will be returned. If it contains keys, only those will be returned.
652 652  )))
653 653  |(((
654 654  additionalParams
... ... @@ -661,12 +661,12 @@
661 661  |(((
662 662  HashMap<String, String>
663 663  )))|(((
664 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
672 +Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
665 665  )))
666 666  
667 667  == Request of result variables through the LMS ==
668 668  
669 -{{code language="xml" title="Request of result variables through the LMS"}}
677 +{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
670 670   @WebMethod(operationName = „getResultVariables")
671 671  public HashMapWrapper getResultVariables(
672 672  @WebParam(name = „version") final Integer version,
... ... @@ -698,12 +698,13 @@
698 698  |(((
699 699  HashMap<String, String>
700 700  )))|(((
701 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
709 +Map of result variables, key is the variable name, value the corresponding
710 +value (HashMap is wrapped).
702 702  )))
703 703  
704 704  == Wrapper ==
705 705  
706 -Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
715 +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.
707 707  
708 708  === Wrapper for HashMap<String, String> ===
709 709  
HashMapWrapperjava.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Größe
... ... @@ -1,1 +1,0 @@
1 -135.3 KB
Inhalt
HashMapWrapperjava2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Größe
... ... @@ -1,1 +1,0 @@
1 -187.3 KB
Inhalt
ResultsForStudentsWrapperjava.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Größe
... ... @@ -1,1 +1,0 @@
1 -83.3 KB
Inhalt
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3342390
1 +3342937
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342937/Schnittstelle ONYX Reporter