Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 351.1
bearbeitet von tleu
am 23.06.2015
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 390.2
bearbeitet von Carina Enke
am 18.12.2023
Änderungskommentar: Update document after refactoring.

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Hilfe.Systeminformationen.WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.tleu
1 +XWiki.carina
Inhalt
... ... @@ -1,17 +1,23 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 +{{layout-section ac:type="single"}}
4 +{{layout-cell}}{{/layout-cell}}
5 +{{/layout-section}}
6 +
3 3  {{layout-section ac:type="two_right_sidebar"}}
4 4  {{layout-cell}}
5 -====== Inhalt: ======
9 +\\
10 +{{/layout-cell}}
6 6  
12 +{{layout-cell}}
13 +{{scroll-ignore}}
14 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
7 7  
8 8  
9 -{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
17 +{{toc/}}
18 +{{/panel}}
19 +{{/scroll-ignore}}
10 10  {{/layout-cell}}
11 -
12 -{{layout-cell}}
13 -
14 -{{/layout-cell}}
15 15  {{/layout-section}}
16 16  
17 17  {{layout-section ac:type="single"}}
... ... @@ -20,6 +20,7 @@
20 20  
21 21  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
22 22  
29 +(% class="wrapped" %)
23 23  |(((
24 24  armSite
25 25  )))|(((
... ... @@ -65,6 +65,7 @@
65 65  
66 66  === Parameter armSite ===
67 67  
75 +(% class="wrapped" %)
68 68  |(((
69 69  version
70 70  )))|(((
... ... @@ -107,6 +107,7 @@
107 107  
108 108  === ReturnValue armSite ===
109 109  
118 +(% class="wrapped" %)
110 110  |(((
111 111  String
112 112  )))|(((
... ... @@ -129,6 +129,7 @@
129 129  
130 130  === Parameter initiateSite ===
131 131  
141 +(% class="wrapped" %)
132 132  |(((
133 133  version
134 134  )))|(((
... ... @@ -164,6 +164,7 @@
164 164  
165 165  === ReturnValue initiateSite ===
166 166  
177 +(% class="wrapped" %)
167 167  |(((
168 168  String
169 169  )))|(((
... ... @@ -187,7 +187,7 @@
187 187  
188 188  == Abmeldung durch LMS ==
189 189  
190 -
201 +\\
191 191  
192 192  {{code}}
193 193  @WebMethod(operationName = „disarmSite")
... ... @@ -199,10 +199,11 @@
199 199  }
200 200  {{/code}}
201 201  
202 -
213 +\\
203 203  
204 204  === Parameter disarmSite ===
205 205  
217 +(% class="wrapped" %)
206 206  |(((
207 207  version
208 208  )))|(((
... ... @@ -228,6 +228,7 @@
228 228  
229 229  === ReturnValue disarmSite ===
230 230  
243 +(% class="wrapped" %)
231 231  |(((
232 232  Boolean
233 233  )))|(((
... ... @@ -250,6 +250,7 @@
250 250  
251 251  === Parameter getResultValues ===
252 252  
266 +(% class="wrapped" %)
253 253  |(((
254 254  version
255 255  )))|(((
... ... @@ -280,6 +280,7 @@
280 280  
281 281  === ReturnValue getResultValues ===
282 282  
297 +(% class="wrapped" %)
283 283  |(((
284 284  HashMap<String, String>
285 285  )))|(((
... ... @@ -299,6 +299,7 @@
299 299  
300 300  === Parameter getResultVariables ===
301 301  
317 +(% class="wrapped" %)
302 302  |(((
303 303  version
304 304  )))|(((
... ... @@ -317,6 +317,7 @@
317 317  
318 318  === ReturnValue getResultVariables ===
319 319  
336 +(% class="wrapped" %)
320 320  |(((
321 321  HashMap<String, String>
322 322  )))|(((
... ... @@ -325,7 +325,7 @@
325 325  
326 326  == Wrapper ==
327 327  
328 -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.
345 +Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
329 329  
330 330  === Wrapper für die HashMap<String, String> ===
331 331  
... ... @@ -345,13 +345,13 @@
345 345  
346 346  {{layout-section ac:type="two_right_sidebar"}}
347 347  {{layout-cell}}
348 -
365 +\\
349 349  {{/layout-cell}}
350 350  
351 351  {{layout-cell}}
352 352  ====== relevante Links: ======
353 353  
354 -* [[doc:Schnittstelle ONYX Player]]
371 +* [[doc:ONYX Player Interface]]
355 355  {{/layout-cell}}
356 356  {{/layout-section}}
357 357  {{/layout}}
... ... @@ -375,29 +375,29 @@
375 375  
376 376  {{layout-section ac:type="single"}}
377 377  {{layout-cell}}
378 -== General ==
395 +== General information ==
379 379  
380 -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:
381 381  
382 382  |(((
383 383  armSite
384 384  )))|(((
385 -Registration of sequence requests at the ONYX reporter
402 +Registration of sequence requests at the ONYX Reporter
386 386  )))
387 387  |(((
388 388  initiateSite
389 389  )))|(((
390 -Initiates the reporter session (transmission of the CP).
407 +Initiates the Reporter session (transmission of the CP).
391 391  )))
392 392  |(((
393 393  disarmSite
394 394  )))|(((
395 -Release of all reporter resources for this session.
412 +Release of all Reporter resources for this session.
396 396  )))
397 397  |(((
398 398  getResultValues
399 399  )))|(((
400 -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.
401 401  )))
402 402  |(% colspan="1" %)(% colspan="1" %)
403 403  (((
... ... @@ -404,12 +404,12 @@
404 404  getResultVariables
405 405  )))|(% colspan="1" %)(% colspan="1" %)
406 406  (((
407 -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.
408 408  )))
409 409  
410 -== Connection to the LMS ==
427 +== Login through the LMS ==
411 411  
412 -{{code language="xml" title="Anmeldung des LMS"}}
429 +{{code language="xml" title="Login through the LMS"}}
413 413  @WebMethod(operationName = „armSite")
414 414  public String armSite(
415 415  @WebParam(name = „version") final Integer version,
... ... @@ -432,22 +432,22 @@
432 432  |(((
433 433  userId
434 434  )))|(((
435 -UserId of the requested reporter user
452 +UserId of the requested Reporter user
436 436  )))
437 437  |(((
438 438  optionalRole
439 439  )))|(((
440 -Optional. User role. 0=student, 1=tutor
457 +Optional. User role. 0 = student, 1 = tutor
441 441  )))
442 442  |(((
443 443  secretToShare
444 444  )))|(((
445 -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.
446 446  )))
447 447  |(((
448 448  optionalUserLastName
449 449  )))|(((
450 -Optional. User lastname.
467 +Optional. Last name of the user.
451 451  )))
452 452  |(% colspan="1" %)(% colspan="1" %)
453 453  (((
... ... @@ -454,7 +454,7 @@
454 454  optionalUserFirstName
455 455  )))|(% colspan="1" %)(% colspan="1" %)
456 456  (((
457 -Optional. User firstname.
474 +Optional. First name of the user.
458 458  )))
459 459  |(% colspan="1" %)(% colspan="1" %)
460 460  (((
... ... @@ -469,12 +469,12 @@
469 469  |(((
470 470  String
471 471  )))|(((
472 -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.
473 473  )))
474 474  
475 475  == Initialisation through LMS ==
476 476  
477 -{{code language="xml" title="Initialisierung durch LMS"}}
494 +{{code language="xml" title="Initialisation through LMS"}}
478 478  @WebMethod(operationName = „initiateSite")
479 479  public String initiateSite(
480 480  @WebParam(name = „version") final Integer version,
... ... @@ -503,17 +503,17 @@
503 503  |(((
504 504  secretToShare
505 505  )))|(((
506 -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.
507 507  )))
508 508  |(((
509 509  students
510 510  )))|(((
511 -List of students with their results. See below.
528 +List of students and their results. See below.
512 512  )))
513 513  |(((
514 514  optionalContentPackage
515 515  )))|(((
516 -Optional. Content Package (zipped) as byte array.
533 +Optional. Content package (zipped) as byte array.
517 517  )))
518 518  |(((
519 519  additionalParams
... ... @@ -526,11 +526,11 @@
526 526  |(((
527 527  String
528 528  )))|(((
529 -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:
530 530  
531 -* sid: Session ID as returned by armSite
548 +* sid: Session ID, as returned by armSite
532 532  * (((
533 -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
534 534  )))
535 535  )))
536 536  
... ... @@ -546,7 +546,7 @@
546 546  }
547 547  {{/code}}
548 548  
549 -== Deconnection through the LMS ==
566 +== Logout through the LMS ==
550 550  
551 551  
552 552  
... ... @@ -579,7 +579,7 @@
579 579  |(((
580 580  secretToShare
581 581  )))|(((
582 -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.
583 583  )))
584 584  |(((
585 585  additionalParams
... ... @@ -592,12 +592,12 @@
592 592  |(((
593 593  Boolean
594 594  )))|(((
595 -True if successful, otherwise false.
612 +True in the case of success, otherwise false.
596 596  )))
597 597  
598 -== Request of learning results through the LMS ==
615 +== Request of learner results through the LMS ==
599 599  
600 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
617 +{{code language="xml" title="Request of learner results through the LMS"}}
601 601   @WebMethod(operationName = „getResultValues")
602 602  public HashMapWrapper getResultValues(
603 603   @WebParam(name = „version") final Integer version,
... ... @@ -626,12 +626,12 @@
626 626  |(((
627 627  secretToShare
628 628  )))|(((
629 -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.
630 630  )))
631 631  |(((
632 632  requestedValues
633 633  )))|(((
634 -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.
635 635  )))
636 636  |(((
637 637  additionalParams
... ... @@ -644,12 +644,12 @@
644 644  |(((
645 645  HashMap<String, String>
646 646  )))|(((
647 -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)
648 648  )))
649 649  
650 650  == Request of result variables through the LMS ==
651 651  
652 -{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
669 +{{code language="xml" title="Request of result variables through the LMS"}}
653 653   @WebMethod(operationName = „getResultVariables")
654 654  public HashMapWrapper getResultVariables(
655 655  @WebParam(name = „version") final Integer version,
... ... @@ -681,13 +681,12 @@
681 681  |(((
682 682  HashMap<String, String>
683 683  )))|(((
684 -Map of result variables, key is the variable name, value the corresponding
685 -value (HashMap is wrapped).
701 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
686 686  )))
687 687  
688 688  == Wrapper ==
689 689  
690 -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.
691 691  
692 692  === Wrapper for HashMap<String, String> ===
693 693  
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 -146964903
1 +3342390
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/146964903/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter