Zum Inhalt springen

Änderungen von Dokument 08 Schnittstelle ONYX Reporter

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 396.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 383.1
bearbeitet von sandra_riediger
am 15.12.2014
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -10 Schnittstelle ONYX Reporter
1 +Schnittstelle ONYX Reporter
Übergeordnete Seite
... ... @@ -1,1 +1,0 @@
1 -ONYX.Systeminformationen.WebHome
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.carina
1 +XWiki.sandra_riediger
Inhalt
... ... @@ -1,13 +1,39 @@
1 +{{sv-translation language="de"}}
1 1  {{layout}}
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
4 -
5 +====== Inhalt: ======
6 +
7 +
8 +
9 +{{toc maxLevel="5" style="square" outline="true" absoluteUrl="true"/}}
5 5  {{/layout-cell}}
6 6  
7 7  {{layout-cell}}
8 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Inhalt"}}
9 -{{toc start="2"/}}
10 -{{/panel}}
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 +
29 +
30 +
31 +)))
32 +|=(((
33 +JIRA
34 +)))|(((
35 +
36 +)))
11 11  {{/layout-cell}}
12 12  {{/layout-section}}
13 13  
... ... @@ -17,7 +17,6 @@
17 17  
18 18  Über die Schnittstelle zum ONYX WebReporter erfolgt jede Kommunikation zwischen dem LMS und dem Reporter. Dazu erfolgt eine Reihe von Aufrufen:
19 19  
20 -(% class="wrapped" %)
21 21  |(((
22 22  armSite
23 23  )))|(((
... ... @@ -48,7 +48,7 @@
48 48  
49 49  == Anmeldung des LMS ==
50 50  
51 -{{code language="xml" title="Anmeldung des LMS"}}
76 +{{code title="Anmeldung des LMS" language="xml"}}
52 52  @WebMethod(operationName = „armSite")
53 53  public String armSite(
54 54  @WebParam(name = „version") final Integer version,
... ... @@ -63,7 +63,6 @@
63 63  
64 64  === Parameter armSite ===
65 65  
66 -(% class="wrapped" %)
67 67  |(((
68 68  version
69 69  )))|(((
... ... @@ -106,7 +106,6 @@
106 106  
107 107  === ReturnValue armSite ===
108 108  
109 -(% class="wrapped" %)
110 110  |(((
111 111  String
112 112  )))|(((
... ... @@ -115,7 +115,7 @@
115 115  
116 116  == Initialisierung durch LMS ==
117 117  
118 -{{code language="xml" title="Initialisierung durch LMS"}}
141 +{{code title="Initialisierung durch LMS" language="xml"}}
119 119  @WebMethod(operationName = „initiateSite")
120 120  public String initiateSite(
121 121  @WebParam(name = „version") final Integer version,
... ... @@ -129,7 +129,6 @@
129 129  
130 130  === Parameter initiateSite ===
131 131  
132 -(% class="wrapped" %)
133 133  |(((
134 134  version
135 135  )))|(((
... ... @@ -165,7 +165,6 @@
165 165  
166 166  === ReturnValue initiateSite ===
167 167  
168 -(% class="wrapped" %)
169 169  |(((
170 170  String
171 171  )))|(((
... ... @@ -189,6 +189,7 @@
189 189  
190 190  == Abmeldung durch LMS ==
191 191  
213 +
192 192  
193 193  {{code}}
194 194  @WebMethod(operationName = „disarmSite")
... ... @@ -200,10 +200,10 @@
200 200  }
201 201  {{/code}}
202 202  
225 +
203 203  
204 204  === Parameter disarmSite ===
205 205  
206 -(% class="wrapped" %)
207 207  |(((
208 208  version
209 209  )))|(((
... ... @@ -229,7 +229,6 @@
229 229  
230 230  === ReturnValue disarmSite ===
231 231  
232 -(% class="wrapped" %)
233 233  |(((
234 234  Boolean
235 235  )))|(((
... ... @@ -238,7 +238,7 @@
238 238  
239 239  == Abfrage von Lernerresultaten durch LMS ==
240 240  
241 -{{code language="xml" title="Abfrage von Lernerresultaten durch LMS"}}
262 +{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
242 242   @WebMethod(operationName = „getResultValues")
243 243  public HashMapWrapper getResultValues(
244 244   @WebParam(name = „version") final Integer version,
... ... @@ -252,7 +252,6 @@
252 252  
253 253  === Parameter getResultValues ===
254 254  
255 -(% class="wrapped" %)
256 256  |(((
257 257  version
258 258  )))|(((
... ... @@ -283,7 +283,6 @@
283 283  
284 284  === ReturnValue getResultValues ===
285 285  
286 -(% class="wrapped" %)
287 287  |(((
288 288  HashMap<String, String>
289 289  )))|(((
... ... @@ -292,7 +292,7 @@
292 292  
293 293  == Abfrage von Ergebnisvariablen durch LMS ==
294 294  
295 -{{code language="xml" title="Abfrage von Ergebnisvariablen durch LMS"}}
314 +{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
296 296   @WebMethod(operationName = „getResultVariables")
297 297  public HashMapWrapper getResultVariables(
298 298  @WebParam(name = „version") final Integer version,
... ... @@ -303,7 +303,6 @@
303 303  
304 304  === Parameter getResultVariables ===
305 305  
306 -(% class="wrapped" %)
307 307  |(((
308 308  version
309 309  )))|(((
... ... @@ -322,7 +322,6 @@
322 322  
323 323  === ReturnValue getResultVariables ===
324 324  
325 -(% class="wrapped" %)
326 326  |(((
327 327  HashMap<String, String>
328 328  )))|(((
... ... @@ -331,21 +331,21 @@
331 331  
332 332  == Wrapper ==
333 333  
334 -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.
335 335  
336 336  === Wrapper für die HashMap<String, String> ===
337 337  
338 338  HashMapWrapper.java:
339 339  
340 -[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
357 +[[image:attach:HashMapWrapperjava.png]]
341 341  
342 -[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
359 +[[image:attach:HashMapWrapperjava2.png]]
343 343  
344 344  === Wrapper für die ArrayList<ResultsForStudent> ===
345 345  
346 346  ResultsForStudentsWrapper.java:
347 347  
348 -[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
365 +[[image:attach:ResultsForStudentsWrapperjava.png]]
349 349  {{/layout-cell}}
350 350  {{/layout-section}}
351 351  
... ... @@ -357,49 +357,78 @@
357 357  {{layout-cell}}
358 358  ====== relevante Links: ======
359 359  
360 -* [[ONYX Player Interface>>doc:ONYX.Systeminformationen.Schnittstelle ONYX Player.WebHome]]
377 +* [[doc:Schnittstelle ONYX WebPlayer]]
361 361  {{/layout-cell}}
362 362  {{/layout-section}}
363 363  {{/layout}}
381 +{{/sv-translation}}
364 364  
383 +{{sv-translation language="en"}}
365 365  {{layout}}
366 366  {{layout-section ac:type="two_equal"}}
367 367  {{layout-cell}}
368 368  ====== Content: ======
369 369  
370 -{{toc start="2"/}}
389 +
390 +
391 +{{toc style="square" maxLevel="5" outline="true" absoluteUrl="true"/}}
371 371  {{/layout-cell}}
372 372  
373 373  {{layout-cell}}
395 +|=(% colspan="1" %)(% colspan="1" %)
396 +(((
397 +Programmversion
398 +)))|(% colspan="1" %)(% colspan="1" %)
399 +(((
374 374  
401 +)))
402 +|=(((
403 +Status
404 +)))|(((
405 +(% class="status-macro aui-lozenge aui-lozenge-error" %)DONE
406 +)))
407 +|=(((
408 +Aufgaben
409 +)))|(((
410 +
411 +
412 +
413 +)))
414 +|=(((
415 +JIRA
416 +)))|(((
417 +
418 +)))
375 375  {{/layout-cell}}
376 376  {{/layout-section}}
377 377  
378 378  {{layout-section ac:type="single"}}
379 379  {{layout-cell}}
380 -== General information ==
424 +
381 381  
382 -The API to the ONYX WebReporter enables the communication between the LMS and the Reporter. Therefore, a couple of commands will be executed:
426 +== General ==
383 383  
428 +The API to the ONYX WebReporter enables the communication between the LMS and the reporter. Therefore, a couple of commands will be executed:
429 +
384 384  |(((
385 385  armSite
386 386  )))|(((
387 -Registration of sequence requests at the ONYX Reporter
433 +Registration of sequence requests at the ONYX reporter
388 388  )))
389 389  |(((
390 390  initiateSite
391 391  )))|(((
392 -Initiates the Reporter session (transmission of the CP).
438 +Initiates the reporter session (transmission of the CP).
393 393  )))
394 394  |(((
395 395  disarmSite
396 396  )))|(((
397 -Release of all Reporter resources for this session.
443 +Release of all reporter resources for this session.
398 398  )))
399 399  |(((
400 400  getResultValues
401 401  )))|(((
402 -Returns all (requested) results for the test. Condition: There is only one student in the list transmitted with initiateSite.
448 +Returns all or all requested results for the test. Condition: there is exactly one student in list transmitted in the initiateSite.
403 403  )))
404 404  |(% colspan="1" %)(% colspan="1" %)
405 405  (((
... ... @@ -406,12 +406,12 @@
406 406  getResultVariables
407 407  )))|(% colspan="1" %)(% colspan="1" %)
408 408  (((
409 -Returns all (requested) outcome variables for the test. No armSite, initiateSite, or disarmSite is required.
455 +Returns all or all requested outcome variables for the test. No armSite, initiateSite or disarmSite is necessary.
410 410  )))
411 411  
412 -== Login through the LMS ==
458 +== Connection to the LMS ==
413 413  
414 -{{code language="xml" title="Login through the LMS"}}
460 +{{code title="Anmeldung des LMS" language="xml"}}
415 415  @WebMethod(operationName = „armSite")
416 416  public String armSite(
417 417  @WebParam(name = „version") final Integer version,
... ... @@ -434,22 +434,22 @@
434 434  |(((
435 435  userId
436 436  )))|(((
437 -UserId of the requested Reporter user
483 +UserId of the requested reporter user
438 438  )))
439 439  |(((
440 440  optionalRole
441 441  )))|(((
442 -Optional. User role. 0 = student, 1 = tutor
488 +Optional. User role. 0=student, 1=tutor
443 443  )))
444 444  |(((
445 445  secretToShare
446 446  )))|(((
447 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
493 +Shared secret. Has to remain identical for every communication.
448 448  )))
449 449  |(((
450 450  optionalUserLastName
451 451  )))|(((
452 -Optional. Last name of the user.
498 +Optional. User lastname.
453 453  )))
454 454  |(% colspan="1" %)(% colspan="1" %)
455 455  (((
... ... @@ -456,7 +456,7 @@
456 456  optionalUserFirstName
457 457  )))|(% colspan="1" %)(% colspan="1" %)
458 458  (((
459 -Optional. First name of the user.
505 +Optional. User firstname.
460 460  )))
461 461  |(% colspan="1" %)(% colspan="1" %)
462 462  (((
... ... @@ -471,12 +471,12 @@
471 471  |(((
472 472  String
473 473  )))|(((
474 -Session ID which has to be used to mark any other Reporter call.
520 +Session ID that has to be used to mark any further reporter call.
475 475  )))
476 476  
477 477  == Initialisation through LMS ==
478 478  
479 -{{code language="xml" title="Initialisation through LMS"}}
525 +{{code title="Initialisierung durch LMS" language="xml"}}
480 480  @WebMethod(operationName = „initiateSite")
481 481  public String initiateSite(
482 482  @WebParam(name = „version") final Integer version,
... ... @@ -505,17 +505,17 @@
505 505  |(((
506 506  secretToShare
507 507  )))|(((
508 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
554 +Shared secret. Has to remain identical at every communication.
509 509  )))
510 510  |(((
511 511  students
512 512  )))|(((
513 -List of students and their results. See below.
559 +List of students with their results. See below.
514 514  )))
515 515  |(((
516 516  optionalContentPackage
517 517  )))|(((
518 -Optional. Content package (zipped) as byte array.
564 +Optional. Content Package (zipped) as byte array.
519 519  )))
520 520  |(((
521 521  additionalParams
... ... @@ -528,11 +528,11 @@
528 528  |(((
529 529  String
530 530  )))|(((
531 -Absolute URL of the Reporter site for the IFrame. The URL has to be amended by the LMS with the following URL parameters:
577 +Absolute URL of the reporter site for the frame. It has to be enriched by the LMS with the following URLparameters:
532 532  
533 -* sid: Session ID, as returned by armSite
579 +* sid: Session ID as returned by armSite
534 534  * (((
535 -uid: Student ID, as registrated in the initiateSite at the ONYX Reporter
581 +uid: Student ID as registrated in the initiateSite at the ONYX Reporter.
536 536  )))
537 537  )))
538 538  
... ... @@ -548,8 +548,9 @@
548 548  }
549 549  {{/code}}
550 550  
551 -== Logout through the LMS ==
597 +== Deconnection through the LMS ==
552 552  
599 +
553 553  
554 554  {{code}}
555 555  @WebMethod(operationName = „disarmSite")
... ... @@ -561,6 +561,7 @@
561 561  }
562 562  {{/code}}
563 563  
611 +
564 564  
565 565  === Parameter disarmSite ===
566 566  
... ... @@ -579,7 +579,7 @@
579 579  |(((
580 580  secretToShare
581 581  )))|(((
582 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
630 +Shared secret. Has to remain identical at every communication.
583 583  )))
584 584  |(((
585 585  additionalParams
... ... @@ -592,12 +592,12 @@
592 592  |(((
593 593  Boolean
594 594  )))|(((
595 -True in the case of success, otherwise false.
643 +True if successful, otherwise false.
596 596  )))
597 597  
598 -== Request of learner results through the LMS ==
646 +== Request of learning results through the LMS ==
599 599  
600 -{{code language="xml" title="Request of learner results through the LMS"}}
648 +{{code title="Abfrage von Lernerresultaten durch LMS" language="xml"}}
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 -A secret string that allows the server and client to encrypt their communication. Must remain the same for any further communication.
677 +Shared secret. Has to remain identical at every communication.
630 630  )))
631 631  |(((
632 632  requestedValues
633 633  )))|(((
634 -Can be empty, in which case all result variables are returned. If keys are included, only the keys will be returned.
682 +Can be empty, thus all result variables will be returned. If it contains keys, only those 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 is the respective variable's value (HashMap is wrapped)
695 +Map of result variables, key is the variable name, value the corresponding value (HashMap is wrapped)
648 648  )))
649 649  
650 650  == Request of result variables through the LMS ==
651 651  
652 -{{code language="xml" title="Request of result variables through the LMS"}}
700 +{{code title="Abfrage von Ergebnisvariablen durch LMS" language="xml"}}
653 653   @WebMethod(operationName = „getResultVariables")
654 654  public HashMapWrapper getResultVariables(
655 655  @WebParam(name = „version") final Integer version,
... ... @@ -681,26 +681,28 @@
681 681  |(((
682 682  HashMap<String, String>
683 683  )))|(((
684 -Map of result variables, key is the variable name, value is the respective variable's value (HashMap is wrapped)
732 +Map of result variables, key is the variable name, value the corresponding
733 +value (HashMap is wrapped).
685 685  )))
686 686  
687 687  == Wrapper ==
688 688  
689 -Since the transmission of maps and lists via JAX-WS can cause problems, they have to be wrapped.
738 +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.
690 690  
691 691  === Wrapper for HashMap<String, String> ===
692 692  
693 693  HashMapWrapper.java:
694 694  
695 -[[image:attach:HashMapWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
744 +[[image:attach:HashMapWrapperjava.png]]
696 696  
697 -[[image:attach:HashMapWrapperjava2.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
746 +[[image:attach:HashMapWrapperjava2.png]]
698 698  
699 699  === Wrapper for the ArrayList<ResultsForStudent> ===
700 700  
701 701  ResultsForStudentsWrapper.java:
702 702  
703 -[[image:attach:ResultsForStudentsWrapperjava.png||data-xwiki-image-style="img-screen" data-xwiki-image-style-border="true" width="500"]]
752 +[[image:attach:ResultsForStudentsWrapperjava.png]]
704 704  {{/layout-cell}}
705 705  {{/layout-section}}
706 706  {{/layout}}
756 +{{/sv-translation}}
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 +3342922
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/3342922/Schnittstelle ONYX Reporter