Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 381.1
bearbeitet von sandra_riediger
am 17.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 395.1
bearbeitet von Carina Enke
am 19.12.2023
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Systeminformationen.WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.sandra_riediger
1 +XWiki.carina
Inhalt
... ... @@ -1,39 +1,22 @@
1 -{{sv-translation language="de"}}
1 +
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}}
7 7  
14 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
8 8  
9 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
10 -{{/layout-cell}}
11 11  
12 -{{layout-cell}}
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 -
17 +{{toc/}}
18 +{{/panel}}
29 29  
30 -
31 -)))
32 -|=(((
33 -JIRA
34 -)))|(((
35 -
36 -)))
37 37  {{/layout-cell}}
38 38  {{/layout-section}}
39 39  
... ... @@ -43,6 +43,7 @@
43 43  
44 44  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
45 45  
29 +(% class="wrapped" %)
46 46  |(((
47 47  armSite
48 48  )))|(((
... ... @@ -73,7 +73,7 @@
73 73  
74 74  == Anmeldung des LMS ==
75 75  
76 -{{code title="Anmeldung des LMS" language="xml"}}
60 +{{code language="xml" title="Anmeldung des LMS"}}
77 77  @WebMethod(operationName = „armSite")
78 78  public String armSite(
79 79  @WebParam(name = „version") final Integer version,
... ... @@ -88,6 +88,7 @@
88 88  
89 89  === Parameter armSite ===
90 90  
75 +(% class="wrapped" %)
91 91  |(((
92 92  version
93 93  )))|(((
... ... @@ -130,6 +130,7 @@
130 130  
131 131  === ReturnValue armSite ===
132 132  
118 +(% class="wrapped" %)
133 133  |(((
134 134  String
135 135  )))|(((
... ... @@ -138,7 +138,7 @@
138 138  
139 139  == Initialisierung durch LMS ==
140 140  
141 -{{code title="Initialisierung durch LMS" language="xml"}}
127 +{{code language="xml" title="Initialisierung durch LMS"}}
142 142  @WebMethod(operationName = „initiateSite")
143 143  public String initiateSite(
144 144  @WebParam(name = „version") final Integer version,
... ... @@ -152,6 +152,7 @@
152 152  
153 153  === Parameter initiateSite ===
154 154  
141 +(% class="wrapped" %)
155 155  |(((
156 156  version
157 157  )))|(((
... ... @@ -187,6 +187,7 @@
187 187  
188 188  === ReturnValue initiateSite ===
189 189  
177 +(% class="wrapped" %)
190 190  |(((
191 191  String
192 192  )))|(((
... ... @@ -210,7 +210,7 @@
210 210  
211 211  == Abmeldung durch LMS ==
212 212  
213 -
201 +\\
214 214  
215 215  {{code}}
216 216  @WebMethod(operationName = „disarmSite")
... ... @@ -222,10 +222,11 @@
222 222  }
223 223  {{/code}}
224 224  
225 -
213 +\\
226 226  
227 227  === Parameter disarmSite ===
228 228  
217 +(% class="wrapped" %)
229 229  |(((
230 230  version
231 231  )))|(((
... ... @@ -251,6 +251,7 @@
251 251  
252 252  === ReturnValue disarmSite ===
253 253  
243 +(% class="wrapped" %)
254 254  |(((
255 255  Boolean
256 256  )))|(((
... ... @@ -259,7 +259,7 @@
259 259  
260 260  == Abfrage von Lernerresultaten durch LMS ==
261 261  
262 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
252 +{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
263 263   @WebMethod(operationName = „getResultValues")
264 264  public HashMapWrapper getResultValues(
265 265   @WebParam(name = „version") final Integer version,
... ... @@ -273,6 +273,7 @@
273 273  
274 274  === Parameter getResultValues ===
275 275  
266 +(% class="wrapped" %)
276 276  |(((
277 277  version
278 278  )))|(((
... ... @@ -303,6 +303,7 @@
303 303  
304 304  === ReturnValue getResultValues ===
305 305  
297 +(% class="wrapped" %)
306 306  |(((
307 307  HashMap<String, String>
308 308  )))|(((
... ... @@ -311,7 +311,7 @@
311 311  
312 312  == Abfrage von Ergebnisvariablen durch LMS ==
313 313  
314 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
306 +{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
315 315   @WebMethod(operationName = „getResultVariables")
316 316  public HashMapWrapper getResultVariables(
317 317  @WebParam(name = „version") final Integer version,
... ... @@ -322,6 +322,7 @@
322 322  
323 323  === Parameter getResultVariables ===
324 324  
317 +(% class="wrapped" %)
325 325  |(((
326 326  version
327 327  )))|(((
... ... @@ -340,6 +340,7 @@
340 340  
341 341  === ReturnValue getResultVariables ===
342 342  
336 +(% class="wrapped" %)
343 343  |(((
344 344  HashMap<String, String>
345 345  )))|(((
... ... @@ -348,7 +348,7 @@
348 348  
349 349  == Wrapper ==
350 350  
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.
345 +Da die Übertragung von Maps und Listen über JAX-WS Probleme machen kann, müssen diese gewrappt werden.
352 352  
353 353  === Wrapper für die HashMap<String, String> ===
354 354  
... ... @@ -368,19 +368,19 @@
368 368  
369 369  {{layout-section ac:type="two_right_sidebar"}}
370 370  {{layout-cell}}
371 -
365 +\\
372 372  {{/layout-cell}}
373 373  
374 374  {{layout-cell}}
375 375  ====== relevante Links: ======
376 376  
377 -* [[doc:Schnittstelle ONYX WebPlayer]]
371 +* [[doc:ONYX Player Interface]]
378 378  {{/layout-cell}}
379 379  {{/layout-section}}
380 380  {{/layout}}
381 -{{/sv-translation}}
382 382  
383 -{{sv-translation language="en"}}
376 +
377 +
384 384  {{layout}}
385 385  {{layout-section ac:type="two_equal"}}
386 386  {{layout-cell}}
... ... @@ -388,7 +388,7 @@
388 388  
389 389  
390 390  
391 -{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
385 +{{toc maxLevel="5" outline="true" absoluteUrl="true" style="square"/}}
392 392  {{/layout-cell}}
393 393  
394 394  {{layout-cell}}
... ... @@ -398,31 +398,29 @@
398 398  
399 399  {{layout-section ac:type="single"}}
400 400  {{layout-cell}}
401 -
395 +== General information ==
402 402  
403 -== General ==
397 +The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
404 404  
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 -
407 407  |(((
408 408  armSite
409 409  )))|(((
410 -Registration of sequence requests at the ONYX reporter
402 +Registration of sequence requests at the ONYX Reporter
411 411  )))
412 412  |(((
413 413  initiateSite
414 414  )))|(((
415 -Initiates the reporter session (transmission of the CP).
407 +Initiates the Reporter session (transmission of the CP).
416 416  )))
417 417  |(((
418 418  disarmSite
419 419  )))|(((
420 -Release of all reporter resources for this session.
412 +Release of all Reporter resources for this session.
421 421  )))
422 422  |(((
423 423  getResultValues
424 424  )))|(((
425 -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.
426 426  )))
427 427  |(% colspan="1" %)(% colspan="1" %)
428 428  (((
... ... @@ -429,12 +429,12 @@
429 429  getResultVariables
430 430  )))|(% colspan="1" %)(% colspan="1" %)
431 431  (((
432 -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.
433 433  )))
434 434  
435 -== Connection to the LMS ==
427 +== Login through the LMS ==
436 436  
437 -{{code title="Anmeldung des LMS" language="xml"}}
429 +{{code language="xml" title="Login through the LMS"}}
438 438  @WebMethod(operationName = „armSite")
439 439  public String armSite(
440 440  @WebParam(name = „version") final Integer version,
... ... @@ -457,22 +457,22 @@
457 457  |(((
458 458  userId
459 459  )))|(((
460 -UserId of the requested reporter user
452 +UserId of the requested Reporter user
461 461  )))
462 462  |(((
463 463  optionalRole
464 464  )))|(((
465 -Optional. User role. 0=student, 1=tutor
457 +Optional. User role. 0 = student, 1 = tutor
466 466  )))
467 467  |(((
468 468  secretToShare
469 469  )))|(((
470 -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.
471 471  )))
472 472  |(((
473 473  optionalUserLastName
474 474  )))|(((
475 -Optional. User lastname.
467 +Optional. Last name of the user.
476 476  )))
477 477  |(% colspan="1" %)(% colspan="1" %)
478 478  (((
... ... @@ -479,7 +479,7 @@
479 479  optionalUserFirstName
480 480  )))|(% colspan="1" %)(% colspan="1" %)
481 481  (((
482 -Optional. User firstname.
474 +Optional. First name of the user.
483 483  )))
484 484  |(% colspan="1" %)(% colspan="1" %)
485 485  (((
... ... @@ -494,12 +494,12 @@
494 494  |(((
495 495  String
496 496  )))|(((
497 -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.
498 498  )))
499 499  
500 500  == Initialisation through LMS ==
501 501  
502 -{{code title="Initialisierung durch LMS" language="xml"}}
494 +{{code language="xml" title="Initialisation through LMS"}}
503 503  @WebMethod(operationName = „initiateSite")
504 504  public String initiateSite(
505 505  @WebParam(name = „version") final Integer version,
... ... @@ -528,17 +528,17 @@
528 528  |(((
529 529  secretToShare
530 530  )))|(((
531 -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.
532 532  )))
533 533  |(((
534 534  students
535 535  )))|(((
536 -List of students with their results. See below.
528 +List of students and their results. See below.
537 537  )))
538 538  |(((
539 539  optionalContentPackage
540 540  )))|(((
541 -Optional. Content Package (zipped) as byte array.
533 +Optional. Content package (zipped) as byte array.
542 542  )))
543 543  |(((
544 544  additionalParams
... ... @@ -551,11 +551,11 @@
551 551  |(((
552 552  String
553 553  )))|(((
554 -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:
555 555  
556 -* sid: Session ID as returned by armSite
548 +* sid: Session ID, as returned by armSite
557 557  * (((
558 -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
559 559  )))
560 560  )))
561 561  
... ... @@ -571,7 +571,7 @@
571 571  }
572 572  {{/code}}
573 573  
574 -== Deconnection through the LMS ==
566 +== Logout through the LMS ==
575 575  
576 576  
577 577  
... ... @@ -604,7 +604,7 @@
604 604  |(((
605 605  secretToShare
606 606  )))|(((
607 -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.
608 608  )))
609 609  |(((
610 610  additionalParams
... ... @@ -617,12 +617,12 @@
617 617  |(((
618 618  Boolean
619 619  )))|(((
620 -True if successful, otherwise false.
612 +True in the case of success, otherwise false.
621 621  )))
622 622  
623 -== Request of learning results through the LMS ==
615 +== Request of learner results through the LMS ==
624 624  
625 -{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
617 +{{code language="xml" title="Request of learner results through the LMS"}}
626 626   @WebMethod(operationName = „getResultValues")
627 627  public HashMapWrapper getResultValues(
628 628   @WebParam(name = „version") final Integer version,
... ... @@ -651,12 +651,12 @@
651 651  |(((
652 652  secretToShare
653 653  )))|(((
654 -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.
655 655  )))
656 656  |(((
657 657  requestedValues
658 658  )))|(((
659 -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.
660 660  )))
661 661  |(((
662 662  additionalParams
... ... @@ -669,12 +669,12 @@
669 669  |(((
670 670  HashMap<String, String>
671 671  )))|(((
672 -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)
673 673  )))
674 674  
675 675  == Request of result variables through the LMS ==
676 676  
677 -{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
669 +{{code language="xml" title="Request of result variables through the LMS"}}
678 678   @WebMethod(operationName = „getResultVariables")
679 679  public HashMapWrapper getResultVariables(
680 680  @WebParam(name = „version") final Integer version,
... ... @@ -706,13 +706,12 @@
706 706  |(((
707 707  HashMap<String, String>
708 708  )))|(((
709 -Map of result variables, key is the variable name, value the corresponding
710 -value (HashMap is wrapped).
701 +Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
711 711  )))
712 712  
713 713  == Wrapper ==
714 714  
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.
706 +Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
716 716  
717 717  === Wrapper for HashMap<String, String> ===
718 718  
... ... @@ -730,4 +730,4 @@
730 730  {{/layout-cell}}
731 731  {{/layout-section}}
732 732  {{/layout}}
733 -{{/sv-translation}}
724 +
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 -3342937
1 +3342390
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342937/Schnittstelle ONYX Reporter
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/3342390/Schnittstelle ONYX Reporter